CrystalSpace

Public API Reference

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

Static control
[Components]


Compounds

class  csStatic
 The Static component class represents a decorative control (widget) which usually does not have functionality, but serves as a decoration. More...


Text alignment flags

#define CSSTA_HALIGNMASK   0x00000003
 Horizontal text alignment mask. More...

#define CSSTA_LEFT   0x00000000
 Align text horizontally to the left (default). More...

#define CSSTA_RIGHT   0x00000001
 Align text horizontally to the right. More...

#define CSSTA_HCENTER   0x00000002
 Center text horizontally. More...

#define CSSTA_VALIGNMASK   0x0000000C
 Vertical text alignment mask. More...

#define CSSTA_TOP   0x00000000
 Align text to top. More...

#define CSSTA_BOTTOM   0x00000004
 Align text to bottom. More...

#define CSSTA_VCENTER   0x00000008
 Center text vertically (default). More...

#define CSSTA_WRAPMASK   0x00000030
 Text wrap mask. More...

#define CSSTA_WORDWRAP   0x00000010
 Wrap text on word boundaries. More...

#define CSSTA_CHARWRAP   0x00000020
 Wrap text on character boundaries. More...


Enumerations

enum  csStaticStyle {
  csscsEmpty, csscsLabel, csscsFrameLabel, csscsRectangle,
  csscsBitmap, csscsText
}
 Possible static component styles. More...

enum  { cscmdStaticHotKeyEvent = 0x00000700, cscmdStaticMouseEvent, cscmdStaticSetBitmap, cscmdStaticGetBitmap }
 Static control class messages. More...


Define Documentation

#define CSSTA_BOTTOM   0x00000004
 

Align text to bottom.

Definition at line 66 of file csstatic.h.

#define CSSTA_CHARWRAP   0x00000020
 

Wrap text on character boundaries.

Definition at line 74 of file csstatic.h.

#define CSSTA_HALIGNMASK   0x00000003
 

Horizontal text alignment mask.

Definition at line 54 of file csstatic.h.

#define CSSTA_HCENTER   0x00000002
 

Center text horizontally.

Definition at line 60 of file csstatic.h.

#define CSSTA_LEFT   0x00000000
 

Align text horizontally to the left (default).

Definition at line 56 of file csstatic.h.

#define CSSTA_RIGHT   0x00000001
 

Align text horizontally to the right.

Definition at line 58 of file csstatic.h.

#define CSSTA_TOP   0x00000000
 

Align text to top.

Definition at line 64 of file csstatic.h.

#define CSSTA_VALIGNMASK   0x0000000C
 

Vertical text alignment mask.

Definition at line 62 of file csstatic.h.

#define CSSTA_VCENTER   0x00000008
 

Center text vertically (default).

Definition at line 68 of file csstatic.h.

#define CSSTA_WORDWRAP   0x00000010
 

Wrap text on word boundaries.

Definition at line 72 of file csstatic.h.

#define CSSTA_WRAPMASK   0x00000030
 

Text wrap mask.

Definition at line 70 of file csstatic.h.


Enumeration Type Documentation

anonymous enum
 

Static control class messages.

Enumeration values:
cscmdStaticHotKeyEvent  Sent by a label to its link when a "hot key pressed/depressed" event is detected
 IN:  (iEvent *)Event
 
.
cscmdStaticMouseEvent  Sent by a label to its link when a mouse event is detected
 IN:  (iEvent *)Event
 
.
cscmdStaticSetBitmap  Set static control bitmap (if control style is csscsBitmap).

NOTE: We don't delete the old bitmap, because we assume that if you're changing bitmaps, you're going to reuse them.

 IN:  (csPixmap *)iBitmap
 
cscmdStaticGetBitmap  Get static control bitmap handle
 IN:  nothing
 OUT: (csPixmap *)iBitmap
 
.

Definition at line 78 of file csstatic.h.

enum csStaticStyle
 

Possible static component styles.

Enumeration values:
csscsEmpty  Empty component. No idea what it can be used for :-).
csscsLabel  A transparent rectangle with text.
csscsFrameLabel  Same as csscsLabel but with a thin 3D frame around.
csscsRectangle  A rectangle of background color.
csscsBitmap  A bitmap.
csscsText  Text.

Definition at line 34 of file csstatic.h.


Generated for Crystal Space by doxygen 1.2.14