GATE
gate::ui::KeyListbox< KEY, COMPARER > Class Template Reference
Inheritance diagram for gate::ui::KeyListbox< KEY, COMPARER >:
gate::ui::Listbox gate::ui::Control gate::NonCopyable

Classes

struct  KeyArg
 

Public Types

typedef KEY key_t
 
typedef COMPARER key_comparer_t
 
typedef KeyListbox< KEY, COMPARER > self_t
 
typedef Listbox base_t
 
typedef Event< self_t, KeyArg >::delegate_t SelectEventHandler
 
typedef Event< self_t, KeyArg >::delegate_t ContextMenuEventHandler
 
typedef Event< self_t, KeyArg >::delegate_t OpenEventHandler
 
- Public Types inherited from gate::ui::Listbox
typedef Event< Listbox, IndexArg >::delegate_t SelectEventHandler
 
typedef Event< Listbox, IndexArg >::delegate_t ContextMenuEventHandler
 
typedef Event< Listbox, IndexArg >::delegate_t OpenEventHandler
 

Public Member Functions

void create (ControlContainer &parent, Position const &pose=Position(), uint32_t flags=(Listbox::Flag_Enabled|Listbox::Flag_Visible))
 
void addItem (String const &text, key_t const &key)
 
void insertItem (key_t const &at_key, String const &text, key_t const &key)
 
bool_t removeItem (key_t const &key)
 
void removeAllItems ()
 
String getItemText (key_t const &key)
 
void setItemText (key_t const &key, String const &text)
 
bool_t getSelectedItem (key_t &selected_key)
 
void setSelectedItem (key_t const &selected_key)
 
void setNoSelectedItem ()
 
- Public Member Functions inherited from gate::ui::Listbox
void create (ControlContainer &parent, Position const &pose=Position(), uint32_t flags=(Listbox::Flag_Enabled|Listbox::Flag_Visible))
 
void addItem (String const &text, void *param=NULL)
 
void insertItem (size_t index, String const &text, void *param=NULL)
 
bool_t removeItem (size_t index)
 
void removeAllItems ()
 
size_t getItemCount ()
 
void * getItemParam (size_t index)
 
size_t findItemParam (void *param, size_t startAtIndex=0)
 
String getItemText (size_t index)
 
void setItemText (size_t index, String const &text)
 
bool_t getSelectedItem (size_t &index)
 
void setSelectedItem (size_t index)
 
void setNoSelectedItem ()
 
- Public Member Functions inherited from gate::ui::Control
bool isCreated () const noexcept
 
bool isEnabled () const
 
bool isFocused () const
 
Position getPosition () const
 
Size getSize () const
 
uint32_t getTextLength () const
 
String getText () const
 
int32_t getState () const
 
void setEnabled (bool enabled)
 
void setVisible (bool visible)
 
void setPosition (Point const *position, Size const *size)
 
void setPosition (Position const &pos)
 
void setFocus ()
 
void setText (String const &text)
 
void setState (int32_t state)
 
void destroy () noexcept
 
gate_ui_ctrl_tc_impl () const
 
gate_ui_ctrl_toperator* () const
 

Public Attributes

Event< self_t, KeyArgSelectEvent
 
Event< self_t, KeyArgContextMenuEvent
 
Event< self_t, KeyArgOpenEvent
 
- Public Attributes inherited from gate::ui::Listbox
Event< Listbox, IndexArgSelectEvent
 
Event< Listbox, IndexArgContextMenuEvent
 
Event< Listbox, IndexArgOpenEvent
 

Protected Member Functions

virtual void onSelect (size_t index)
 
virtual void onContextMenu (size_t index)
 
virtual void onOpen (size_t index)
 
- Protected Member Functions inherited from gate::ui::Control
 Control (gate_ui_ctrl_t *ctrlimpl)
 
void attachNativeControl (gate_ui_ctrl_t *ctl)
 
void failIfCreated (char const *sourceFunction=NULL)
 
void failIfNotCreated (char const *sourceFunction=NULL)
 

Additional Inherited Members

- Static Public Attributes inherited from gate::ui::Listbox
static size_t const InvalidIndex = GATE_UI_LISTBOX_INVALID_INDEX
 
- Static Public Attributes inherited from gate::ui::Control
static uint32_t const Flag_Enabled = GATE_UI_FLAG_ENABLED
 
static uint32_t const Flag_Visible = GATE_UI_FLAG_VISIBLE
 
static uint32_t const Flag_Resizable = GATE_UI_FLAG_RESIZABLE
 

Member Function Documentation

◆ onContextMenu()

template<class KEY , class COMPARER = DefaultComparer<KEY>>
virtual void gate::ui::KeyListbox< KEY, COMPARER >::onContextMenu ( size_t index)
inlineprotectedvirtual

Reimplemented from gate::ui::Listbox.

◆ onOpen()

template<class KEY , class COMPARER = DefaultComparer<KEY>>
virtual void gate::ui::KeyListbox< KEY, COMPARER >::onOpen ( size_t index)
inlineprotectedvirtual

Reimplemented from gate::ui::Listbox.

◆ onSelect()

template<class KEY , class COMPARER = DefaultComparer<KEY>>
virtual void gate::ui::KeyListbox< KEY, COMPARER >::onSelect ( size_t index)
inlineprotectedvirtual

Reimplemented from gate::ui::Listbox.


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