CrystalSpace

Public API Reference

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

csListBoxItem Class Reference
[List box]

This class encapsulates a menu item. More...

#include <cslistbx.h>

Inheritance diagram for csListBoxItem:

csComponent List of all members.

Public Methods

 csListBoxItem (csComponent *iParent, const char *iText, int iID=0, csListBoxItemStyle iStyle=cslisNormal)
 Listbox item constructor: text item with optional style. More...

virtual ~csListBoxItem ()
 Listbox item destructor. More...

virtual bool HandleEvent (iEvent &Event)
 Handle input events. More...

virtual void SetState (int mask, bool enable)
 Handle additional state flags. More...

virtual void SuggestSize (int &w, int &h)
 Report the minimal size of menu item. More...

void SetBitmap (csPixmap *iBitmap, bool iDelete=true)
 Set listbox item image. More...

void SetOffset (int ihOffset)
 Set content offset. More...

virtual char * GetSkinName ()
 Get the name of the skip slice for this component. More...

csListBoxItemStyle GetItemStyle ()
 Get list box item style. More...

int GetDeltaX ()
 Get horizontal item offset in pixels. More...

csPixmapGetItemBitmap ()
 Get listbox item image. More...

int GetHOffset ()
 Get horizontal contents offset. More...


Detailed Description

This class encapsulates a menu item.

Definition at line 187 of file cslistbx.h.


Constructor & Destructor Documentation

csListBoxItem::csListBoxItem csComponent   iParent,
const char *    iText,
int    iID = 0,
csListBoxItemStyle    iStyle = cslisNormal
 

Listbox item constructor: text item with optional style.

virtual csListBoxItem::~csListBoxItem   [virtual]
 

Listbox item destructor.


Member Function Documentation

int csListBoxItem::GetDeltaX   [inline]
 

Get horizontal item offset in pixels.

Definition at line 237 of file cslistbx.h.

int csListBoxItem::GetHOffset   [inline]
 

Get horizontal contents offset.

Definition at line 245 of file cslistbx.h.

csPixmap* csListBoxItem::GetItemBitmap   [inline]
 

Get listbox item image.

Definition at line 241 of file cslistbx.h.

csListBoxItemStyle csListBoxItem::GetItemStyle   [inline]
 

Get list box item style.

Definition at line 233 of file cslistbx.h.

References csListBoxItemStyle.

virtual char* csListBoxItem::GetSkinName   [inline, virtual]
 

Get the name of the skip slice for this component.

Reimplemented from csComponent.

Definition at line 225 of file cslistbx.h.

virtual bool csListBoxItem::HandleEvent iEvent   Event [virtual]
 

Handle input events.

Reimplemented from csComponent.

void csListBoxItem::SetBitmap csPixmap   iBitmap,
bool    iDelete = true
 

Set listbox item image.

void csListBoxItem::SetOffset int    ihOffset [inline]
 

Set content offset.

Definition at line 221 of file cslistbx.h.

References csComponent::Invalidate.

virtual void csListBoxItem::SetState int    mask,
bool    enable
[virtual]
 

Handle additional state flags.

Reimplemented from csComponent.

virtual void csListBoxItem::SuggestSize int &    w,
int &    h
[virtual]
 

Report the minimal size of menu item.

Reimplemented from csComponent.


The documentation for this class was generated from the following file:
Generated for Crystal Space by doxygen 1.2.14