Changeset 8142 in orxonox.OLD for branches/gui/src/lib/gui/gl/glgui_style.h

Timestamp:

Jun 4, 2006, 1:26:04 AM (18 years ago)

Author:

bensch

Message:

gui: nice docu, now implement it

File:

• branches/gui/src/lib/gui/gl/glgui_style.h (modified) (2 diffs)

branches/gui/src/lib/gui/gl/glgui_style.h

@@ -15 +15 @@
 namespace OrxGui
 {
-
   //! A class for Defining Styles to the opengl-gui.
   class GLGuiStyle
@@ -34 +33 @@
   private:
 
-    float             _borderLeft;
-    float             _borderRight;
-    float             _borderTop;
-    float             _borderBottom;
+    float             _borderLeft;           //!< The Distance to the left Border of the widget, before any internal Element starts.
+    float             _borderRight;          //!< The Distance to the right Border of the widget, before any internal Element starts.
+    float             _borderTop;            //!< The Distance to the top Border of the widget, before any internal Element starts
+    float             _borderBottom;         //!< The Distance to the bottom Border of the widget, before any internal Element starts
 
-    Font*             _font;
-    float             _textSize;
-    float             _textColor;
+    Font*             _font;                 //!< The Font used in the current Widget.
+    float             _textSize;             //!< The TextSize of the Widget.
+    float             _textColor;            //!< The TextColor of the Widget.
 
-    float             _backgroundColor;
-    Texture           _backgorundTexture;
+    float             _backgroundColor;      //!< The BackgroundColor of the Widget.
+    Texture           _backgorundTexture;    //!< The BackgroundTexture of the Widget.
 
-    float             _foregroundColor;
-    Texture           _foregorundTexture;
+    float             _foregroundColor;      //!< The foregroundColor of the Widget.
+    Texture           _foregorundTexture;    //!< The ForegroundTexture of the Widget
 
-    bool              _animated;
-    bool              _animatedStateChanges;
+    bool              _animated;             //!< If the Widget is animated (Texture might be an AnimatedTexture.)
+    bool              _animatedStateChanges; //!< If the Transitions between States are Animated automatically.
   };
 }