Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

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


Ignore:
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

Legend:

Unmodified
Added
Removed
  • orxonox/trunk/gui/orxonox_gui_exec.cc

    r2584 r2588  
    2828#include <string>
    2929
     30/**
     31    \brief Creates the Exec-Frame
     32    \param orxonoxGUI ExecFrame needs to know where to get the Options from
     33*/
    3034OrxonoxGuiExec::OrxonoxGuiExec (Window* orxonoxGUI)
    3135{
     
    5458}
    5559
     60/**
     61   \brief Return the Frame
     62   \return Returns the Exec-frame
     63*/
    5664Frame* OrxonoxGuiExec::getFrame ()
    5765{
     
    6169/* FILE HANDLING */
    6270
     71/**
     72   \brief Sets the location of the configuration File.\n
     73   * The name will be parsed from ~/ to /home/[username] on unix and c:/Documents and Settings/username/Settings/ on Windows
     74   \param filename the location of the configFile
     75*/
    6376void OrxonoxGuiExec::setFilename (char* filename)
    6477{
     
    7891}
    7992
     93/**
     94   \brief checks if a option should be saved.
     95   \return 1 if it should 0 if not/
     96*/
    8097int OrxonoxGuiExec::shouldsave ()
    8198{
     
    83100}
    84101
     102/**
     103    \brief Saves the configuration-file to the Disk.\n
     104    this Function only opens and closes the file, in between OrxonoxGuiExec::writeFileText (Widget* widget) will execute the real writing process.
     105    \param widget from which Widget on should be saved.
     106*/
    85107void OrxonoxGuiExec::writeToFile (Widget* widget)
    86108{
     
    91113}
    92114
     115/**
     116   \brief Actually writes into the configuration file to the disk.
     117   \param widget from which Widget on should be saved.
     118*/
    93119void OrxonoxGuiExec::writeFileText (Widget* widget)
    94120{
     
    121147}
    122148
     149/**
     150   \brief Reads in Configuration Data.
     151   \param widget from which Widget on should be saved.
     152*/
    123153void OrxonoxGuiExec::readFromFile (Widget* widget)
    124154{
     
    150180}
    151181
     182/**
     183   \brief Maps Confugurations to the Options.
     184   \param widget which widget downwards
     185   \param variableName the name of the Variable that should be set up.
     186   \param variableValue the Value of the Variable that should be set up
     187*/
    152188void OrxonoxGuiExec::readFileText (Widget* widget, char* variableName, int variableValue)
    153189{
     
    170206}
    171207
    172 
     208/**
     209   \brief Starts ORXONOX. (not really implemented yet, but the function is there.\n
     210   This is a Signal and can be executed through Widget::signal_connect
     211   \param widget the widget that executed the start command
     212   \param data additional data
     213*/
    173214gint startOrxonox (GtkWidget *widget, Widget* data)
    174215{
    175   /**
    176    * Starts Orxonox.
    177    */
    178216  cout << "Starting Orxonox" <<endl;
    179217}
Note: See TracChangeset for help on using the changeset viewer.