csDialog Class Reference
The Dialog class is a single-colored canvas which contains a number of child controls. More...
#include <csdialog.h>
Inheritance diagram for csDialog:
Public Methods | |
| csDialog (csComponent *iParent, csDialogFrameStyle iFrameStyle=csdfsNone) | |
| Create dialog object. | |
| virtual | ~csDialog () |
| Destroy a dialog object. | |
| virtual bool | HandleEvent (iEvent &Event) |
| Handle input events. | |
| void | SetAutoGrid (int iDeltaX, int iDeltaY, bool iSnapSize) |
| Enable/disable(dx<0||dy<0) automatic control placement in a grid fashion. More... | |
| virtual bool | SetRect (int xmin, int ymin, int xmax, int ymax) |
| Do auto-placement work if enabled. | |
| virtual void | SuggestSize (int &w, int &h) |
| Return the recommended minimal size of dialog. | |
| void | GetBorderSize (int &w, int &h) |
| Return border width and height. | |
| void | SetBorderSize (int w, int h) |
| Set border width and height. | |
| virtual void | FixSize (int &newW, int &newH) |
| Fix dialog size when resizing. | |
| csDialogFrameStyle | GetFrameStyle () |
| Query dialog border style. | |
| void | SetFrameStyle (csDialogFrameStyle iFrameStyle) |
| Change dialog border style. | |
| virtual char* | GetSkinName () |
| Get the name of the skip slice for this component. | |
| void | SetAlpha (uint8 iAlpha) |
| Set dialog transparency level (0 - opaque, 255 - fully transparent). | |
| void | SetOverlayAlpha (uint8 iAlpha) |
| Set dialog overlay transparency level (0 - opaque, 255 - fully transparent). | |
| uint8 | GetAlpha () |
| Query dialog transparency level. | |
| uint8 | GetOverlayAlpha () |
| Query dialog overlay transparency level. | |
| void | SetFrameBitmap (csPixmap *iFrameBitmap, bool iDelFrameBitmap) |
| Set the bitmap for the frame (only useful if the framestyle is csdfsBitmap). | |
| void | SetOverlayBitmap (csPixmap *iOverlayBitmap, bool iDelOverlayBitmap) |
| Set the bitmap for the overlay (only useful if the framestyle is csdfsBitmap). | |
| csPixmap* | GetFrameBitmap () |
| Get the frame bitmap. | |
| csPixmap* | GetOverlayBitmap () |
| Get the overlay bitmap. | |
Protected Methods | |
| void | AdjustFocused (bool forward) |
| Adjust focused control by switching back or forth if it is disabled. | |
| bool | PlaceItems () |
| Place all dialog items in correspondence to GridX, GridY and SnapSizeToGrid. | |
Protected Attributes | |
| csDialogFrameStyle | FrameStyle |
| Dialog frame style. | |
| int | GridX |
| Automatical grid placement parameters. | |
| int | GridY |
| Automatical grid placement parameters. | |
| bool | SnapSizeToGrid |
| Automatically snap dialog size to grid? | |
| csComponent* | first |
| First component. | |
| int | BorderWidth |
| Border width and height. | |
| int | BorderHeight |
| Border width and height. | |
| uint8 | Alpha |
| Dialog transparency (if CSS_TRANSPARENT is set). | |
| uint8 | OverlayAlpha |
| Dialog transparency (if CSS_TRANSPARENT is set). | |
| csPixmap* | FrameBitmap |
| Frame bitmap, if there is one. | |
| csPixmap * | OverlayBitmap |
| Frame bitmap, if there is one. | |
| bool | delFrameBitmap |
| Set if this component should delete the frame bitmap when it is done. | |
| bool | delOverlayBitmap |
| Set if this component should delete the frame bitmap when it is done. | |
Static Protected Methods | |
| bool | do_topleft (csComponent *comp, void *param) |
| Used by SuggestSize. | |
Detailed Description
The Dialog class is a single-colored canvas which contains a number of child controls.The dialog can perform a number of operations on its childs such as switching between them using Tab/ShiftTab key, activating the default button when Enter is pressed etc.
Other uses for csDialog class are for floating toolbars. They can be even resizeable; to create a floating toolbar you should create a stand-alone dialog object, setting his DragStyle to CS_DRAG_MOVEABLE and, possibly, CS_DRAG_SIZEABLE. In this case dialog will act as a standalone window; it would be good if you specify its frame style to csdfsAround: in this case it will look like a usual window but without titlebar.
Member Function Documentation
|
|
Enable/disable(dx<0||dy<0) automatic control placement in a grid fashion. DeltaX and DeltaY is the horizontal and vertical distance between controls; SnapSize tells dialog object whenever dialog size should snap when it is resized to the maximal x/y coordinates of all controls. |
The documentation for this class was generated from the following file:
Generated for Crystal Space by doxygen 1.2.5 written by Dimitri van Heesch, ©1997-2000