Context Navigation

← Previous Change
Next Change →

orxonox_gui.cc

Timestamp:

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

Author:

bensch

Message:

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

File:

: 1 edited

orxonox/trunk/gui/orxonox_gui.cc (modified) (38 diffs)

Legend:

: Unmodified
: Added
: Removed

orxonox/trunk/gui/orxonox_gui.cc

-                      r2587
+                      r2588
 /* ORXONOXGUI */
+/**
+ * Initializes the Gui
+*/
 OrxonoxGui::OrxonoxGui (int argc, char *argv[])
+{
-  /**
-   * Initializes the Gui
-   */
   gtk_init (&argc, &argv);
   gtk_rc_parse( "rc" );
 …
 /* WIDGET */
+/**
+ * Initializes a widget.
+ * Nothing to do here.
+ */
 void Widget::init()
+{
 …
+}
+/**
+ * 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)
 …
+/**
+ * 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;
 …
 /* 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)
+    {
 …
 /* 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;
 …
+}
+/**
+ * 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);
 …
 /* 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()
+{
 …
+}
+/**
+ * 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)
+{
 …
+}
+/**
+ * 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 ()
+{
 …
 /* 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)
+{
 …
+}
+/**
+ * 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)
+{
 …
 /* 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)
+{
 …
+}
+/**
+ * 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;
 …
 /* 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)
+{
 …
+}
+/**
+ * Sets a new name to the Button
+\param title The name the Button should get
+*/
 void Button::setTitle (char *title)
+{
 …
+}
+/**
+ * redraws the Button
+ * not implemented yet
+ */
 void Button::redraw ()
+{
 …
 /* 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);
 …
   this->connectSignal ("clicked", this->OptionChange);
+}
+/**
+ * Destructs a CheckButton (not Implemented yet).
+ */
 CheckButton::~CheckButton()
+{
+}
+/**
+ * Initiali a new CheckButton with default settings
+ */
 void CheckButton::init(void)
+{
 …
   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)
+{
 …
+}
+/**
+ * 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);
 …
+}
+/**
+ * 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 ()
+{
 …
 /* 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);
 …
+}
+/**
+ * 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)
+{
 …
   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)
+{
 …
+}
+/**
+ * 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);
 …
+}
+/**
+ * Redraws the widget
+ * Example: see void CheckButton::redraw ()
+ */
 void Slider::redraw ()
+{
 …
+}
+/* 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);
 …
+}
+/**
+ * Initializes a new Menu with no items
+ */
 void Menu::init(void)
+{
 …
+}
+/**
+ * Sets the Database-Name of this Menu
+ \param title Database-Name to be set.
+*/
 void Menu::setTitle(char* title)
+{
 …
+}
+/**
+ * appends a new Item to the Menu-List.
+ \param itemName the itemName to be appendet.
+*/
 void Menu::addItem (char* itemName)
+{
 …
+}
+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);
 …
+}
+/**
+ * Redraws the widget
+ * Example: see void CheckButton::redraw ()
+ */
 void Menu::redraw ()
+{
 …
+}
+/**
+ * Creates a new default Label with no Text.
+ * You migth consider adding Label::setTitle with this.
+ */
 Label:: Label ()
+{
 …
+}
+/**
+ * Creates a new Label with a Text.
+ \param text The text to be displayed.
+*/
 Label:: Label (char* text)
+{
 …
+}
+/**
+ * Destructs a Label
+ */
 Label::~Label ()
 {}
+/**
+ * initializes a new Label
+ */
 void Label::init(void)
+{
 …
   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)
+{
 …
+}
+/**
+ * get the Text of a Label
+ \return The Text the Label holds.
+*/
 char* Label::getText ()
+{

Note: See TracChangeset for help on using the changeset viewer.

Context Navigation

Changeset 2588 in orxonox.OLD for orxonox/trunk/gui/orxonox_gui.cc

Legend:

orxonox/trunk/gui/orxonox_gui.cc

Download in other formats: