omgui::Separator Class Reference

#include <omgui/menuitems.h>

Inherits omgui::MenuItem.

List of all members.


Detailed Description

A separator is a menu item that the user cannot select, but instead visually separates groups of related menu items. Separators have no labels, and disabling is not really useful. Separators are also given a menu_id of -1.

Public Types

typedef omgui::api::Separator api_type

Public Member Functions

void add_ref ()
void disable ()
void enable (bool value=true)
bool enabled () const
menu_id get_id () const
api_typeget_impl () const
string get_label () const
void release ()
void set_label (const string &label)

Static Public Member Functions

static MenuItemcreate (menu_id id, const string &label)
static MenuItemcreate (object_id obj_id, menu_id id, const string &label)
static Separatorcreate ()

Protected Member Functions

 Separator ()

Member Typedef Documentation

Reimplemented from omgui::MenuItem.


Constructor & Destructor Documentation

omgui::Separator::Separator (  )  [protected]

Note:
This constructor is implemented by the current platform


Member Function Documentation

void omgui::MenuItem::add_ref (  )  [inline, virtual, inherited]

Implements omgui::RefCountable.

static MenuItem* omgui::MenuItem::create ( menu_id  id,
const string label 
) [inline, static, inherited]

Creates a MenuItem with the given menu_id and label. The MenuItem will be creating with an automatically generated object_id.

MenuItem * omgui::MenuItem::create ( object_id  obj_id,
menu_id  id,
const string label 
) [static, inherited]

Creates a MenuItem with the given object_id, menu_id and label.

Separator * omgui::Separator::create (  )  [static]

Creates a Separator

void omgui::MenuItem::disable (  )  [inline, inherited]

Disables the menu item

void omgui::MenuItem::enable ( bool  value = true  )  [inherited]

Enables or disables the menu item. Disabled menu items cannot be selected by the user.

bool omgui::MenuItem::enabled (  )  const [inherited]

Returns:
Whether the menu is enabled or not

menu_id omgui::MenuItem::get_id (  )  const [inherited]

Returns:
The menu idenfitier for this menu

Reimplemented from omgui::Object.

MenuItem::api_type * omgui::MenuItem::get_impl (  )  const [inherited]

string omgui::MenuItem::get_label (  )  const [inherited]

Returns:
This MenuItem's label

void omgui::MenuItem::release (  )  [inline, virtual, inherited]

Implements omgui::RefCountable.

void omgui::MenuItem::set_label ( const string label  )  [inherited]

Sets the label for this menu item.


doxygen SourceForge.net Logo