Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Changeset 3187 in orxonox.OLD for orxonox/trunk


Ignore:
Timestamp:
Dec 15, 2004, 9:00:38 PM (20 years ago)
Author:
bensch
Message:

orxonox/trunk/gui: doxygen-tags… it's very much.

Location:
orxonox/trunk/gui
Files:
13 edited

Legend:

Unmodified
Added
Removed

  • orxonox/trunk/gui/orxonox_gui.cc

    r3167 r3187  
    2121   ### File Specific:
    2222   main-programmer: Benjamin Grauer
    23 
    24    ToDO:
    25    way to start gui without GTK (textmode)
    26    curl interface to Download cool stuff
    27 
    28    chain all the windows when starting the GUI (DANGER: performance!!)
    29 
    30    widgets save themselves
    31    good way to step through all the Widgets
    32    ... many more ...
    33    label -> protected : getlabel function
    3423
    3524*/

  • orxonox/trunk/gui/orxonox_gui.h

    r3164 r3187  
    22 \file orxonox_gui.h
    33 \brief Creation of the Gui
     4
     5 \todo way to start gui without GTK (textmode) AND IMPROOVE
     6 \todo curl interface to Download cool stuff
     7
     8 \todo widgets save themselves
     9 \todo good way to step through all the Widgets
     10 \todo label -> protected : getlabel function
    411*/
    512

  • orxonox/trunk/gui/orxonox_gui_audio.h

    r2595 r3187  
    1313{
    1414 private:
    15   Frame* audioFrame;
    16   Box* audioBox;
    17   CheckButton* enableSound;
    18   Slider* musicVolume;
    19   Slider* effectsVolume;
     15  Frame* audioFrame;        //!< The Frame that holds the audio Options.
     16  Box* audioBox;            //!< The Box that holds the audio Options.
     17  CheckButton* enableSound; //!< A Ckeckbutton for enabling Sound.
     18  Slider* musicVolume;      //!< A Slider for music volume.
     19  Slider* effectsVolume;    //!< A Slider for effects volume.
    2020 public:
    2121  OrxonoxGuiAudio ();

  • orxonox/trunk/gui/orxonox_gui_banner.h

    r3153 r3187  
    1515 private:
    1616  // the banner Frame
    17   Frame* bannerFrame;
    18   Box* bannerBox;
    19   EventBox* bannerEventBox; //!< an Image needs an EventBox to catch klicks
    20   Image* bannerImage;
    21   Label* bannerLabel;
     17  Frame* bannerFrame;       //!< The frame that holds the Banner.
     18  Box* bannerBox;           //!< The box that holds the Banner.
     19  EventBox* bannerEventBox; //!< an Image needs an EventBox to catch klicks.
     20  Image* bannerImage;       //!< The Image for the Banner.
     21  Label* bannerLabel;       //!< The Label of the Banner.
    2222
    2323  // the logo Window
    24   Window* logoWindow;
    25   EventBox* logoEventBox;
    26   Box* logoBox;
    27   Image* logoImage;
    28   Label* logoLabel;
     24  Window* logoWindow;       //!< The Window that holds the Orxonox-CrewLogo.
     25  EventBox* logoEventBox;   //!< The EventBox that holds the Orxonox-CrewLogo. it has to be an eventbox, because Images can not receive clicks.
     26  Box* logoBox;             //!< The Box that holds the Orxonox-CrewLogo
     27  Image* logoImage;         //!< The Orxonox-CrewLogo-Image
     28  Label* logoLabel;         //!< The Label for the Orxonox-CrewLogo
    2929
    3030 public:

  • orxonox/trunk/gui/orxonox_gui_exec.cc

    r3165 r3187  
    110110/**
    111111    \brief Saves the configuration-file to the Disk.\n
     112    \param widget from which Widget on should be saved.
     113
    112114    this Function only opens and closes the file, in between OrxonoxGuiExec::writeFileText (Widget* widget) will execute the real writing process.
    113     \param widget from which Widget on should be saved.
    114115*/
    115116void OrxonoxGuiExec::writeToFile (Widget* widget)
    … …  
    248249
    249250/**
    250    \brief locates a Group member
     251   \brief Locates a Group.
     252   \param widget The Widget from where to search from
     253   \param groupName The GroupName for which to search.
     254   \param depth The Depth of the search seen from the first widget we searched from.
     255   \returns The Widget that holds the Group, or the NULL if the Group wasn't found.
    251256*/
    252257Widget* OrxonoxGuiExec::locateGroup(Widget* widget, char* groupName, int depth)

  • orxonox/trunk/gui/orxonox_gui_exec.h

    r3165 r3187  
    1515{
    1616 private:
    17   Frame* execFrame;
    18   Box* execBox;
    19   Button* start;
    20   CheckButton* saveSettings;
    21   Menu* verboseMode;
    22   CheckButton* alwaysShow;
    23   Button* quit;
    24   char* configFile;
    25   FILE* CONFIG_FILE;
     17  Frame* execFrame;            //!< The Frame that holds the ExecutionOptions.
     18  Box* execBox;                //!< The Box that holds the ExecutionOptions.
     19  Button* start;               //!< The start Button of orxonox.
     20  CheckButton* saveSettings;   //!< A CheckBox for if the Options should be saved.
     21  Menu* verboseMode;           //!< A Menu for setting the verbose-Mode. \todo setting up a verbose-class.
     22  CheckButton* alwaysShow;     //!< A CheckButton, for if orxonox should start with or without gui.
     23  Button* quit;                //!< A Button to quit the Gui without starting orxonox.
     24  char* configFile;            //!< The name of the .orxonox.conf(ig)-file.
     25  FILE* CONFIG_FILE;           //!< Filehandler for reading and writing.
     26
    2627 public:
    2728  OrxonoxGuiExec (Window* orxonoxGUI);

  • orxonox/trunk/gui/orxonox_gui_flags.h

    r2595 r3187  
    1313{
    1414 private:
    15   Frame* flagsFrame;
    16   Box* flagsBox;
    17   CheckButton* shortFlags;
    18   Label* flagsLabel;
    19   char* flagText;
     15  Frame* flagsFrame;          //!< The Frame that holds the flagsDisplay.
     16  Box* flagsBox;              //!< The Box that holds the flagsDisplay.
     17  CheckButton* shortFlags;    //!< CheckButton to change the display of short and long flags \todo show long if long not availible...
     18  Label* flagsLabel;          //!< The Label of the Flags
     19  char* flagText;             //!< The Text of the Label. \todo Delete when Object is destroyed.
    2020
    2121 public:

  • orxonox/trunk/gui/orxonox_gui_gtk.cc

    r3166 r3187  
    4040
    4141#ifdef HAVE_GTK2
     42/**
     43   \brief Initializes the Guis GTK-stuff.
     44   \param argc the argument count.
     45   \param argv The Argument strings.
     46*/
    4247bool initGTK(int argc, char *argv[])
    4348{
    … …  
    4550  gtk_rc_parse( "rc" );
    4651}
     52
     53/**
     54   \brief enters the GTK-main-loop
     55*/
    4756bool mainloopGTK(void)
    4857{
    … …  
    158167/**
    159168   \brief Moves through all the Widgets downwards from this and executes the function on them.
    160    \param function must be of type void and takes a Widget* as an Input.
     169   \param Function must be of type void and takes a Widget* as an Input.
    161170*/
    162171void Widget::walkThrough (void (*function)(Widget*))
    … …  
    197206
    198207#ifdef HAVE_GTK2
     208
     209/**
     210   \brief Signal that does absolutely nothing
     211   \param widget The widget that initiated the Signal
     212   \param event The event-type.
     213   \param nothing nothin.
     214*/
    199215gint Widget::doNothingSignal (GtkWidget *widget, GdkEvent* event, void* nothing)
    200216{
    … …  
    209225/**
    210226   \brief Initializes a Packer.
     227
    211228   Sets the down-pinter to NULL and other PackerSpecific-values to their defaults.
    212229*/
    … …  
    246263/**
    247264   \brief Initializes a Container.
     265
    248266   sets the Container-Specific defaults.
    249267*/
    … …  
    259277/**
    260278   \briefFills a Container with lowerWidget.
     279   \param lowerWidget the Widget that should be filled into the Container.
     280
    261281   It does this by filling up the down pointer only if down points to NULL.
    262    \param lowerWidget the Widget that should be filled into the Container.
    263282*/
    264283void Container::fill (Widget *lowerWidget)
    … …  
    281300Window* Window::mainWindow = NULL;
    282301
     302/**
     303   \brief Adds a new Window Windows to the List of Windows.
     304   \param windowToAdd The Windows that should be added to the List
     305   \todo this instead of windowToAdd (possibly)
     306*/
    283307void Window::addWindow(Window* windowToAdd)
    284308{
    … …  
    410434   \brief opens up a window (not topmost Window).
    411435   this is the Signal that does it. !!SIGNALS ARE STATIC!!
    412    \param widget the widget that did it!
    413    \param event the event that did it!
     436   \param widget the widget that did it.
     437   \param event the event that did it.
    414438   \param window the Window that should be opened
    415439*/
    … …  
    585609/**
    586610    \brief Fills a box with a given Widget.
     611    \param lowerWidget the next Widget that should be appendet to this Box
     612
    587613    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
    588     \param lowerWidget the next Widget that should be appendet to this Box
    589614*/
    590615void Box::fill (Widget *lowerWidget)
    … …  
    658683/**
    659684   \brief This sets The FlagName of an Option and defines its default Values
    660    !! Options will be saved if flagname is different from "" !!
     685   !! Options will be saved if flagname is different from NULL !!
    661686   \param flagname the Name that will be displayed in the output
    662687   \param defaultvalue the default Value for this Option (see definition of defaultvalue
    … …  
    9951020}
    9961021
     1022/**
     1023   \brief Creates a new OptionLabel with a LabelName and a Value.
     1024   \param label The name of the OptionLabel.
     1025   \param value The Value of the OptionLabel (what will be displayed).
     1026*/
    9971027OptionLabel::OptionLabel(char* label, char* value)
    9981028{
    … …  
    10021032}
    10031033
     1034/**
     1035   \brief Initializes an OptionLabel
     1036*/
    10041037void OptionLabel::init(void)
    10051038{
    … …  
    10131046}
    10141047
     1048/**
     1049   \brief Updates the value of an OptionLabel
     1050   \param newValue The new Name that should be displayed.
     1051*/
    10151052void OptionLabel::setValue(char* newValue)
    10161053{
    … …  
    10241061}
    10251062
     1063/**
     1064   \brief Sets a ned Title to the OptionLabel.
     1065   \param title The now title of the OptionLabel.
     1066*/
    10261067void OptionLabel::setTitle(char* title)
    10271068{
    … …  
    10351076}
    10361077
     1078/**
     1079   \brief Redraws an OptionLabel (not implemented yet, but it works).
     1080*/
    10371081void OptionLabel::redraw(void)
    10381082{

  • orxonox/trunk/gui/orxonox_gui_gtk.h

    r3165 r3187  
    3838{
    3939 private:
     40
    4041 public:
    4142  ~Widget ();
    … …  
    111112{
    112113 private:
    113   bool isOpen;
    114  public:
    115   static Window* mainWindow;
     114  bool isOpen;                //!< A bool Variable that checks if a Window is already open.
     115 public:
     116  static Window* mainWindow;  //!< Pointer to the First Window that was opened. By default this should be the GUI's main-Window.
    116117  static void addWindow(Window* windowToAdd);
    117118
    … …  
    163164//! A Box can contain multiple Widgets
    164165/**
    165  * A Box can Contain multiple Widgets, that are ordered either horizontally or vertically
    166  * I defined the standartbox to be horizontally.
    167  * A Box is always filled left->right (horizontally) or up->down (vertically)
    168  */
     166   A Box can Contain multiple Widgets, that are ordered either horizontally or vertically
     167   I defined the standartbox to be horizontally.
     168   A Box is always filled left->right (horizontally) or up->down (vertically)
     169*/
    169170class Box : public Packer
    170171{
    … …  
    204205  char* flagNameShort; //!< like flag_name but shorter
    205206  int defaultValue; //!< A default value is good, for hiding a option if it is not needed. (hidden if value == default_value)
    206   bool saveable;  //! Options can be Saved.
     207  bool saveable;  //!< Options can be Saved.
    207208
    208209  void setFlagName (char* flagname, int defaultvalue);
    … …  
    268269 private:
    269270#ifdef HAVE_GTK2
    270   GtkWidget* menu;
    271   GtkWidget* item;
    272 #endif /* HAVE_GTK2 */
    273   va_list itemlist;
     271  GtkWidget* menu;     //!< The menu That will hold the Options.
     272  GtkWidget* item;     //!< One Item From a Menu.
     273#endif /* HAVE_GTK2 */
     274  va_list itemlist;    //!> The list to readin multiple Options.
    274275 
    275276 public:
    … …  
    293294  void init(void);
    294295 
    295   char* cValue;
     296  char* cValue;   //!< The Value the Label will have.
    296297 
    297298  void setValue(char* newValue);

  • orxonox/trunk/gui/orxonox_gui_keys.cc

    r3166 r3187  
    5353
    5454/* PLAYER */
     55
     56/**
     57   \brief Creates new inputs for a player
     58   \param player the name of the Player
     59*/
    5560Player::Player(char* player)
    5661{
    … …  
    97102}
    98103
     104/**
     105   \brief adds a new Key.
     106   \param key the number of the Key
     107   \param name The name of the new Key.
     108   \returns A widget that has the Key-Box
     109*/
    99110Widget* Player::addKey (KEYS key, char* name)
    100111{
    … …  
    114125}
    115126
     127/**
     128   \returns the OpenButton of a Player
     129*/
    116130Button* Player::getOpenButton()
    117131{
    … …  
    119133}
    120134
    121 
     135/**
     136   \brief sets a new Key (only output)
     137   \param key the new Key.
     138*/
    122139void Player::setkey(KEYS key)
    123140{

  • orxonox/trunk/gui/orxonox_gui_keys.h

    r3165 r3187  
    1111#include <gdk/gdkkeysyms.h>
    1212#endif /* HAVE_GTK2 */
     13
    1314/**
    14  * defines the Possible Player Keys
    15  */
     15   \brief defines the Possible Player Keys
     16*/
    1617enum KEYS { UP, DOWN, LEFT, RIGHT, SHOOT };
    1718
    … …  
    2122{
    2223 private:
    23   Frame* keysFrame;
    24   Box* keysBox;
    25   Player* player1;
    26   Player* player2;
    27   Button* misc;
     24  Frame* keysFrame;      //!< The Frame that holds the keyOptions.
     25  Box* keysBox;          //!< The Frame that holds the keyOptions.
     26  Player* player1;       //!< The first Player's keys.
     27  Player* player2;       //!< The seconds Player's keys.
     28  Button* misc;          //!< Other keyboeard options come here. \todo include some like pause, quit and so on.
    2829
    2930 public:
    … …  
    3536
    3637//! Class to hold infos about a Player
     38/**
     39   \todo split into subclass and superclass ButtonConfigurator
     40*/
    3741class Player
    3842{
    3943 private:
    40   Window* pKeyWindow;
    41   Frame* pKeyFrame;
    42   Button* openButton;
    43   Button* closeButton;
    44   Box* pKeysBox;
     44  Window* pKeyWindow;     //!< The Window for a new Key-setting.
     45  Frame* pKeyFrame;       //!< The Frame for a new Key-setting.
     46  Button* openButton;     //!< The OpenButton for this key-settings.
     47  Button* closeButton;    //!< The CloseButton for this key-settings.
     48  Box* pKeysBox;          //!< The Box that holds the Key-settings.
    4549 
     50  //! One KeyOption has one InputKey
    4651  struct InputKey
    4752  {
    48     Box* pKeyBox;
    49     Button* pKeyButton;
    50     OptionLabel* pKeyOLabel;
     53    Box* pKeyBox;           //!< One Box that holds the Keys
     54    Button* pKeyButton;     //!< The Button for changing the Key.
     55    OptionLabel* pKeyOLabel;//!< The Label for displaying the Key-setting.
    5156  };
    5257
    53   InputKey* inputKey[10];
     58  InputKey* inputKey[10];     //!< Buttons-array. \todo make it dynamic.
    5459
    55   static Window* inputWindow;
    56   static Button* inputButton;
    57   static long keySignal;
     60  static Window* inputWindow; //!< A Window that gets keyboard clicks. Static, because only one needed.
     61  static Button* inputButton; //!< A Button that gets keyboard clicks. Static, because only one needed.
     62  static long keySignal;      //!< A keySignal that handles keyboard clicks. Static, because only one needed.
    5863 public:
    5964  Player(char* player);

  • orxonox/trunk/gui/orxonox_gui_video.cc

    r2739 r3187  
    2727#include "orxonox_gui_video.h"
    2828
    29 
     29/**
     30   \brief Creates the Video-Option-Frame
     31*/
    3032OrxonoxGuiVideo::OrxonoxGuiVideo ()
    3133{
    … …  
    4749
    4850/**
    49    \brief Return the Frame
    5051   \return Returns the Video-frame
    5152*/

  • orxonox/trunk/gui/orxonox_gui_video.h

    r2595 r3187  
    1212{
    1313 private:
    14   Frame* videoFrame;
    15   Box* videoBox;
    16   CheckButton* fullscreen;
    17   CheckButton* wireframe;
     14  Frame* videoFrame;        //!< The Frame that holds the video options.
     15  Box* videoBox;            //!< The Box that holds the video options.
     16  CheckButton* fullscreen;  //!< CheckButton for fullscreen-mode
     17  CheckButton* wireframe;   //!< CheckButton for wireframe Mode.
    1818 public:
    1919  OrxonoxGuiVideo ();
Note: See TracChangeset for help on using the changeset viewer.