Commit 41e57a3e authored by hybrid's avatar hybrid

Some doc updates by CuteAlien.

git-svn-id: svn://svn.code.sf.net/p/irrlicht/code/trunk@1030 dfc29bdd-3216-0410-991c-e03cc46cb475
parent 270aff11
...@@ -334,7 +334,7 @@ namespace gui ...@@ -334,7 +334,7 @@ namespace gui
//! sets a default color //! sets a default color
virtual void setColor(EGUI_DEFAULT_COLOR which, video::SColor newColor) = 0; virtual void setColor(EGUI_DEFAULT_COLOR which, video::SColor newColor) = 0;
//! returns default color //! returns size for the given size type
virtual s32 getSize(EGUI_DEFAULT_SIZE size) const = 0; virtual s32 getSize(EGUI_DEFAULT_SIZE size) const = 0;
//! Returns a default text. //! Returns a default text.
......
...@@ -175,7 +175,7 @@ void CGUISkin::setColor(EGUI_DEFAULT_COLOR which, video::SColor newColor) ...@@ -175,7 +175,7 @@ void CGUISkin::setColor(EGUI_DEFAULT_COLOR which, video::SColor newColor)
} }
//! returns default color //! returns size for the given size type
s32 CGUISkin::getSize(EGUI_DEFAULT_SIZE size) const s32 CGUISkin::getSize(EGUI_DEFAULT_SIZE size) const
{ {
if ((u32)size < EGDS_COUNT) if ((u32)size < EGDS_COUNT)
...@@ -185,7 +185,6 @@ s32 CGUISkin::getSize(EGUI_DEFAULT_SIZE size) const ...@@ -185,7 +185,6 @@ s32 CGUISkin::getSize(EGUI_DEFAULT_SIZE size) const
} }
//! sets a default size //! sets a default size
void CGUISkin::setSize(EGUI_DEFAULT_SIZE which, s32 size) void CGUISkin::setSize(EGUI_DEFAULT_SIZE which, s32 size)
{ {
...@@ -281,7 +280,7 @@ It uses the colors EGDC_3D_DARK_SHADOW, EGDC_3D_HIGH_LIGHT, EGDC_3D_SHADOW and ...@@ -281,7 +280,7 @@ 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. EGDC_3D_FACE for this. See EGUI_DEFAULT_COLOR for details.
\param rect: Defining area where to draw. \param rect: Defining area where to draw.
\param clip: Clip area. \param clip: Clip area.
\param element: Pointer to the element which whiches to draw this. This parameter \param element: Pointer to the element which wishes to draw this. This parameter
is usually not used by ISkin, but can be used for example by more complex 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. */ implementations to find out how to draw the part exactly. */
void CGUISkin::draw3DButtonPaneStandard(IGUIElement* element, void CGUISkin::draw3DButtonPaneStandard(IGUIElement* element,
...@@ -337,7 +336,7 @@ It uses the colors EGDC_3D_DARK_SHADOW, EGDC_3D_HIGH_LIGHT, EGDC_3D_SHADOW and ...@@ -337,7 +336,7 @@ 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. EGDC_3D_FACE for this. See EGUI_DEFAULT_COLOR for details.
\param rect: Defining area where to draw. \param rect: Defining area where to draw.
\param clip: Clip area. \param clip: Clip area.
\param element: Pointer to the element which whiches to draw this. This parameter \param element: Pointer to the element which wishes to draw this. This parameter
is usually not used by ISkin, but can be used for example by more complex 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. */ implementations to find out how to draw the part exactly. */
void CGUISkin::draw3DButtonPanePressed(IGUIElement* element, void CGUISkin::draw3DButtonPanePressed(IGUIElement* element,
...@@ -376,7 +375,7 @@ void CGUISkin::draw3DButtonPanePressed(IGUIElement* element, ...@@ -376,7 +375,7 @@ void CGUISkin::draw3DButtonPanePressed(IGUIElement* element,
//! draws a sunken 3d pane //! draws a sunken 3d pane
/** Used for drawing the background of edit, combo or check boxes. /** Used for drawing the background of edit, combo or check boxes.
\param element: Pointer to the element which whiches to draw this. This parameter \param element: Pointer to the element which wishes to draw this. This parameter
is usually not used by ISkin, but can be used for example by more complex 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. implementations to find out how to draw the part exactly.
\param bgcolor: Background color. \param bgcolor: Background color.
...@@ -443,7 +442,7 @@ void CGUISkin::draw3DSunkenPane(IGUIElement* element, video::SColor bgcolor, ...@@ -443,7 +442,7 @@ void CGUISkin::draw3DSunkenPane(IGUIElement* element, video::SColor bgcolor,
//! draws a window background //! draws a window background
/** Used for drawing the background of dialogs and windows. /** Used for drawing the background of dialogs and windows.
\param element: Pointer to the element which whiches to draw this. This parameter \param element: Pointer to the element which wishes to draw this. This parameter
is usually not used by ISkin, but can be used for example by more complex 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. implementations to find out how to draw the part exactly.
\param titleBarColor: Title color. \param titleBarColor: Title color.
...@@ -549,7 +548,7 @@ core::rect<s32> CGUISkin::draw3DWindowBackground(IGUIElement* element, ...@@ -549,7 +548,7 @@ core::rect<s32> CGUISkin::draw3DWindowBackground(IGUIElement* element,
/** Used for drawing for menus and context menus. /** Used for drawing for menus and context menus.
It uses the colors EGDC_3D_DARK_SHADOW, EGDC_3D_HIGH_LIGHT, EGDC_3D_SHADOW and 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. EGDC_3D_FACE for this. See EGUI_DEFAULT_COLOR for details.
\param element: Pointer to the element which whiches to draw this. This parameter \param element: Pointer to the element which wishes to draw this. This parameter
is usually not used by ISkin, but can be used for example by more complex 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. implementations to find out how to draw the part exactly.
\param rect: Defining area where to draw. \param rect: Defining area where to draw.
...@@ -627,7 +626,7 @@ void CGUISkin::draw3DMenuPane(IGUIElement* element, ...@@ -627,7 +626,7 @@ void CGUISkin::draw3DMenuPane(IGUIElement* element,
//! draws a standard 3d tool bar //! draws a standard 3d tool bar
/** Used for drawing for toolbars and menus. /** Used for drawing for toolbars and menus.
\param element: Pointer to the element which whiches to draw this. This parameter \param element: Pointer to the element which wishes to draw this. This parameter
is usually not used by ISkin, but can be used for example by more complex 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. implementations to find out how to draw the part exactly.
\param rect: Defining area where to draw. \param rect: Defining area where to draw.
...@@ -674,7 +673,7 @@ void CGUISkin::draw3DToolBar(IGUIElement* element, ...@@ -674,7 +673,7 @@ void CGUISkin::draw3DToolBar(IGUIElement* element,
//! draws a tab button //! draws a tab button
/** Used for drawing for tab buttons on top of tabs. /** Used for drawing for tab buttons on top of tabs.
\param element: Pointer to the element which whiches to draw this. This parameter \param element: Pointer to the element which wishes to draw this. This parameter
is usually not used by ISkin, but can be used for example by more complex 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. implementations to find out how to draw the part exactly.
\param active: Specifies if the tab is currently active. \param active: Specifies if the tab is currently active.
...@@ -720,7 +719,7 @@ void CGUISkin::draw3DTabButton(IGUIElement* element, bool active, ...@@ -720,7 +719,7 @@ void CGUISkin::draw3DTabButton(IGUIElement* element, bool active,
//! draws a tab control body //! draws a tab control body
/** \param element: Pointer to the element which whiches to draw this. This parameter /** \param element: Pointer to the element which wishes to draw this. This parameter
is usually not used by ISkin, but can be used for example by more complex 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. implementations to find out how to draw the part exactly.
\param border: Specifies if the border should be drawn. \param border: Specifies if the border should be drawn.
......
...@@ -35,7 +35,7 @@ namespace gui ...@@ -35,7 +35,7 @@ namespace gui
//! sets a default color //! sets a default color
virtual void setColor(EGUI_DEFAULT_COLOR which, video::SColor newColor); virtual void setColor(EGUI_DEFAULT_COLOR which, video::SColor newColor);
//! returns default color //! returns size for the given size type
virtual s32 getSize(EGUI_DEFAULT_SIZE size) const; virtual s32 getSize(EGUI_DEFAULT_SIZE size) const;
//! sets a default size //! sets a default size
...@@ -80,7 +80,7 @@ namespace gui ...@@ -80,7 +80,7 @@ namespace gui
EGDC_3D_FACE for this. See EGUI_DEFAULT_COLOR for details. EGDC_3D_FACE for this. See EGUI_DEFAULT_COLOR for details.
\param rect: Defining area where to draw. \param rect: Defining area where to draw.
\param clip: Clip area. \param clip: Clip area.
\param element: Pointer to the element which whiches to draw this. This parameter \param element: Pointer to the element which wishes to draw this. This parameter
is usually not used by ISkin, but can be used for example by more complex 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. */ implementations to find out how to draw the part exactly. */
virtual void draw3DButtonPaneStandard(IGUIElement* element, virtual void draw3DButtonPaneStandard(IGUIElement* element,
...@@ -93,7 +93,7 @@ namespace gui ...@@ -93,7 +93,7 @@ namespace gui
EGDC_3D_FACE for this. See EGUI_DEFAULT_COLOR for details. EGDC_3D_FACE for this. See EGUI_DEFAULT_COLOR for details.
\param rect: Defining area where to draw. \param rect: Defining area where to draw.
\param clip: Clip area. \param clip: Clip area.
\param element: Pointer to the element which whiches to draw this. This parameter \param element: Pointer to the element which wishes to draw this. This parameter
is usually not used by ISkin, but can be used for example by more complex 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. */ implementations to find out how to draw the part exactly. */
virtual void draw3DButtonPanePressed(IGUIElement* element, virtual void draw3DButtonPanePressed(IGUIElement* element,
...@@ -102,7 +102,7 @@ namespace gui ...@@ -102,7 +102,7 @@ namespace gui
//! draws a sunken 3d pane //! draws a sunken 3d pane
/** Used for drawing the background of edit, combo or check boxes. /** Used for drawing the background of edit, combo or check boxes.
\param element: Pointer to the element which whiches to draw this. This parameter \param element: Pointer to the element which wishes to draw this. This parameter
is usually not used by ISkin, but can be used for example by more complex 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. implementations to find out how to draw the part exactly.
\param bgcolor: Background color. \param bgcolor: Background color.
...@@ -118,7 +118,7 @@ namespace gui ...@@ -118,7 +118,7 @@ namespace gui
//! draws a window background //! draws a window background
/** Used for drawing the background of dialogs and windows. /** Used for drawing the background of dialogs and windows.
\param element: Pointer to the element which whiches to draw this. This parameter \param element: Pointer to the element which wishes to draw this. This parameter
is usually not used by ISkin, but can be used for example by more complex 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. implementations to find out how to draw the part exactly.
\param titleBarColor: Title color. \param titleBarColor: Title color.
...@@ -135,7 +135,7 @@ namespace gui ...@@ -135,7 +135,7 @@ namespace gui
/** Used for drawing for menus and context menus. /** Used for drawing for menus and context menus.
It uses the colors EGDC_3D_DARK_SHADOW, EGDC_3D_HIGH_LIGHT, EGDC_3D_SHADOW and 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. EGDC_3D_FACE for this. See EGUI_DEFAULT_COLOR for details.
\param element: Pointer to the element which whishes to draw this. This parameter \param element: Pointer to the element which wishes to draw this. This parameter
is usually not used by ISkin, but can be used for example by more complex 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. implementations to find out how to draw the part exactly.
\param rect: Defining area where to draw. \param rect: Defining area where to draw.
...@@ -146,7 +146,7 @@ namespace gui ...@@ -146,7 +146,7 @@ namespace gui
//! draws a standard 3d tool bar //! draws a standard 3d tool bar
/** Used for drawing for toolbars and menus. /** Used for drawing for toolbars and menus.
\param element: Pointer to the element which whiches to draw this. This parameter \param element: Pointer to the element which wishes to draw this. This parameter
is usually not used by ISkin, but can be used for example by more complex 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. implementations to find out how to draw the part exactly.
\param rect: Defining area where to draw. \param rect: Defining area where to draw.
...@@ -157,7 +157,7 @@ namespace gui ...@@ -157,7 +157,7 @@ namespace gui
//! draws a tab button //! draws a tab button
/** Used for drawing for tab buttons on top of tabs. /** Used for drawing for tab buttons on top of tabs.
\param element: Pointer to the element which whiches to draw this. This parameter \param element: Pointer to the element which wishes to draw this. This parameter
is usually not used by ISkin, but can be used for example by more complex 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. implementations to find out how to draw the part exactly.
\param active: Specifies if the tab is currently active. \param active: Specifies if the tab is currently active.
...@@ -168,7 +168,7 @@ namespace gui ...@@ -168,7 +168,7 @@ namespace gui
const core::rect<s32>* clip=0); const core::rect<s32>* clip=0);
//! draws a tab control body //! draws a tab control body
/** \param element: Pointer to the element which whiches to draw this. This parameter /** \param element: Pointer to the element which wishes to draw this. This parameter
is usually not used by ISkin, but can be used for example by more complex 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. implementations to find out how to draw the part exactly.
\param border: Specifies if the border should be drawn. \param border: Specifies if the border should be drawn.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment