#include <IGUISkin.h>
Inheritance diagram for IGUISkin:
| ~IGUISkin | ( | ) | [inline] |
| virtual void draw3DButtonPanePressed | ( | IGUIElement * | element, | |
| const core::rect< s32 > & | rect, | |||
| const core::rect< s32 > * | clip = 0 | |||
| ) | [pure virtual] |
Used for drawing for example buttons in pressed state. It uses the colors EGDC_3D_DARK_SHADOW, EGDC_3D_HIGH_LIGHT, EGDC_3D_SHADOW and EGDC_3D_FACE for this. See EGUI_DEFAULT_COLOR for details.
| element,: | Pointer to the element which whiches to draw this. This parameter is usually not used by ISkin, but can be used for example by more complex implementations to find out how to draw the part exactly. | |
| rect,: | Defining area where to draw. | |
| clip,: | Clip area. |
Implemented in CGUISkin.
| virtual void draw3DButtonPaneStandard | ( | IGUIElement * | element, | |
| const core::rect< s32 > & | rect, | |||
| const core::rect< s32 > * | clip = 0 | |||
| ) | [pure virtual] |
Used for drawing for example buttons in normal state. It uses the colors EGDC_3D_DARK_SHADOW, EGDC_3D_HIGH_LIGHT, EGDC_3D_SHADOW and EGDC_3D_FACE for this. See EGUI_DEFAULT_COLOR for details.
| element,: | Pointer to the element which whiches to draw this. This parameter is usually not used by ISkin, but can be used for example by more complex implementations to find out how to draw the part exactly. | |
| rect,: | Defining area where to draw. | |
| clip,: | Clip area. |
Implemented in CGUISkin.
| virtual void draw3DMenuPane | ( | IGUIElement * | element, | |
| const core::rect< s32 > & | rect, | |||
| const core::rect< s32 > * | clip = 0 | |||
| ) | [pure virtual] |
Used for drawing for menus and context menus. It uses the colors EGDC_3D_DARK_SHADOW, EGDC_3D_HIGH_LIGHT, EGDC_3D_SHADOW and EGDC_3D_FACE for this. See EGUI_DEFAULT_COLOR for details.
| element,: | Pointer to the element which whiches to draw this. This parameter is usually not used by ISkin, but can be used for example by more complex implementations to find out how to draw the part exactly. | |
| rect,: | Defining area where to draw. | |
| clip,: | Clip area. |
Implemented in CGUISkin.
| virtual void draw3DSunkenPane | ( | IGUIElement * | element, | |
| video::SColor | bgcolor, | |||
| bool | flat, | |||
| bool | fillBackGround, | |||
| const core::rect< s32 > & | rect, | |||
| const core::rect< s32 > * | clip = 0 | |||
| ) | [pure virtual] |
Used for drawing the background of edit, combo or check boxes.
| element,: | Pointer to the element which whiches to draw this. This parameter is usually not used by ISkin, but can be used for example by more complex implementations to find out how to draw the part exactly. | |
| bgcolor,: | Background color. | |
| flat,: | Specifies if the sunken pane should be flat or displayed as sunken deep into the ground. | |
| fillBackGround,: | Specifies if the background should be filled with the background color or not be drawn at all. | |
| rect,: | Defining area where to draw. | |
| clip,: | Clip area. |
Implemented in CGUISkin.
| virtual void draw3DTabBody | ( | IGUIElement * | element, | |
| bool | border, | |||
| bool | background, | |||
| const core::rect< s32 > & | rect, | |||
| const core::rect< s32 > * | clip = 0 | |||
| ) | [pure virtual] |
| element,: | Pointer to the element which whiches to draw this. This parameter is usually not used by ISkin, but can be used for example by more complex implementations to find out how to draw the part exactly. | |
| border,: | Specifies if the border should be drawn. | |
| background,: | Specifies if the background should be drawn. | |
| rect,: | Defining area where to draw. | |
| clip,: | Clip area. |
Implemented in CGUISkin.
| virtual void draw3DTabButton | ( | IGUIElement * | element, | |
| bool | active, | |||
| const core::rect< s32 > & | rect, | |||
| const core::rect< s32 > * | clip = 0 | |||
| ) | [pure virtual] |
Used for drawing for tab buttons on top of tabs.
| element,: | Pointer to the element which whiches to draw this. This parameter is usually not used by ISkin, but can be used for example by more complex implementations to find out how to draw the part exactly. | |
| active,: | Specifies if the tab is currently active. | |
| rect,: | Defining area where to draw. | |
| clip,: | Clip area. |
Implemented in CGUISkin.
| virtual void draw3DToolBar | ( | IGUIElement * | element, | |
| const core::rect< s32 > & | rect, | |||
| const core::rect< s32 > * | clip = 0 | |||
| ) | [pure virtual] |
Used for drawing for toolbars and menus.
| element,: | Pointer to the element which whiches to draw this. This parameter is usually not used by ISkin, but can be used for example by more complex implementations to find out how to draw the part exactly. | |
| rect,: | Defining area where to draw. | |
| clip,: | Clip area. |
Implemented in CGUISkin.
| virtual core::rect<s32> draw3DWindowBackground | ( | IGUIElement * | element, | |
| bool | drawTitleBar, | |||
| video::SColor | titleBarColor, | |||
| const core::rect< s32 > & | rect, | |||
| const core::rect< s32 > * | clip = 0 | |||
| ) | [pure virtual] |
Used for drawing the background of dialogs and windows.
| element,: | Pointer to the element which whiches to draw this. This parameter is usually not used by ISkin, but can be used for example by more complex implementations to find out how to draw the part exactly. | |
| titleBarColor,: | Title color. | |
| drawTitleBar,: | True to enable title drawing. | |
| rect,: | Defining area where to draw. | |
| clip,: | Clip area. |
Implemented in CGUISkin.
| bool drop | ( | ) | [inline, inherited] |
Drops the object. Decrements the reference counter by one. Returns true, if the object was deleted. The IrrUnknown class provides a basic reference counting mechanism with its methods grab() and drop(). Most objects of the Irrlicht Engine are derived from IrrUnknown, and so they are reference counted.
When you create an object in the Irrlicht engine, calling a method which starts with 'create', an object is created, and you get a pointer to the new object. If you no longer need the object, you have to call drop(). This will destroy the object, if grab() was not called in another part of you program, because this part still needs the object. Note, that you only need to call drop() to the object, if you created it, and the method had a 'create' in it.
A simple example:
If you want to create a texture, you may want to call an imaginable method IDriver::createTexture. You call ITexture* texture = driver->createTexture(dimension2d<s32>(128, 128)); If you no longer need the texture, call texture->drop(). If you want to load a texture, you may want to call imaginable method IDriver::loadTexture. You do this like ITexture* texture = driver->loadTexture("example.jpg"); You will not have to drop the pointer to the loaded texture, because the name of the method does not start with 'create'. The texture is stored somewhere by the driver.
| virtual video::SColor getColor | ( | EGUI_DEFAULT_COLOR | color | ) | [pure virtual] |
Implemented in CGUISkin.
| const c8* getDebugName | ( | ) | const [inline, inherited] |
Returns the debug name of the object. The Debugname may only be set and changed by the object itself. This method should only be used in Debug mode.
| virtual const wchar_t* getDefaultText | ( | EGUI_DEFAULT_TEXT | text | ) | [pure virtual] |
For example for Message box button captions: "OK", "Cancel", "Yes", "No" and so on.
Implemented in CGUISkin.
| virtual s32 getSize | ( | EGUI_DEFAULT_SIZE | size | ) | [pure virtual] |
Implemented in CGUISkin.
| void grab | ( | ) | [inline, inherited] |
Grabs the object. Increments the reference counter by one. Someone who calls grab() to an object, should later also call drop() to it. If an object never gets as much drop() as grab() calls, it will never be destroyed. The IrrUnknown class provides a basic reference counting mechanism with its methods grab() and drop(). Most objects of the Irrlicht Engine are derived from IrrUnknown, and so they are reference counted.
When you create an object in the Irrlicht engine, calling a method which starts with 'create', an object is created, and you get a pointer to the new object. If you no longer need the object, you have to call drop(). This will destroy the object, if grab() was not called in another part of you program, because this part still needs the object. Note, that you only need to call drop() to the object, if you created it, and the method had a 'create' in it.
A simple example:
If you want to create a texture, you may want to call an imaginable method IDriver::createTexture. You call ITexture* texture = driver->createTexture(dimension2d<s32>(128, 128)); If you no longer need the texture, call texture->drop(). If you want to load a texture, you may want to call imaginable method IDriver::loadTexture. You do this like ITexture* texture = driver->loadTexture("example.jpg"); You will not have to drop the pointer to the loaded texture, because the name of the method does not start with 'create'. The texture is stored somewhere by the driver.
| virtual void setColor | ( | EGUI_DEFAULT_COLOR | which, | |
| video::SColor | newColor | |||
| ) | [pure virtual] |
Implemented in CGUISkin.
| void setDebugName | ( | const c8 * | newName | ) | [inline, protected, inherited] |
Sets the debug name of the object. The Debugname may only be set and changed by the object itself. This method should only be used in Debug mode.
| newName,: | New debug name to set. |
| virtual void setDefaultText | ( | EGUI_DEFAULT_TEXT | which, | |
| const wchar_t * | newText | |||
| ) | [pure virtual] |
For example for Message box button captions: "OK", "Cancel", "Yes", "No" and so on.
Implemented in CGUISkin.
| virtual void setSize | ( | EGUI_DEFAULT_SIZE | which, | |
| s32 | size | |||
| ) | [pure virtual] |
Implemented in CGUISkin.
1.5.1-p1