SkyGI::MenuItem Class Reference

Inheritance diagram for SkyGI::MenuItem:[legend]Collaboration diagram for SkyGI::MenuItem:[legend]List of all members.


Public Member Functions
	MenuItem (const String &pText, bool bEnabled, int iID, Image *pImage=NULL)
	~MenuItem ()
virtual Point	GetPreferredSize ()
virtual void	SetShortcut (const Shortcut &pShortcut)
virtual void	Paint (Painter *m_Painter, const Rect &rFrame, const Rect &rDirty)
virtual void	MouseDown (const InputEvent &nInputEvent)
virtual void	MouseUp (const InputEvent &nInputEvent)
virtual void	MouseMove (const InputEvent &nInputEvent)
virtual void	MouseEnter (const InputEvent &nInputEvent)
virtual void	MouseLeave (const InputEvent &nInputEvent)
virtual void	KeyDown (const InputEvent &nInputEvent)
virtual void	KeyUp (const InputEvent &nInputEvent)
virtual void	Select ()
virtual void	Unselect ()
void	SetMenu (Menu *pMenu)
void	SetMenuWindow (MenuWindow *pWindow)
void	SetView (Window *pWindow)
virtual Rect	GetRect ()
virtual void	SetRect (const Rect &rFrame)
virtual void	SetHeight (int iHeight)
virtual void	Add (Menu *pMenu)
void	Remove (Menu *pMenu)
virtual bool	HasChild ()
virtual Menu *	Get ()
virtual void	Enable (bool bEnable=true)
bool	IsEnabled ()
virtual void	SetCookie (void *pCookie)
virtual void *	GetCookie ()
virtual void	OnClicked (const InputEvent &nInputEvent)
virtual bool	IsChecked ()
void	Check (bool bChecked)
void	SetBackgroundBrush (Brush *pBrush, bool bSelected)
String	GetText ()
void	EnableRightClick (bool bEnable)
MenuWindow *	GetMenuWindow ()
Window *	GetView ()
virtual void	Attach ()
virtual void	Detach ()
void	SetFreeCookie (bool bFree)
void	SetFont (Font *pFont)
Public Attributes
signal0	Clicked
signal1< const InputEvent & >	ClickedEvent
signal2< const InputEvent &, MenuItem * >	ClickedSource
signal1< MenuItem * >	PrepareMenuItem
Protected Attributes
Font *	m_pFont
int	m_iItemHeight
String	m_pText
Menu *	m_pMenu
Image *	m_pImage
bool	m_bSelected
Rect	m_rFrame
int	m_iID
Menu *	m_pChildMenu
MenuWindow *	m_pMenuWindow
bool	m_bEnabled
void *	m_pCookie
String	m_szShortcutString
bool	m_bChecked
Brush *	m_pBrush
Brush *	m_pBrushSelected
bool	m_bRightClickEnabled
Window *	m_pWindow
bool	m_bFreeCookie

Detailed Description

MenuItem

Examples:: listview.cpp, and tabview.cpp.

Constructor & Destructor Documentation

MenuItem::MenuItem	(	const String &	pText,
		bool	bEnabled,
		int	iID,
		Image *	pImage = `NULL`
	)

MenuItem::~MenuItem ( )

Member Function Documentation

Point MenuItem::GetPreferredSize ( ) [virtual]

void MenuItem::SetShortcut ( const Shortcut & pShortcut ) [virtual]

void MenuItem::Paint	(	Painter *	m_Painter,
		const Rect &	rFrame,
		const Rect &	rDirty
	)			`[virtual]`

Reimplemented in SkyGI::MenuSeparator.

void MenuItem::MouseDown ( const InputEvent & nInputEvent ) [virtual]

void MenuItem::MouseUp ( const InputEvent & nInputEvent ) [virtual]

void MenuItem::MouseMove ( const InputEvent & nInputEvent ) [virtual]

void MenuItem::MouseEnter ( const InputEvent & nInputEvent ) [virtual]

void MenuItem::MouseLeave ( const InputEvent & nInputEvent ) [virtual]

void MenuItem::KeyDown ( const InputEvent & nInputEvent ) [virtual]

void MenuItem::KeyUp ( const InputEvent & nInputEvent ) [virtual]

void MenuItem::Select ( ) [virtual]

void MenuItem::Unselect ( ) [virtual]

void MenuItem::SetMenu ( Menu * pMenu )

void MenuItem::SetMenuWindow ( MenuWindow * pWindow )

void MenuItem::SetView ( Window * pWindow )

Rect MenuItem::GetRect ( ) [virtual]

void MenuItem::SetRect ( const Rect & rFrame ) [virtual]

void MenuItem::SetHeight ( int iHeight ) [virtual]

void MenuItem::Add ( Menu * pMenu ) [virtual]

Reimplemented in SkyGI::MenuSeparator.

Examples:: listview.cpp.

void MenuItem::Remove ( Menu * pMenu )

virtual bool SkyGI::MenuItem::HasChild ( ) [inline, virtual]

Reimplemented in SkyGI::MenuSeparator.

virtual Menu* SkyGI::MenuItem::Get ( ) [inline, virtual]

void MenuItem::Enable ( bool bEnable = true ) [virtual]

Reimplemented in SkyGI::MenuSeparator.

bool SkyGI::MenuItem::IsEnabled ( ) [inline]

virtual void SkyGI::MenuItem::SetCookie ( void * pCookie ) [inline, virtual]

virtual void* SkyGI::MenuItem::GetCookie ( ) [inline, virtual]

void MenuItem::OnClicked ( const InputEvent & nInputEvent ) [virtual]

bool MenuItem::IsChecked ( ) [virtual]

void MenuItem::Check ( bool bChecked )

void MenuItem::SetBackgroundBrush	(	Brush *	pBrush,
		bool	bSelected
	)

String MenuItem::GetText ( )

void MenuItem::EnableRightClick ( bool bEnable )

MenuWindow * MenuItem::GetMenuWindow ( )

Window * MenuItem::GetView ( )

void MenuItem::Attach ( ) [virtual]

Called when a menuitem gets attached to a window

Description:: Overload this member function to get called when a menuitem gets attached to a window (e.g. a PopupMenu). You can use this function to perform initialization which require the menuitem attached to a window already. (e.g. to create child windows)

void MenuItem::Detach ( ) [virtual]

Called when a menuitem gets detached from a window

Description:

void MenuItem::SetFreeCookie ( bool bFree )

void MenuItem::SetFont ( Font * pFont )

Member Data Documentation

signal0 SkyGI::MenuItem::Clicked

Emitted when the menuitem gets clicked

Description:: OnClicked will emit this signal if not overloaded and the menuitem was pressed with either the left mouse button or using the VKEY_ENTER key

See also:: ClickedEvent

Examples:: tabview.cpp.

signal1<const InputEvent&> SkyGI::MenuItem::ClickedEvent

Emitted when the menuitem gets clicked

Description:: OnClicked will emit this signal if not overloaded

Parameters:

nInputEvent

InputEvent with details about the click event (click with mouse, keyboard, ...)

See also:: Clicked

signal2<const InputEvent&, MenuItem*> SkyGI::MenuItem::ClickedSource

Emitted when the menuitem gets clicked

Description:: OnClicked will emit this signal if not overloaded

Parameters:

	nInputEvent	InputEvent with details about the click event (click with mouse, keyboard, ...)
	MenuItem	Pointer to this menu item

See also:: Clicked

signal1<MenuItem*> SkyGI::MenuItem::PrepareMenuItem

Emitted right before menu item gets displayed

Description:: Can be used to disable/enable MenuItem depending on current state. (For instance, display 'Paste' if no clipboard data is available)

Parameters:

MenuItem

Pointer to this menu item