MenuItem

---

#Header

#include <gui/menuitem.h>

---

#Functions

MenuItem*	menuitem_create (void)
MenuItem*	menuitem_separator (void)
void	menuitem_OnClick (...)
void	menuitem_enabled (...)
void	menuitem_visible (...)
void	menuitem_state (...)
void	menuitem_text (...)
void	menuitem_image (...)
void	menuitem_key (...)
void	menuitem_submenu (...)
const char_t*	menuitem_get_text (...)
const Image*	menuitem_get_text (...)
bool_t	menuitem_get_separator (...)
bool_t	menuitem_get_enabled (...)
bool_t	menuitem_get_visible (...)
gui_state_t	menuitem_get_state (...)
Menu*	menuitem_get_submenu (...)

---

Represents an option within a Menu. They will always have an associated action that will be executed when activated.

• Use menuitem_create to create an item.
• Use menuitem_text to assign a text.
• Use menuitem_image to assign an icon.

---

#menuitem_create ()

Create a new item for a menu.

MenuItem*
menuitem_create(void);

Return

The newly item.

---

#menuitem_separator ()

Create a new separator for a menu.

MenuItem*
menuitem_separator(void);

Return

The newly item.

---

#menuitem_OnClick ()

Set an event handle for item click.

void
menuitem_OnClick(MenuItem *item,
                 Listener *listener);

item	The item.
listener	Callback function to be called after clicking.

Remarks

See GUI Events.

---

#menuitem_enabled ()

Enables or disables a menu item.

void
menuitem_enabled(MenuItem *item,
                 const bool_t enabled);

item	The item.
enabled	Enabled or not.

---

#menuitem_visible ()

Show or hide a menu item.

void
menuitem_visible(MenuItem *item,
                 const bool_t enabled);

item	The item.
enabled	Enabled or not.

---

#menuitem_state ()

Set the status of the item, which will be reflected with a mark next to the text.

void
menuitem_state(MenuItem *item,
               const gui_state_t state);

item	The item.
state	State.

---

#menuitem_text ()

Set the item text.

void
menuitem_text(MenuItem *item,
              const char_t *text);

item	The item.
text	UTF8 C-string terminated in null character '\0'.

---

#menuitem_image ()

Set the icon that will display the item.

void
menuitem_image(MenuItem *item,
               const Image *image);

item	The item.
image	Image.

---

#menuitem_key ()

Set a keyboard shortcut to select the menu item.

void
menuitem_key(MenuItem *item,
             const vkey_t key,
             const uint32_t modifiers);

item	The item.
key	Key code.
modifiers	Modifiers.

---

#menuitem_submenu ()

Assign a drop-down submenu when selecting the item.

void
menuitem_submenu(MenuItem *item,
                 Menu **submenu);

item	The item.
submenu	The submenu.

---

#menuitem_get_text ()

Get the current text of an item.

const char_t*
menuitem_get_text(const MenuItem *item);

item

The item.

Return

A UTF8 string terminated with null character '\0'.

---

#menuitem_get_text ()

Get the current icon of an item.

const Image*
menuitem_get_text(const MenuItem *item);

item

The item.

Return

The icon or NULL if hasn't any associated.

---

#menuitem_get_separator ()

Get if an item is a separator.

bool_t
menuitem_get_separator(const MenuItem *item);

item

The item.

Return

TRUE if it is a separator element.

---

#menuitem_get_enabled ()

Get if an item is enabled or not.

bool_t
menuitem_get_enabled(const MenuItem *item);

item

The item.

Return

TRUE if the item is enabled. FALSE when it appears grayed.

---

#menuitem_get_visible ()

Get if an item is visible or not.

bool_t
menuitem_get_visible(const MenuItem *item);

item

The item.

Return

TRUE if the item is visible.

---

#menuitem_get_state ()

Gets the state of an item.

gui_state_t
menuitem_get_state(const MenuItem *item);

item

The item.

Return

State.

---

#menuitem_get_submenu ()

Gets the submenu associated with item.

Menu*
menuitem_get_submenu(const MenuItem *item);

item

The item.

Return

Submenu.

---