CrystalSpace

Public API Reference

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

Windows
[Components]


Compounds

class  csWindow
 A csWindow object is a rectangular area of screen with border which optionally contains a titlebar, a menubar and a client component. More...


Window style flags

#define CSWS_BUTSYSMENU   0x00000001
 does window have a system menu?

#define CSWS_BUTCLOSE   0x00000002
 Does window have a close button?

#define CSWS_BUTHIDE   0x00000004
 Does window have a hide button?

#define CSWS_BUTMAXIMIZE   0x00000008
 Does window have a maximize/restore button?

#define CSWS_TITLEBAR   0x00000010
 Does window have a titlebar?

#define CSWS_MENUBAR   0x00000020
 Does window have a menu bar?

#define CSWS_CLIENTBORDER   0x00000040
 Does window draw a thin 3D frame around client window?

#define CSWS_TOOLBAR   0x00000080
 Does window have a tool bar?

#define CSWS_TBPOS_MASK   0x00000300
 Toolbar position mask.

#define CSWS_TBPOS_TOP   0x00000000
 Toolbar is automatically placed at top of window (below menu bar).

#define CSWS_TBPOS_BOTTOM   0x00000100
 Toolbar is automatically placed at bottom of window.

#define CSWS_TBPOS_LEFT   0x00000200
 Toolbar is automatically placed at left of window.

#define CSWS_TBPOS_RIGHT   0x00000300
 Toolbar is automatically placed at right of window.

#define CSWS_DEFAULTVALUE
 Default window style.


Defines

#define CSWID_BUTSYSMENU   0xC500
 Window system menu button ID.

#define CSWID_BUTCLOSE   0xC501
 Window close button ID.

#define CSWID_BUTHIDE   0xC502
 Window hide button ID.

#define CSWID_BUTMAXIMIZE   0xC503
 Window maximize button ID.

#define CSWID_TITLEBAR   0xC504
 Window title bar ID.

#define CSWID_MENUBAR   0xC505
 Window menu bar ID.

#define CSWID_CLIENT   0xC506
 Client window ID.

#define CSWID_SYSMENU   0xC507
 System menu ID.

#define CSWID_TOOLBAR   0xC508
 Tool bar ID.


Enumerations

enum  csWindowFrameStyle
 Possible window frame styles. More...

enum  { cscmdWindowSysMenu = 0x00000100, cscmdWindowSetClient }
 The following commands are generated by titlebar buttons. More...


Define Documentation

#define CSWID_BUTCLOSE   0xC501
 

Window close button ID.

Definition at line 39 of file cswindow.h.

#define CSWID_BUTHIDE   0xC502
 

Window hide button ID.

Definition at line 41 of file cswindow.h.

#define CSWID_BUTMAXIMIZE   0xC503
 

Window maximize button ID.

Definition at line 43 of file cswindow.h.

#define CSWID_BUTSYSMENU   0xC500
 

Window system menu button ID.

Definition at line 37 of file cswindow.h.

#define CSWID_CLIENT   0xC506
 

Client window ID.

Definition at line 49 of file cswindow.h.

#define CSWID_MENUBAR   0xC505
 

Window menu bar ID.

Definition at line 47 of file cswindow.h.

#define CSWID_SYSMENU   0xC507
 

System menu ID.

Definition at line 51 of file cswindow.h.

#define CSWID_TITLEBAR   0xC504
 

Window title bar ID.

Definition at line 45 of file cswindow.h.

#define CSWID_TOOLBAR   0xC508
 

Tool bar ID.

Definition at line 53 of file cswindow.h.

#define CSWS_BUTCLOSE   0x00000002
 

Does window have a close button?

Definition at line 61 of file cswindow.h.

#define CSWS_BUTHIDE   0x00000004
 

Does window have a hide button?

Definition at line 63 of file cswindow.h.

#define CSWS_BUTMAXIMIZE   0x00000008
 

Does window have a maximize/restore button?

Definition at line 65 of file cswindow.h.

#define CSWS_BUTSYSMENU   0x00000001
 

does window have a system menu?

Definition at line 59 of file cswindow.h.

#define CSWS_CLIENTBORDER   0x00000040
 

Does window draw a thin 3D frame around client window?

Definition at line 71 of file cswindow.h.

#define CSWS_DEFAULTVALUE
 

Value:

Default window style.

Definition at line 85 of file cswindow.h.

#define CSWS_MENUBAR   0x00000020
 

Does window have a menu bar?

Definition at line 69 of file cswindow.h.

#define CSWS_TBPOS_BOTTOM   0x00000100
 

Toolbar is automatically placed at bottom of window.

Definition at line 79 of file cswindow.h.

#define CSWS_TBPOS_LEFT   0x00000200
 

Toolbar is automatically placed at left of window.

Definition at line 81 of file cswindow.h.

#define CSWS_TBPOS_MASK   0x00000300
 

Toolbar position mask.

Definition at line 75 of file cswindow.h.

#define CSWS_TBPOS_RIGHT   0x00000300
 

Toolbar is automatically placed at right of window.

Definition at line 83 of file cswindow.h.

#define CSWS_TBPOS_TOP   0x00000000
 

Toolbar is automatically placed at top of window (below menu bar).

Definition at line 77 of file cswindow.h.

#define CSWS_TITLEBAR   0x00000010
 

Does window have a titlebar?

Definition at line 67 of file cswindow.h.

#define CSWS_TOOLBAR   0x00000080
 

Does window have a tool bar?

Definition at line 73 of file cswindow.h.


Enumeration Type Documentation

anonymous enum
 

The following commands are generated by titlebar buttons.

Commands generated by buttons contains in Info field a pointer to object that generated the command (usually this is a object derived from csButton).

Enumeration values:
cscmdWindowSysMenu  The "show system menu" command.
cscmdWindowSetClient  Set given component as client window.

 IN:  (csComponent *)client;
 OUT: 0 if successful
 

Definition at line 105 of file cswindow.h.

enum csWindowFrameStyle
 

Possible window frame styles.

Definition at line 92 of file cswindow.h.

Referenced by csWindow::GetFrameStyle().


Generated for Crystal Space by doxygen 1.2.18