source: orxonox.OLD/orxonox/trunk/gui/orxonox_gui.h @ 2605

/*!
 \file orxonox_gui.h
 \brief Contains all Widgets and the Creation of the Gui
*/

#ifndef _ORXONOX_GUI_H
#define _ORXONOX_GUI_H

#include <stdlib.h>
#include <string.h>
#include <gtk/gtkmain.h>
#include <gtk/gtkwindow.h>
#include <gtk/gtkframe.h>
#include <gtk/gtkhbox.h>
#include <gtk/gtkvbox.h>
#include <gtk/gtkbutton.h>
#include <gtk/gtkcheckbutton.h>
#include <gtk/gtkhscale.h>
#include <gtk/gtkoptionmenu.h>
#include <gtk/gtkmenu.h>
#include <gtk/gtkmenuitem.h>
#include <gtk/gtklabel.h>
#include <gtk/gtkimage.h>
#include <gtk/gtkeventbox.h>

//! Class that creates the OrxonoxGui
class OrxonoxGui
{
 public:
  OrxonoxGui (int argc, char *argv[]);
  ~OrxonoxGui ();

};

//! This is the topmost object that can be displayed all others are derived from it.

class Widget
{
 private:
 public:
  ~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; //!< with this Paramenter one can set the IsOption type: -2:Container, -1: Box, 0: not an Option, 1: Bool-option, 2: int-option
  /**
     \briefdefines is_option states
  */
  enum option { containerType = -2, boxType = -1, nothingType = 0, boolType = 1, intType = 2}; 
  char* label; //!< The name of the Widget. Some do display it, Options need it to save;
  void connectSignal (char* event, gint (*signal)(GtkWidget*, GdkEvent*, void *));
  void connectSignal (char* event, gint (*signal)(GtkWidget*, Widget *));
  void connectSignal (char* event, void* extObj, gint (*signal)(GtkWidget*, GdkEvent*, void *));
  void show ();
  void hide ();
  void setSize(int width, int height);

  void walkThrough (void (*function)(Widget*));
  static void listOptions (Widget* widget);
  static void setOptions (Widget* widget);

};

//! This is a Packer Object, which has the ability to Pack other Widgets into itself.
class Packer : public Widget
{
 public:
  Widget* down; //!< this points to the Widget below this.

  void init(void);
};

//! 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 Packer
{
 private:
  int borderwidth;
  int policy;
  
 public:
  void init(void);
  //  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
{
 private:
  bool isOpen;
 public:
  Window (char* windowName);
  Window (void);
  void init ();
  
  void setTitle (char* title);
  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
{
 public:
  Frame (char* frameName);
  Frame (void);
  void init(void);
  
  void setTitle (char* title);
};

//! 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
{
 public:
  EventBox (char* eventBoxName);
  EventBox (void);
  void init(void);
  
  void setTitle (char* title);
};

//! 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 Packer
{
 public:
  Box (void);
  Box (char boxtype);
  void init(char boxtype);

  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
{
 public:
  Image (char* imgaename);
  void init(void);
};

//! 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
{
 public:
  //virtual gint OptionChange (GtkWidget *widget, GdkEvent *event, gpointer data);
  void init(void);

  int value; //!< every option has a value either true or false (0,1) or something else like 25 for 25% of the volume
  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; //!< 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 
{
 public:
  Button (char* buttonname);
  void init(void);

  void setTitle(char* title);
  
  void redraw();
};

//! CheckButtons are a key in configuring bool Variables
/** CheckButtons can configure bool Variables like wireframe on/off, enable_sound etc.
 */
class CheckButton : public Option
{
 public:
  CheckButton (char* buttonname);
  static gint OptionChange (GtkWidget* widget, Widget* checkbutton);
  
  void init(void);
  void setTitle(char* title);

  void redraw ();
};

//! Sliders are Options that can be modified in their value
/**
 * good for volume, brightness, etc.
 */
class Slider : public Option
{
 public:
  Slider (char* slidername,int start, int end);
  void init(int start, int end);

  void setTitle(char* title);
  void setValue(int value);

  static gint OptionChange (GtkWidget* widget, Widget* slider);
  void redraw();
};

//! A Menu is an Option that has a dropdown menu, where you can chose between different Items
class Menu : public Option
{
 private:
  GtkWidget* menu;
  GtkWidget* item;
  va_list itemlist;
  
 public:
  Menu (char* menuname, ...);
  void init(void);

  void setTitle(char* title);

  void addItem(char* itemName);
  static gint OptionChange (GtkWidget* widget, Widget* menu);
  void redraw();
};

//! A label is a Widget, that displays a text
class Label : public Widget
{
 public:
  Label ();
  Label (char* text);
  void init(void);
  
  void setText (char * text);
  char* getText ();
};

//gint orxonox_gui_quit (GtkWidget *widget, GdkEvent *event, gpointer data);

#endif /* _ORXONOX_GUI_H */