Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Changeset 3187 in orxonox.OLD for orxonox/trunk/gui/orxonox_gui_keys.h


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

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

File:
1 edited

Legend:

Unmodified
Added
Removed

  • 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);
Note: See TracChangeset for help on using the changeset viewer.