nux-0.9.48

nux::MenuPage Class Reference

#include <Nux/MenuPage.h>

Inheritance diagram for nux::MenuPage:
nux::View nux::InputArea nux::Area nux::InitiallyUnownedObject nux::Focusable nux::Object nux::Trackable

Public Member Functions

 MenuPage (const TCHAR *title=TEXT(""), NUX_FILE_LINE_PROTO)
 ~MenuPage ()
virtual long ProcessEvent (IEvent &ievent, long TraverseInfo, long ProcessEventInfo)
virtual void Draw (GraphicsEngine &GfxContext, bool force_draw)
virtual void DrawContent (GraphicsEngine &GfxContext, bool force_draw)
virtual void PostDraw (GraphicsEngine &GfxContext, bool force_draw)
const TCHARGetName () const
ActionItemAddAction (const TCHAR *label=0, int UserValue=0)
void AddSeparator ()
MenuPageAddMenu (const TCHAR *label)
ActionItemAddSubMenu (const TCHAR *label, MenuPage *menu)
void RemoveItem (ActionItem *item)
void RemoveAllItem ()
bool CanClose () const
void EmitMouseMove (int x, int y, int dx, int dy, unsigned long button_flags, unsigned long key_flags)
void EmitMouseUp (int x, int y, unsigned long button_flags, unsigned long key_flags)
void EmitMouseDown (int x, int y, unsigned long button_flags, unsigned long key_flags)
void EmitMouseDrag (int x, int y, int dx, int dy, unsigned long button_flags, unsigned long key_flags)
void RecvMouseLeave (int x, int y, unsigned long button_flags, unsigned long key_flags)
void StartMenu (int MenuXPosition, int MenuYPosition, int x=0, int y=0, bool OverrideCurrentMenuChain=true)
 Start the MenuPage iteration and show it.
void StopMenu (int x=0, int y=0)
 Stop the MenuPage iteration and hide it.
void SetFontName (char *font_name)
void StopActionSubMenu ()
void ExecuteActionItem (MenuItem *menuItem)
void NotifyActionTriggeredToParent (MenuPage *, MenuItem *menuItem)
void NotifyTerminateMenuCascade ()
void NotifyMouseDownOutsideMenuCascade (int x, int y)
void SetParentMenu (MenuPage *)
MenuPageGetParentMenu ()
void setShowItemIcon (bool b)
bool ShowItemIcon ()
bool TestMouseDown ()
bool TestMouseUp (int x, int y, unsigned long button_flags, unsigned long key_flags, bool &hit_inside_a_menu)
void Terminate (int x, int y, unsigned long button_flags, unsigned long key_flags)
void SetActive (bool b)
bool IsActive () const
int GetNumItem () const
ActionItemGetActionItem (int i) const
int GetActionItemIndex (ActionItem *action) const
virtual long ComputeChildLayout ()
virtual void SetGeometry (const Geometry &geo)
 Set Geometry.

Data Fields

sigc::signal< void, int > sigItemSelected
sigc::signal< void, MenuPage
*, ActionItem * > 
sigActionTriggered
 Send an action Signal.
sigc::signal< void > sigTerminateMenuCascade
 Terminate the menu and its sub menu cascade.
sigc::signal< void, MenuPage
*, int, int > 
sigMouseDownOutsideMenuCascade
 Notify that a mouse down event happened outside the menu cascade.

Friends

class MenuBar

Constructor & Destructor Documentation

nux::MenuPage::MenuPage ( const TCHAR title = TEXT(""),
NUX_FILE_LINE_PROTO   
)
nux::MenuPage::~MenuPage ( )

Member Function Documentation

ActionItem* nux::MenuPage::AddAction ( const TCHAR label = 0,
int  UserValue = 0 
)
MenuPage* nux::MenuPage::AddMenu ( const TCHAR label)
void nux::MenuPage::AddSeparator ( )
ActionItem* nux::MenuPage::AddSubMenu ( const TCHAR label,
MenuPage menu 
)
bool nux::MenuPage::CanClose ( ) const
virtual long nux::MenuPage::ComputeChildLayout ( ) [virtual]

Reimplemented from nux::View.

virtual void nux::MenuPage::Draw ( GraphicsEngine GfxContext,
bool  force_draw 
) [virtual]

Implements nux::View.

virtual void nux::MenuPage::DrawContent ( GraphicsEngine GfxContext,
bool  force_draw 
) [virtual]

Reimplemented from nux::View.

void nux::MenuPage::EmitMouseDown ( int  x,
int  y,
unsigned long  button_flags,
unsigned long  key_flags 
)
void nux::MenuPage::EmitMouseDrag ( int  x,
int  y,
int  dx,
int  dy,
unsigned long  button_flags,
unsigned long  key_flags 
)
void nux::MenuPage::EmitMouseMove ( int  x,
int  y,
int  dx,
int  dy,
unsigned long  button_flags,
unsigned long  key_flags 
)
void nux::MenuPage::EmitMouseUp ( int  x,
int  y,
unsigned long  button_flags,
unsigned long  key_flags 
)
void nux::MenuPage::ExecuteActionItem ( MenuItem menuItem)
ActionItem* nux::MenuPage::GetActionItem ( int  i) const
int nux::MenuPage::GetActionItemIndex ( ActionItem action) const

Get the index of and item in the menu.

Returns:
the index of the ActionItem in the menu. -1 if the Action Item is not found.
const TCHAR* nux::MenuPage::GetName ( ) const
int nux::MenuPage::GetNumItem ( ) const [inline]

Return the number of items in the menu.

MenuPage* nux::MenuPage::GetParentMenu ( )
bool nux::MenuPage::IsActive ( ) const [inline]
void nux::MenuPage::NotifyActionTriggeredToParent ( MenuPage ,
MenuItem menuItem 
)
void nux::MenuPage::NotifyMouseDownOutsideMenuCascade ( int  x,
int  y 
)
void nux::MenuPage::NotifyTerminateMenuCascade ( )
virtual void nux::MenuPage::PostDraw ( GraphicsEngine GfxContext,
bool  force_draw 
) [virtual]

Reimplemented from nux::View.

virtual long nux::MenuPage::ProcessEvent ( IEvent ievent,
long  TraverseInfo,
long  ProcessEventInfo 
) [virtual]

Implements nux::View.

void nux::MenuPage::RecvMouseLeave ( int  x,
int  y,
unsigned long  button_flags,
unsigned long  key_flags 
)
void nux::MenuPage::RemoveAllItem ( )
void nux::MenuPage::RemoveItem ( ActionItem item)
void nux::MenuPage::SetActive ( bool  b) [inline]
void nux::MenuPage::SetFontName ( char *  font_name)
virtual void nux::MenuPage::SetGeometry ( const Geometry geo) [virtual]

Set Geometry.

Reimplemented from nux::View.

void nux::MenuPage::SetParentMenu ( MenuPage )
void nux::MenuPage::setShowItemIcon ( bool  b) [inline]
bool nux::MenuPage::ShowItemIcon ( ) [inline]
void nux::MenuPage::StartMenu ( int  MenuXPosition,
int  MenuYPosition,
int  x = 0,
int  y = 0,
bool  OverrideCurrentMenuChain = true 
)

Start the MenuPage iteration and show it.

void nux::MenuPage::StopActionSubMenu ( )
void nux::MenuPage::StopMenu ( int  x = 0,
int  y = 0 
)

Stop the MenuPage iteration and hide it.

void nux::MenuPage::Terminate ( int  x,
int  y,
unsigned long  button_flags,
unsigned long  key_flags 
)
bool nux::MenuPage::TestMouseDown ( )
bool nux::MenuPage::TestMouseUp ( int  x,
int  y,
unsigned long  button_flags,
unsigned long  key_flags,
bool &  hit_inside_a_menu 
)

Friends And Related Function Documentation

friend class MenuBar [friend]

Field Documentation

Send an action Signal.

sigc::signal<void, int> nux::MenuPage::sigItemSelected

Notify that a mouse down event happened outside the menu cascade.

Terminate the menu and its sub menu cascade.


The documentation for this class was generated from the following file: