Changeset 2588 in orxonox.OLD

Timestamp:

Oct 17, 2004, 5:18:58 PM (20 years ago)

Author:

bensch

Message:

orxonox/trunk/gui: doxygen orxodox created for all h-files, classes and functions.

Location:

orxonox/trunk/gui

Files:

• orxonox_gui.cc (modified) (38 diffs)
• orxonox_gui.h (modified) (15 diffs)
• orxonox_gui_audio.cc (modified) (2 diffs)
• orxonox_gui_audio.h (modified) (2 diffs)
• orxonox_gui_banner.cc (modified) (5 diffs)
• orxonox_gui_banner.h (modified) (4 diffs)
• orxonox_gui_exec.cc (modified) (9 diffs)
• orxonox_gui_exec.h (modified) (2 diffs)
• orxonox_gui_flags.cc (modified) (5 diffs)
• orxonox_gui_flags.h (modified) (2 diffs)
• orxonox_gui_video.cc (modified) (2 diffs)
• orxonox_gui_video.h (modified) (2 diffs)

orxonox/trunk/gui/orxonox_gui.cc

@@ -48 +48 @@
 /* ORXONOXGUI */
 
+/**
+ * Initializes the Gui
+*/
 OrxonoxGui::OrxonoxGui (int argc, char *argv[])
 {
-  /**
-   * Initializes the Gui
-   */
   gtk_init (&argc, &argv);
   gtk_rc_parse( "rc" );
@@ -99 +99 @@
 
 /* WIDGET */
-
+/**
+ * Initializes a widget.
+ * Nothing to do here.
+ */
 void Widget::init()
 {
@@ -105 +108 @@
 }
 
+/** 
+ * Connect any signal to any given Sub-widget
+ */
 void Widget::connectSignal (char* event, gint (*signal)(GtkWidget*, GdkEvent*, void *))
 {
-  /** 
-   * Connect any signal to any given Sub-widget
-   */
   g_signal_connect (G_OBJECT (this->widget), event, G_CALLBACK (signal), NULL);
 }
 
+/**
+ * Connect a signal with additionally passing the whole Object
+ */
 void Widget::connectSignal (char* event, gint (*signal)( GtkWidget*, Widget *))
 {
-  /**
-   * Connect a signal with additionally passing the whole Object
-   */
 g_signal_connect (G_OBJECT (this->widget), event, G_CALLBACK (signal), this);
 }
 
+/**
+ * Connect a signal with additionally passing a whole external Object
+ */
 void Widget::connectSignal (char* event, void* extObj, gint (*signal)(GtkWidget*, GdkEvent*, void *))
 {
-  /**
-   * Connect a signal with additionally passing a whole external Object
-   */
   g_signal_connect (G_OBJECT (this->widget), event, G_CALLBACK (signal), extObj);
 }
+
+
+/**
+ * Function to Shows a specific widget.
+ */
 void Widget::show()
 {
-  /**
-   * Function to Show any Widget
-   */
-  gtk_widget_show (widget);
-}
-
+  gtk_widget_show (this->widget);
+}
+
+/**
+ * Moves through all the Widgets downwards from this and executes the function on them.
+ \param function must be of type void and takes a Widget* as an Input.
+
+ */
 void Widget::walkThrough (void (*function)(Widget*))
 {
-  /**
-   * Moves Through all the Widgets downwards from this and executes the function on them.
-   * function must be of type void and takes a Widget* as an Input.
-   */
   function(this);
   switch (this->is_option)
@@ -158 +164 @@
 
 
+/** 
+ * This is for listing the option of "widget"
+ \param widget specifies the widget that should be listed
+*/
 void Widget::listOptions (Widget* widget)
 {
-  /** 
-   * This is for listing the option of "widget"
-   */
   if (widget->is_option >= 1)
     cout << static_cast<Option*>(widget)->option_name <<" is : " << static_cast<Option*>(widget)->value <<endl;
 }
 
+/** 
+ * This is for setting the option of "widget"
+ \param widget specifies the widget that should be set.
+*/
 void Widget::setOptions (Widget* widget)
 {
-  /** 
-   * This is for setting the option of "widget"
-   */
   if (widget->is_option >= 1)
     static_cast<Option*>(widget)->redraw();// <<" is : " << static_cast<Option*>(this)->value <<endl;
@@ -177 +185 @@
 
 /* CONTAINERS*/
+
+/**
+ * Initializes a Container.
+ * nothing to do here
+ */
 void Container::init (void)
 {
   return;
 }
+
+/**
+ * Fills a Container with lowerWidget.
+ * It does this by filling up the down pointer only if down points to NULL.
+ \param lowerWidget the Widget that should be filled into the Container.
+*/
 void Container::fill (Widget *lowerWidget)
 {
-  /**
-   * fills any given Container with a lowerwidet
-   */
   if (this->down == NULL)
     {
@@ -199 +215 @@
 /* WINDOW */
 
+  /**
+   * Creating a new Window without a Name
+   */
 Window::Window (void)
 {
-  /**
-   * Creating a Window
-   */
-  this->init();
-}
-
+  this->init();
+}
+
+/**
+ * Creating a Window with a name
+ \param windowName the name the window should get.
+ */
 Window::Window (char* windowName)
 {
-  /**
-   * Creating a Window with passing a name
-   */
   this->init();
   this->setTitle (windowName);
 }
 
+/**
+ * Destoying a Window (very BAD implemented).
+ * For now it just hides the window.
+ */
 Window::~Window ()
 {
-  /**
-   * Destoying a Window (very BAD implemented)
-   */
   gtk_widget_hide (widget);
-  
-}
-
+}
+
+/**
+ *initializes a new Window
+ */
 void Window::init()
 {
-  /**
-  *initializes a new Window
-  */
   is_option = -1;
   next = NULL;
@@ -241 +258 @@
 }
 
+/**
+ * Shows all Widgets that are included within this->widget.
+ */
 void Window::showall ()
 {
-  /**
-   * Shows all Widgets that are included within this Widget
-   */
   gtk_widget_show_all  (widget);
 }
 
+/**
+ * Set The Window-title to title
+ \param title title the Window should get.
+*/
 void Window::setTitle (char* title)
 {
-  /**
-   * Set The Window title to title
-   */
   gtk_window_set_title (GTK_WINDOW (widget), title);
 }
 
-
+/**
+ * Quits the orxonox_GUI.
+ * This can be called as a Signal and is therefor static
+ \param widget The widget that called this function
+ \param event the event that happened to execute this function
+ \param data some data passed with the Signal
+ */
 gint Window::orxonox_gui_quit (GtkWidget *widget, GdkEvent *event, gpointer data)
 {
-  /**
-   * Quits the orxonox_GUI
-   */
   if (exec->shouldsave())
     exec->writeToFile (orxonoxGUI);
@@ -273 +294 @@
 /* FRAME */
 
+/** 
+ * Creates a new Frame without a name
+ */
 Frame::Frame (void)
 {
-  /** 
-   * Creates a new Frame without a name
-   */
-  this->init();
-}
+  this->init();
+}
+
+/**
+ * Creates a new Frame with name title
+ */
 Frame::Frame (char* title)
 {
-  /**
-   * Creates a new Frame with name title
-   */
   this->init();
   this->setTitle(title);
 }
+
+/**
+ * Destroys given Frame (not implemented yet)
+ */
 Frame::~Frame ()
 {
-  /**
-   * Destroys given Frame (not implemented yet)
-   */
-}
-
+}
+
+/** 
+ * Initializes a new Frame with default settings
+ */
 void Frame::init()
 {
@@ -304 +330 @@
 }
 
+/**
+ * Sets the Frames name to title
+ \param title The title the Frame should get.
+ */
 void Frame::setTitle (char* title)
 {
-  /**
-   * Sets the Frames name to title
-   */
   gtk_frame_set_label (GTK_FRAME (widget), title);
 }
 
 // EVENTBOX //
+
+/**
+ * Creates a new EventBox with default settings.
+ */
 EventBox::EventBox ()
 {
   this->init();
 }
-
+/**
+ * Creates a new EventBox with name title
+ \param title title the Eventbox should get (only data-structure-internal)
+*/
 EventBox::EventBox (char* title)
 {
-  /**
-   * Creates a new EventBox with name title
-   */
   this->init();
   this->setTitle(title);
 
 }
+
+/**
+ * Initializes a new EventBox
+ */
 void EventBox::init(void)
 {
@@ -337 +372 @@
 }
 
-
+/**
+ * Sets the Title of the EventBox (not implemented)
+ \param title Name the EventBox should get (only datastructure-internal).
+*/
 void EventBox::setTitle (char* title)
 {
-  /**
-   * Sets the EventBoxes name to title
-   */
-  //  gtk_frame_set_label (GTK_FRAME (widget), title);
-}
+
+}
+
+/**
+ * Destructs an EventBox (not Implemented)
+ */
 EventBox::~EventBox ()
 {
@@ -352 +391 @@
 /* BOX */
 
+/**
+ * Creates a new horizontal Box
+ */
 Box::Box (void)
 {
-  /**
-   * Creates a new horizontal Box
-   */
   this->init('h');
 }
+
+/**
+ * Creates a new Box of type boxtype
+ \param boxtype if 'v' the Box will be vertically, if 'h' the Box will be horizontally
+ */
 Box::Box (char boxtype)
 {
-  /**
-   * Creates a new Box if boxtype is 'v' it will be vertically, if 'h' it will be horizontally
-   */
   this->init(boxtype);
 }
+
+/**
+ * Destroys given Box (not implemented yet)
+ */
 Box::~Box ()
 {
-  /**
-   * Destroys given Frame (not implemented yet)
-   */
-}
-
+}
+
+/**
+ * Initializes a new Box with type boxtype
+ \param boxtype see Box(char boxtype)
+*/
 void Box::init(char boxtype)
 {
@@ -388 +434 @@
 }
 
-
+/** 
+ * Fills a box with a given Widget.
+ * It does this by apending the first one to its down-pointer and all its following ones to the preceding next-pointer. The last one will receive a NULL pointer as Next
+ \param lowerWidget the next Widget that should be appendet to this Box
+ */
 void Box::fill (Widget *lowerWidget)
 {
@@ -411 +461 @@
 /* IMAGE */
 
+/**
+ * Creates a new Image
+ \param imagename the location of the Image on the Hard Disc
+*/
 Image::Image (char* imagename)
 {
+  this->init();
+  widget = gtk_image_new_from_file (imagename);
+}
+
+/** 
+ * Initializes a new Image
+ */
+void Image::init()
+{
   is_option = 0;
   next = NULL;
-  widget = gtk_image_new_from_file (imagename);
-}
-void Image::init()
-{
-  
 }
 
 
 /* OPTION */
+
+/**
+ * Initializes a new Option: nothing to do here
+ */
 void Option::init()
 {
   return;
 }
+
+/**
+ * This sets The FlagName of an Option and defines its default Values
+ !! Options will be saved if flagname is different from "" !!
+\param flagname the Name that will be displayed in the output
+\param defaultvalue the default Value for this Option (see definition of defaultvalue
+*/
 void Option::setFlagName (char* flagname, int defaultvalue)
 {
@@ -435 +504 @@
 }
 
+/** 
+ * see Option::setFlagName (char* flagname, int defaultvalue)
+ \param flagname the Name that will be displayed in the output
+ \param defaultvalue the default Value for this Option (see definition of defaultvalue
+ \param flagnameshort a short flagname to be displayed in the output
+*/
 void Option::setFlagName (char* flagname, char* flagnameshort,  int defaultvalue)
 {
-  /**
-   * \brief Sets the Flagname of an Option. If it is set different then "" this Option will be saved to the Configurationfile
-   */
   flag_name = flagname;
   flag_name_short = flagnameshort;
@@ -448 +520 @@
 
 /* BUTTON */
+
+/**
+ * Creates a new Button with a buttonname
+ \param buttonname sets the Name of the Button
+*/
 Button::Button(char* buttonname)
 {
-  /**
-   * Creates a new Button with name buttonname
-   */
   this->init();
   this->setTitle(buttonname);
 }
 
+/**
+ * Initializes a new Button
+ */
 void Button::init(void)
 {
@@ -469 +546 @@
 }
 
+/**
+ * Sets a new name to the Button
+\param title The name the Button should get
+*/
 void Button::setTitle (char *title)
 {
@@ -475 +556 @@
 }
 
+/**
+ * redraws the Button
+ * not implemented yet
+ */
 void Button::redraw ()
 {
@@ -480 +565 @@
 
 /* CHECKBUTTON */
+
+/**
+ * Creates a new CheckButton with an ame 
+ \param buttonname The name the CheckButton should display.
+ */
 CheckButton::CheckButton (char* buttonname)
 {
-  /**
-   * Creates a new CheckButton with name buttonname
-   */
   this->init();
   this->setTitle(buttonname);
@@ -490 +577 @@
   this->connectSignal ("clicked", this->OptionChange);
 }
+
+/** 
+ * Destructs a CheckButton (not Implemented yet).
+ */
 CheckButton::~CheckButton()
 {
 }
 
+/**
+ * Initiali a new CheckButton with default settings
+ */
 void CheckButton::init(void)
 {
@@ -505 +599 @@
   widget = gtk_check_button_new_with_label ("");
 }
+
+/**
+ * Sets a new Title to a CheckButton
+ \param title The new Name the CheckButton should display.
+*/
 void CheckButton::setTitle(char* title)
 {
@@ -511 +610 @@
 }
 
+
+/** 
+ * Signal OptionChange writes the Value from the CheckButton to its Object-Database.
+ \param widget The widget(CheckButton) that has a changed Value
+ \param checkbutton the CheckButton-Object that should receive the change.
+ */
 gint CheckButton::OptionChange (GtkWidget *widget, Widget* checkbutton)
 {
-  /** 
-   * Writes value, if changed on the checkbutton, to the object.
-   */
   static_cast<CheckButton*>(checkbutton)->value = (int)gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON ((CheckButton*)checkbutton->widget));
   flags->setTextFromFlags(orxonoxGUI);
@@ -521 +623 @@
 }
 
+/**
+ * Redraws the CheckButton (if option has changed).
+ * Example: if new settings are loaded the Button must be redrawn for the GUI to display that Change
+ */
 void CheckButton::redraw ()
 {
@@ -527 +633 @@
 
 /* SLIDER */
+
+/**
+ * Creates a new Slider
+ \param slidername The data-structure-name of the slider.
+ \param start The minimal Value of the slider.
+ \param end The maximal Value of the slider.
+*/
 Slider::Slider (char* slidername, int start, int end)
 {
-  /**
-   * Creates a new Slider with name slidername a beginning value of start and an end value of end.
-   */
   this->init(start, end);
   this->setValue(start);
@@ -538 +648 @@
 }
 
+/**
+ * Destructs a Slider (not implemented yet)
+ */
 Slider::~Slider()
 {
 }
 
+/**
+ * Initializes a Slider with start and end Values
+ * params: see Slider::Slider (char* slidername, int start, int end)
+ */
 void Slider::init(int start, int end)
 {
@@ -553 +670 @@
   widget = gtk_hscale_new_with_range (start, end, 5);
 }
+
+/**
+ * Sets a new Title to the Slider
+ \param title The new Name of the slider
+*/
 void Slider::setTitle(char* title)
 {
   option_name = title;
 }
+
+/**
+ * Setting a new value to the Slider.
+ * Maybe you also require a Slider::redraw() for this to display
+ */
 void Slider::setValue(int value)
 {
@@ -562 +689 @@
 }
 
+/** 
+ * Signal OptionChange writes the Value from the Slider to its Object-Database.
+ \param widget The widget(Slider) that has a changed Value
+ \param slider the Slider-Object that should receive the change.
+ */
 gint Slider::OptionChange (GtkWidget *widget, Widget* slider)
 {
-  /** 
-   * Writes value, if changed on the slider, to the object.
-   */
   static_cast<Slider*>(slider)->value = (int)gtk_range_get_value (GTK_RANGE ((Slider*)slider->widget));
   flags->setTextFromFlags(orxonoxGUI);
@@ -572 +701 @@
 }
 
+/**
+ * Redraws the widget
+ * Example: see void CheckButton::redraw ()
+ */
 void Slider::redraw ()
 {
@@ -577 +710 @@
 }
 
+/* MENU */
+
+/** 
+ * Creates a Menu-Item-list out of multiple input.
+ * !! Consider, that the last input argument has to be "lastItem" for this to work!!
+ \param menuname The Database-Name of this Menu
+ \param ... items to be added to this Menu. !! Consider, that the last input argument has to be "lastItem" for this to work!!
+ */
 Menu::Menu (char* menuname, ...)
 {
-  /** 
-   * Creates an Menu-Item-list out of multiple input. Consider, that the last input argument has to be "lastItem" for this to work.
-   */
   this->init();
   this->setTitle(menuname);
@@ -598 +736 @@
 }
 
+/**
+ * Initializes a new Menu with no items
+ */
 void Menu::init(void)
 {
@@ -611 +752 @@
 }
 
+/**
+ * Sets the Database-Name of this Menu
+ \param title Database-Name to be set.
+*/
 void Menu::setTitle(char* title)
 {
@@ -616 +761 @@
 }
 
+/**
+ * appends a new Item to the Menu-List.
+ \param itemName the itemName to be appendet.
+*/
 void Menu::addItem (char* itemName)
 {
@@ -622 +771 @@
 }
 
-gint Menu::OptionChange (GtkWidget *widget, Widget* menu)
-{
-  /** 
-   * Writes value, if changed on the Menu, to the object.
-   */
+/** 
+ * Signal OptionChange writes the Value from the Menu to its Object-Database.
+ \param widget The widget(Menu) that has a changed Value
+ \param menu the Menu-Object that should receive the change.
+ */gint Menu::OptionChange (GtkWidget *widget, Widget* menu)
+{
   static_cast<Menu*>(menu)->value = (int)gtk_option_menu_get_history (GTK_OPTION_MENU (menu->widget));
   flags->setTextFromFlags(orxonoxGUI);
@@ -632 +782 @@
 }
 
+/**
+ * Redraws the widget
+ * Example: see void CheckButton::redraw ()
+ */
 void Menu::redraw ()
 {
@@ -637 +791 @@
 }
 
+/**
+ * Creates a new default Label with no Text.
+ * You migth consider adding Label::setTitle with this.
+ */
 Label:: Label ()
 {
@@ -642 +800 @@
 }
 
+/**
+ * Creates a new Label with a Text.
+ \param text The text to be displayed.
+*/
 Label:: Label (char* text)
 {
@@ -650 +812 @@
 }
 
+/** 
+ * Destructs a Label
+ */
 Label::~Label ()
 {}
 
+/**
+ * initializes a new Label
+ */
 void Label::init(void)
 {
@@ -661 +829 @@
   gtk_label_set_line_wrap (GTK_LABEL(widget), TRUE);
 }
-  
+
+/**
+ * Sets a new Text to a Label.
+ \param text The text to be inserted into the Label.
+ */
 void Label::setText (char * text)
 {
@@ -667 +839 @@
 }
 
+/**
+ * get the Text of a Label
+ \return The Text the Label holds.
+*/
 char* Label::getText ()
 {

orxonox/trunk/gui/orxonox_gui.h

@@ +1 @@
+/*!
+ \file orxonox_gui.h
+ \brief Contains all Widgets and the Creation of the Gui
+*/
+
 #ifndef _ORXONOX_GUI_H
 #define _ORXONOX_GUI_H
@@ -19 +24 @@
 #include <gtk/gtkeventbox.h>
 
+//! Class that creates the OrxonoxGui
 class OrxonoxGui
 {
@@ -27 +33 @@
 };
 
+//! This is the topmost object that can be displayed all others are derived from it.
+
 class Widget
 {
  private:
  public:
-  Widget* next;
-  GtkWidget* widget;
+  Widget* next; //!< next always points to the next Widget in the list. Every Widget has a next one, or has NULL as next
+  GtkWidget* widget; //!< widget is the gtk_widget that the specific Object Contains.
   virtual void init(void);
-  int is_option;
+  int is_option; //!< with this Paramenter one can set the IsOption type: -2:Container, -1: Box, 0: not an Option, 1: Bool-option, 2: int-option
 
   void connectSignal (char* event, gint (*signal)(GtkWidget*, GdkEvent*, void *));
@@ -48 +56 @@
 
 
-
+//! This is a Container Class, it can contain one sub-Widget: down.
+/**
+ * A Container is a Widget that can hold a subWidget in addition to a next-Widget.
+ * The Container can by itself not be displayed created or used.
+ * The derived classes of Container can be displayed
+*/
 class Container : public Widget
 {
@@ -58 +71 @@
  public:
   void init(void);
-  Widget* down;
-  void setBorderWidth (int borderwidth);
-  virtual void setTitle (char* title) = 0;
+  Widget* down; //!< this points to the Widget below this.
+  //  void setBorderWidth (int borderwidth);
+  //  virtual void setTitle (char* title) = 0;
   void fill (Widget *lowerWidget);
 };
 
+//! Window is the class that creates new Windows, and handels them
+/**
+ * A Window is a class derived from Container that contains a window-widget.
+ * It has the ability to hold one sub-object
+ */
 class Window : public Container
 {
@@ -73 +91 @@
   
   void setTitle (char* title);
-  void showall ();
+  void showall (); 
   static gint orxonox_gui_quit (GtkWidget *widget, GdkEvent *event, gpointer data);
 };
 
+//! Frame is the class that handles frames
+/**
+ * A Frame is an object, that has a border and if you like a name on it.
+ * It can contain a Widget, which means that you can insert anything you like inside of a frame
+ */
 class Frame :public Container
 {
@@ -88 +111 @@
 };
 
+//! EventBox is a Container that can Handle all Events happening inside of it.
+/**
+ * Example: if you have a picture, and you want it to catch mouse-clicks, you have to pack it inside a EventBox
+ */
 class EventBox : public Container
 {
@@ -99 +126 @@
 };
 
+//! A Box can contain multiple Widgets
+/**
+ * A Box can Contain multiple Widgets, that are ordered either horizontally or vertically
+ * I defined the standartbox to be horizontally.
+ * A Box is always filled left->right (horizontally) or up->down (vertically)
+ */
 class Box : public Widget
 {
@@ -107 +140 @@
   void init(char boxtype);
 
-  Widget* down;
+  Widget* down; //!< the Lower Widget of a Box.
   void fill (Widget* lowerWidget);
 
 };
 
+//! Image is the keeper of one Image 
+/** 
+ * Images are mighty cool.
+ * Images can help you lighten up the Programming process, and will give everyone a better impression of the Software.
+ */
 class Image : public Widget
 {
@@ -120 +158 @@
 };
 
+//! An Option is a Widget that contains something that may change its state.
+/**
+ * Options are the essence of a GUI, they: Configure, Start, Quit, Execute, and make it worth something
+ */
 class Option : public Widget
 {
@@ -126 +168 @@
   void init(void);
 
-  int value;
-  char* option_name;
-  char* flag_name;
-  char* flag_name_short;
-  int default_value;
+  int value; //!< every option has a value either true or false (0,1) or something else like 25 for 25% of the volume
+  char* option_name; //!< options have a name, that can be displayed around them
+  char* flag_name; //!< options have a flag name that will be appendet if you start the Program from the GUI.
+  char* flag_name_short; //!< like flag_name but shorter
+  int default_value; //!< A default value is good, for hiding a option if it is not needed. (hidden if value == default_value)
 
   void setFlagName (char* flagname, int defaultvalue);
   void setFlagName (char* flagname, char* flagnameshort, int defaultvalue);
-  virtual void redraw () = 0;
-};
-
+  virtual void redraw () = 0; //!< A Option must be able to redraw itself.
+};
+
+//! Buttons can be pressed, and released.
+/**
+ * Buttons are mainly there for executing some action like Starting the Programm, or Quiting it.
+ */
 class Button : public Option 
 {
@@ -149 +195 @@
 };
 
+//! CheckButtons are a key in configuring bool Variables
+/** CheckButtons can configure bool Variables like wireframe on/off, enable_sound etc.
+ */
 class CheckButton : public Option
 {
@@ -162 +211 @@
 };
 
+//! Sliders are Options that can be modified in their value
+/**
+ * good for volume, brightness, etc.
+ */
 class Slider : public Option
 {
@@ -176 +229 @@
 };
 
+//! A Menu is an Option that has a dropdown menu, where you can chose between different Items
 class Menu : public Option
 {
@@ -195 +249 @@
 };
 
+//! A label is a Widget, that displays a text
 class Label : public Widget
 {

orxonox/trunk/gui/orxonox_gui_audio.cc

@@ -26 +26 @@
 #include "orxonox_gui_audio.h"
 
+/**
+   \brief Creates an Audio-Frame
+*/
 OrxonoxGuiAudio::OrxonoxGuiAudio ()
 {
@@ -48 +51 @@
 }
 
+/**
+   \brief Return the Frame
+   \return Returns the Audio-frame
+*/
 Frame* OrxonoxGuiAudio::getFrame ()
 {

orxonox/trunk/gui/orxonox_gui_audio.h

@@ +1 @@
+/*!
+  \file orxonox_gui_audio.h
+  \brief File that holds the class that creates the Audio-Options.
+*/
+
 #ifndef _ORXONOX_GUI_AUDIO_H
 #define _ORXONOX_GUI_AUDIO_H
@@ -4 +9 @@
 #include "orxonox_gui.h"
 
+//! Class that creates the Audio-Options.
 class OrxonoxGuiAudio
 {

orxonox/trunk/gui/orxonox_gui_banner.cc

@@ -27 +27 @@
 #include <iostream.h>
 
+/**
+   \brief Creates a new BannerEventBox and its content.
+*/
 OrxonoxGuiBanner::OrxonoxGuiBanner ()
 {
@@ -36 +39 @@
 }
 
+/**
+   \brief Destructs it.
+*/
 OrxonoxGuiBanner::~OrxonoxGuiBanner ()
 {
 }
 
+/** 
+    \brief Opens up our LOGO-Window.\n
+    it creates a new one if it has not yet been opened.\n
+    it shows it if it has been created
+*/
 void OrxonoxGuiBanner::logoWindowNew()
 {
@@ -65 +76 @@
     }
 }
+
+/**
+   \brief Hides Window through ~Window();
+*/
 void OrxonoxGuiBanner::logoWindowClose()
 {
@@ -71 +86 @@
 }
 
-
-
+/**
+   \brief Returns an EventBox
+   \return The EventBox, that holds the Banner.
+*/
 EventBox* OrxonoxGuiBanner::getEventBox ()
 {
@@ -78 +95 @@
 }
 
+/**
+   \brief opens up the banner-window.\n
+   this is the Signal that does it. !!SIGNALS ARE STATIC!!
+   \param widget the widget that did it!
+   \param event the event that did it!
+   \param banner the Object that holds the banner-logo-window
+*/
 gint LogoWindowOpen (GtkWidget* widget, GdkEvent* event, void* banner)
 {
-  //cout << data->is_option<<"\n";
   static_cast<OrxonoxGuiBanner*>(banner)->logoWindowNew();
 }
 
+/**
+   \brief closes the banner-window.\n
+   this is the Signal that does it. !!SIGNALS ARE STATIC!!
+   \param widget the widget that did it!
+   \param event the event that did it!
+   \param banner the Object that holds the banner-logo-window
+*/
 gint LogoWindowClose (GtkWidget *widget, GdkEvent* event, void* banner)
 {

orxonox/trunk/gui/orxonox_gui_banner.h

@@ +1 @@
+/*!
+  \file orxonox_gui_banner.h
+  \brief  File that holds the class that creates the Banner-Image.\n
+  This is Commercial :-)
+*/
+
 #ifndef _ORXONOX_GUI_BANNER_H
 #define _ORXONOX_GUI_BANNER_H
@@ -4 +10 @@
 #include "orxonox_gui.h"
 
+//! Class that creates the Banner-Image
 class OrxonoxGuiBanner
 {
@@ -9 +16 @@
   Frame* bannerFrame;
   Box* bannerBox;
-  EventBox* bannerEventBox;
+  EventBox* bannerEventBox; //!< an Image needs an EventBox to catch klicks
   Image* bannerImage;
   Label* bannerLabel;
@@ -25 +32 @@
   EventBox* getEventBox ();
 };
+
 gint LogoWindowOpen (GtkWidget *widget, GdkEvent* event, void* banner);
 gint LogoWindowClose (GtkWidget *widget, GdkEvent* event, void* banner);

orxonox/trunk/gui/orxonox_gui_exec.cc

@@ -28 +28 @@
 #include <string>
 
+/** 
+    \brief Creates the Exec-Frame
+    \param orxonoxGUI ExecFrame needs to know where to get the Options from
+*/
 OrxonoxGuiExec::OrxonoxGuiExec (Window* orxonoxGUI)
 {
@@ -54 +58 @@
 }
 
+/**
+   \brief Return the Frame
+   \return Returns the Exec-frame
+*/
 Frame* OrxonoxGuiExec::getFrame ()
 {
@@ -61 +69 @@
 /* FILE HANDLING */
 
+/**
+   \brief Sets the location of the configuration File.\n
+   * The name will be parsed from ~/ to /home/[username] on unix and c:/Documents and Settings/username/Settings/ on Windows
+   \param filename the location of the configFile
+*/
 void OrxonoxGuiExec::setFilename (char* filename)
 {
@@ -78 +91 @@
 }
 
+/**
+   \brief checks if a option should be saved.
+   \return 1 if it should 0 if not/
+*/
 int OrxonoxGuiExec::shouldsave ()
 {
@@ -83 +100 @@
 }
 
+/** 
+    \brief Saves the configuration-file to the Disk.\n
+    this Function only opens and closes the file, in between OrxonoxGuiExec::writeFileText (Widget* widget) will execute the real writing process.
+    \param widget from which Widget on should be saved.
+*/
 void OrxonoxGuiExec::writeToFile (Widget* widget)
 {
@@ -91 +113 @@
 }
 
+/**
+   \brief Actually writes into the configuration file to the disk.
+   \param widget from which Widget on should be saved.
+*/
 void OrxonoxGuiExec::writeFileText (Widget* widget)
 {
@@ -121 +147 @@
 }
 
+/**
+   \brief Reads in Configuration Data.
+   \param widget from which Widget on should be saved.
+*/
 void OrxonoxGuiExec::readFromFile (Widget* widget)
 {
@@ -150 +180 @@
 }
 
+/**
+   \brief Maps Confugurations to the Options.
+   \param widget which widget downwards
+   \param variableName the name of the Variable that should be set up.
+   \param variableValue the Value of the Variable that should be set up
+*/
 void OrxonoxGuiExec::readFileText (Widget* widget, char* variableName, int variableValue)
 {
@@ -170 +206 @@
 }
 
-
+/**
+   \brief Starts ORXONOX. (not really implemented yet, but the function is there.\n
+   This is a Signal and can be executed through Widget::signal_connect
+   \param widget the widget that executed the start command
+   \param data additional data
+*/
 gint startOrxonox (GtkWidget *widget, Widget* data)
 {
-  /** 
-   * Starts Orxonox.
-   */
   cout << "Starting Orxonox" <<endl;
 }

orxonox/trunk/gui/orxonox_gui_exec.h

@@ +1 @@
+/*!
+  \file orxonox_gui_exec.h
+  \brief File that holds the class that creates the execute-Options.
+*/
+
 #ifndef _ORXONOX_GUI_EXEC_H
 #define _ORXONOX_GUI_EXEC_H
@@ -6 +11 @@
 using namespace std;
 
+//! Class that creates the execute-Options.
 class OrxonoxGuiExec
 {

orxonox/trunk/gui/orxonox_gui_flags.cc

@@ -27 +27 @@
 #include <iostream.h>
 
-
+/**
+   \brief Creates the Flags-Frame
+   \param widget The Widget from which the data will be parsed
+*/
 OrxonoxGuiFlags::OrxonoxGuiFlags (Widget* widget)
 {
@@ -43 +46 @@
 }
 
+/**
+   \brief Function to return the Frame that holds the Flagtext.
+   \returns Frame that holds the Flagtext.
+*/
 Frame* OrxonoxGuiFlags::getFrame ()
 {
@@ -48 +55 @@
 }
 
+/**
+   \brief Sets the Flags from widget downwards.
+   \param widget the Widget from which on to scan for deeper Options and their settings.
+*/
 void OrxonoxGuiFlags::setTextFromFlags (Widget* widget)
 {
@@ -56 +67 @@
 }
 
+/** 
+    \brief this actually sets the flagtext, and appends it to flagText
+    \param widget like OrxonoxGuiFlags::setTextFromFlags(widget)
+*/
 void OrxonoxGuiFlags::FlagsText(Widget* widget)
 {
@@ -89 +104 @@
     FlagsText (widget->next);
 }
-
-

orxonox/trunk/gui/orxonox_gui_flags.h

@@ +1 @@
+/*!
+  \file orxonox_gui_flags.h
+  \brief File that holds the class that creates the flags-Text.
+*/
+
 #ifndef _ORXONOX_GUI_FLAGS_H
 #define _ORXONOX_GUI_FLAGS_H
@@ -4 +9 @@
 #include "orxonox_gui.h"
 
+//! Class that creates the flags-Text.
 class OrxonoxGuiFlags
 {

orxonox/trunk/gui/orxonox_gui_video.cc

@@ -28 +28 @@
 
 
-
 OrxonoxGuiVideo::OrxonoxGuiVideo ()
 {
@@ -44 +43 @@
 }
 
+/**
+   \brief Return the Frame
+   \return Returns the Video-frame
+*/
 Frame* OrxonoxGuiVideo::getFrame ()
 {

orxonox/trunk/gui/orxonox_gui_video.h

@@ +1 @@
+/*!
+  \file orxonox_gui_video.h
+  \brief File that holds the class that creates the Video-Options.
+*/
 #ifndef _ORXONOX_GUI_VIDEO_H
 #define _ORXONOX_GUI_VIDEO_H
@@ -4 +8 @@
 #include "orxonox_gui.h"
 
+//! Class that creates the Video-Options.
 class OrxonoxGuiVideo
 {