CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

List box
[Components]


Compounds

class  csListBox
 List box class is a rectangle which contains a number of list box items. More...

class  csListBoxItem
 This class encapsulates a menu item. More...


List box styles

These are bit masks that can be ORed together to form a value passed to csListBox constructor.

#define CSLBS_MULTIPLESEL   0x00000001
 List box can have multiple items selected. More...

#define CSLBS_HSCROLL   0x00000002
 List box has a horizontal scroll bar. More...

#define CSLBS_VSCROLL   0x00000004
 List box has a vertical scroll bar. More...

#define CSLBS_DEFAULTVALUE   CSLBS_VSCROLL
 Default list box style. More...


Defines

#define CSS_LISTBOXITEM_SELECTED   0x00010000
 Additional state flag used to mark selected list box items. More...

#define CS_LISTBOXITEMCHECK_SELECTED   0xdeadface
 The magic answer that means that the listbox item is selected. More...

#define CS_LISTBOXITEMCHECK_UNSELECTED   0x0badf00d
 The magic answer that means that the listbox item is not selected. More...


Enumerations

enum  {
  cscmdListBoxStartTracking = 0x00000400, cscmdListBoxTrack, cscmdListBoxMakeVisible, cscmdListBoxClear,
  cscmdListBoxItemCheck, cscmdListBoxItemSet, cscmdListBoxItemSelected, cscmdListBoxItemDeselected,
  cscmdListBoxItemClicked, cscmdListBoxItemDoubleClicked, cscmdListBoxItemFocused, cscmdListBoxItemScrollVertically,
  cscmdListBoxItemSetHorizOffset, cscmdListBoxQueryFirstSelected, cscmdListBoxSelectItem
}
 List box - specific messages. More...

enum  csListBoxItemStyle { cslisNormal, cslisEmphasized }
 List box items are divided into several subtypes which will be shown in different colors. More...

enum  csListBoxFrameStyle {
  cslfsNone, cslfsThinRect, cslfsThickRect, cslfsTextured,
  cslfsTexturedNoFrame, cslfsBitmap
}
 List box frame styles. More...


Define Documentation

#define CS_LISTBOXITEMCHECK_SELECTED   0xdeadface
 

The magic answer that means that the listbox item is selected.

Definition at line 170 of file cslistbx.h.

#define CS_LISTBOXITEMCHECK_UNSELECTED   0x0badf00d
 

The magic answer that means that the listbox item is not selected.

Definition at line 172 of file cslistbx.h.

#define CSLBS_DEFAULTVALUE   CSLBS_VSCROLL
 

Default list box style.

Definition at line 265 of file cslistbx.h.

#define CSLBS_HSCROLL   0x00000002
 

List box has a horizontal scroll bar.

Definition at line 260 of file cslistbx.h.

#define CSLBS_MULTIPLESEL   0x00000001
 

List box can have multiple items selected.

Definition at line 258 of file cslistbx.h.

#define CSLBS_VSCROLL   0x00000004
 

List box has a vertical scroll bar.

Definition at line 262 of file cslistbx.h.

#define CSS_LISTBOXITEM_SELECTED   0x00010000
 

Additional state flag used to mark selected list box items.

Definition at line 167 of file cslistbx.h.


Enumeration Type Documentation

anonymous enum
 

List box - specific messages.

Enumeration values:
cscmdListBoxStartTracking  This message is sent by a listbox item to its parent when it receives a 'mouse down' event.

 IN:  (csListBoxItem *)source;
 
cscmdListBoxTrack  This message is sent by a listbox item to its parent when parent has captured the mouse and mouse is moved over a unfocused list box item
 IN:  (csListBoxItem *)source;
 
.
cscmdListBoxMakeVisible  This command tells to a ListBox object to make given item visible
 IN: (csListBoxItem *)item;
 
.
cscmdListBoxClear  Completely clear a listbox.
cscmdListBoxItemCheck  Query state of a listbox item
 IN:  NULL
 OUT: (int)CS_LISTBOXITEMCHECK_SELECTED or
      (int)CS_LISTBOXITEMCHECK_UNSELECTED
 
.
cscmdListBoxItemSet  This command is sent to a list box item to set its state (selected/unselected)
 IN: (bool)SelectedState;
 
.
cscmdListBoxItemSelected  The following command is sent by a list box item to notify its owner of the fact that it has been selected.

List box (usually owner of item is a listbox) resends this message to its parent.

 IN: (csListBoxItem *)source;
 
cscmdListBoxItemDeselected  Same as above, except notifies owner that list box item has been deselected.

 IN: (csListBoxItem *)source;
 
cscmdListBoxItemClicked  The following command is sent by a list box item to notify its owner of the fact that it has been clicked.

List box (usually owner of item is a listbox) resends this message to its parent. Unlike cscmdListBoxItemSelected message this message is sent even if listbox item has been already selected.

 IN: (csListBoxItem *)source;
 
cscmdListBoxItemDoubleClicked  The following command is sent by a list box item to notify its owner of the fact that it has been doubly clicked.

List box (usually owner of item is a listbox) resends this message to its parent.

 IN: (csListBoxItem *)source;
 
cscmdListBoxItemFocused  This message is sent by a listbox to notify its parent that a item has been focused.

 IN: (csListBoxItem *)Item;
 
To find the parent listbox of the item, use Item->parent; Item->parent->parent is the listbox parent.
cscmdListBoxItemScrollVertically  Ask a listbox item if it is entirely visible.

If not, the list box will scroll vertically, if possible, until it will be entirely visible.

 IN:  (bool)false
 OUT: (bool)true if listbox should scroll
 
cscmdListBoxItemSetHorizOffset  Set horizontal offset for a listbox item
 IN: (int)deltaX
 
.
cscmdListBoxQueryFirstSelected  Query first selected item ID.

Handy for non-multiple-select list boxes.

 OUT: (csListBoxItem *)item
 
cscmdListBoxSelectItem  Select first item that exactly matches the text.

 IN: (char *)text
 OUT: (csListBoxItem *)item (or NULL if not found)
 

Definition at line 37 of file cslistbx.h.

enum csListBoxFrameStyle
 

List box frame styles.

Enumeration values:
cslfsNone  List box has no frame.
cslfsThinRect  List box has a thin 3D rectangular frame.
cslfsThickRect  List box has a thick 3D rectangular frame.
cslfsTextured  List box has a thin 3D rectangular frame, and it's background is textured.
cslfsTexturedNoFrame  List box has no frame, and it's background is textured.
cslfsBitmap  List box has a bitmap frame.

Definition at line 269 of file cslistbx.h.

Referenced by csListBox::GetFrameStyle.

enum csListBoxItemStyle
 

List box items are divided into several subtypes which will be shown in different colors.

Enumeration values:
cslisNormal  Normal text.
cslisEmphasized  Emphasized text.

Definition at line 178 of file cslistbx.h.

Referenced by csListBoxItem::GetItemStyle.


Generated for Crystal Space by doxygen 1.2.14