ALBA
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
albaGUIListCtrl Class Reference

#include <albaGUIListCtrl.h>

Inheritance diagram for albaGUIListCtrl:
Inheritance graph
[legend]
Collaboration diagram for albaGUIListCtrl:
Collaboration graph
[legend]

Public Member Functions

 albaGUIListCtrl (wxWindow *parent, wxWindowID id=-1, bool CloseButton=false, bool HideTitle=false)
 
virtual ~albaGUIListCtrl ()
 
void SetListener (albaObserver *listener)
 
void Reset ()
 
bool AddItem (wxString label, ITEM_ICONS icon=ITEM_GRAY)
 
bool DeleteItem (long index)
 
void DeselectItem (long index)
 
bool SetItemLabel (long index, wxString label)
 
wxString GetItemLabel (long index)
 
bool SetItemIcon (long index, ITEM_ICONS icon)
 
ITEM_ICONS GetItemIcon (long index)
 
bool SelectItem (long index)
 
void SetColumnLabel (int col, wxString label)
 
- Public Member Functions inherited from albaGUINamedPanel
 albaGUINamedPanel (wxWindow *parent, wxWindowID id=-1, bool CloseButton=false, bool HideTitle=false)
 
virtual ~albaGUINamedPanel ()
 
void Add (wxWindow *window, int option=0, int flag=wxEXPAND, int border=0)
 
void Add (wxSizer *sizer, int option=0, int flag=wxEXPAND, int border=0)
 
bool Remove (wxWindow *window)
 
bool Remove (wxSizer *sizer)
 
void SetTitle (wxString label)
 
void SetTitleColor (wxColour *color=NULL)
 
wxBoxSizer * GetTopSizer ()
 
wxPanel * GetTopPanel ()
 
- Public Member Functions inherited from albaGUIPanel
 albaGUIPanel (wxWindow *parent, wxWindowID id, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxTAB_TRAVERSAL, const wxString &name="panel")
 

Protected Member Functions

void OnSelectionChanged (wxListEvent &event)
 

Protected Attributes

bool m_PreventNotify
 
wxListCtrl * m_List
 
wxImageList * m_Images
 
albaObserverm_Listener
 
- Protected Attributes inherited from albaGUINamedPanel
wxPanel * m_Top
 
albaGUILabm_Label
 
wxBoxSizer * m_Sizer
 
wxBoxSizer * m_TopSizer
 
albaGUINamedPanelm_NextPanel
 
wxColour m_Color
 

Additional Inherited Members

- Public Attributes inherited from albaGUIPanel
albaGUIPanelm_NextPanel
 

Detailed Description

albaGUIListCtrl allows a simplified use of a wxWindows ListCtrl widget.

Definition at line 48 of file albaGUIListCtrl.h.

Constructor & Destructor Documentation

◆ albaGUIListCtrl()

albaGUIListCtrl::albaGUIListCtrl ( wxWindow *  parent,
wxWindowID  id = -1,
bool  CloseButton = false,
bool  HideTitle = false 
)

◆ ~albaGUIListCtrl()

virtual albaGUIListCtrl::~albaGUIListCtrl ( )
virtual

Member Function Documentation

◆ SetListener()

void albaGUIListCtrl::SetListener ( albaObserver listener)
inline

Definition at line 53 of file albaGUIListCtrl.h.

References m_Listener.

◆ Reset()

void albaGUIListCtrl::Reset ( )

Clear the control list.

◆ AddItem()

bool albaGUIListCtrl::AddItem ( wxString  label,
ITEM_ICONS  icon = ITEM_GRAY 
)

Add one item to the list.

◆ DeleteItem()

bool albaGUIListCtrl::DeleteItem ( long  index)

Remove the item from the list.

◆ DeselectItem()

void albaGUIListCtrl::DeselectItem ( long  index)

Deselect an item from the list.

◆ SetItemLabel()

bool albaGUIListCtrl::SetItemLabel ( long  index,
wxString  label 
)

Set the item's label.

◆ GetItemLabel()

wxString albaGUIListCtrl::GetItemLabel ( long  index)

Get the item's label.

◆ SetItemIcon()

bool albaGUIListCtrl::SetItemIcon ( long  index,
ITEM_ICONS  icon 
)

Set the item's icon, return true on success.

◆ GetItemIcon()

ITEM_ICONS albaGUIListCtrl::GetItemIcon ( long  index)

Get the item's icon.

◆ SelectItem()

bool albaGUIListCtrl::SelectItem ( long  index)

Select the item 'id'.

◆ SetColumnLabel()

void albaGUIListCtrl::SetColumnLabel ( int  col,
wxString  label 
)

Set the label for the list's column.

◆ OnSelectionChanged()

void albaGUIListCtrl::OnSelectionChanged ( wxListEvent &  event)
protected

Notify the Listener of item selection and deselection.

Member Data Documentation

◆ m_PreventNotify

bool albaGUIListCtrl::m_PreventNotify
protected

Definition at line 89 of file albaGUIListCtrl.h.

◆ m_List

wxListCtrl* albaGUIListCtrl::m_List
protected

Definition at line 90 of file albaGUIListCtrl.h.

◆ m_Images

wxImageList* albaGUIListCtrl::m_Images
protected

Definition at line 91 of file albaGUIListCtrl.h.

◆ m_Listener

albaObserver* albaGUIListCtrl::m_Listener
protected

Definition at line 92 of file albaGUIListCtrl.h.

Referenced by SetListener().


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