Maeomm Reference Documentation: hildonmm
Main Page   Namespaces   Book  

Hildon::AppMenu Class Reference
[Widgets]

Inheritance diagram for Hildon::AppMenu:

Inheritance graph
[legend]

List of all members.


Detailed Description

The application menu in the Hildon framework.

This menu opens from the top of the screen and contains a number of entries (Gtk::Button) organized in one or two columns, depending on the size of the screen (the number of columns changes automatically if the screen is resized). Entries are added left to right and top to bottom.

Besides that, the Hildon::AppMenu can contain a group of filter buttons (Gtk::ToggleButton or Gtk::RadioButton).

To use a Hildon::AppMenu, add it to a Hildon::Window using Hildon::Window::set_app_menu(). The menu will appear when the user presses the window title bar. Alternatively, you can show it by hand using Hildon::AppMenu::popup().

The menu will be automatically hidden when one of its buttons is clicked.

Public Member Functions

void add_filter (Gtk::Button& filter)
 Adds the filter to menu.
void append (Gtk::Button& item)
 Adds item to the end of the menu's item list.
 AppMenu ()
Glib::ListHandle< const
Gtk::Button* > 
get_filters () const
 Returns: a newly-allocated list containing the filters in menu.
Glib::ListHandle<Gtk::Button*> get_filters ()
 Returns: a newly-allocated list containing the filters in menu.
Glib::ListHandle< const
Gtk::Button* > 
get_items () const
 Returns: a newly-allocated list containing the items in menu.
Glib::ListHandle<Gtk::Button*> get_items ()
 Returns: a newly-allocated list containing the items in menu.
const HildonAppMenu* gobj () const
 Provides access to the underlying C GtkObject.
HildonAppMenu* gobj ()
 Provides access to the underlying C GtkObject.
void insert (Gtk::Button& item, int position)
 Adds item to menu at the position indicated by position.
void popup (Gtk::Window& parent_window)
 Displays a menu on top of a window and makes it available for selection.
void prepend (Gtk::Button& item)
 Adds item to the beginning of the menu's item list.
void reorder_child (Gtk::Button& item, int position)
 Moves a Gtk::Button to a new position within Hildon::AppMenu.
virtual ~AppMenu ()

Related Functions

(Note that these are not member functions.)

Hildon::AppMenuwrap (HildonAppMenu* object, bool take_copy=false)
 A Glib::wrap() method for this object.


Constructor & Destructor Documentation

virtual Hildon::AppMenu::~AppMenu (  )  [virtual]

Hildon::AppMenu::AppMenu (  ) 


Member Function Documentation

void Hildon::AppMenu::add_filter ( Gtk::Button filter  ) 

Adds the filter to menu.

Parameters:
filter A Gtk::Button to add to the Hildon::AppMenu.

void Hildon::AppMenu::append ( Gtk::Button item  ) 

Adds item to the end of the menu's item list.

Parameters:
item A Gtk::Button to add to the Hildon::AppMenu.

Glib::ListHandle<const Gtk::Button*> Hildon::AppMenu::get_filters (  )  const

Returns: a newly-allocated list containing the filters in menu.

Returns:
A newly-allocated list containing the filters in menu
.

Glib::ListHandle<Gtk::Button*> Hildon::AppMenu::get_filters (  ) 

Returns: a newly-allocated list containing the filters in menu.

Returns:
A newly-allocated list containing the filters in menu
.

Glib::ListHandle<const Gtk::Button*> Hildon::AppMenu::get_items (  )  const

Returns: a newly-allocated list containing the items in menu.

Returns:
A newly-allocated list containing the items in menu
.

Glib::ListHandle<Gtk::Button*> Hildon::AppMenu::get_items (  ) 

Returns: a newly-allocated list containing the items in menu.

Returns:
A newly-allocated list containing the items in menu
.

const HildonAppMenu* Hildon::AppMenu::gobj (  )  const [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Window.

HildonAppMenu* Hildon::AppMenu::gobj (  )  [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Window.

void Hildon::AppMenu::insert ( Gtk::Button item,
int  position 
)

Adds item to menu at the position indicated by position.

Parameters:
item A Gtk::Button to add to the Hildon::AppMenu.
position The position in the item list where item is added (from 0 to n-1).

void Hildon::AppMenu::popup ( Gtk::Window parent_window  ) 

Displays a menu on top of a window and makes it available for selection.

Parameters:
parent_window A Gtk::Window.

void Hildon::AppMenu::prepend ( Gtk::Button item  ) 

Adds item to the beginning of the menu's item list.

Parameters:
item A Gtk::Button to add to the Hildon::AppMenu.

void Hildon::AppMenu::reorder_child ( Gtk::Button item,
int  position 
)

Moves a Gtk::Button to a new position within Hildon::AppMenu.

Parameters:
item A Gtk::Button to move.
position The new position to place item (from 0 to n-1).


Friends And Related Function Documentation

Hildon::AppMenu* wrap ( HildonAppMenu *  object,
bool  take_copy = false 
) [related]

A Glib::wrap() method for this object.

Parameters:
object The C instance.
take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
Returns:
A C++ instance that wraps this C instance.


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

Generated for hildonmm by Doxygen 1.5.6 © 1997-2001