uconf.hpp

/************************************************************************
 *
 *  uconf.hpp : configuration of the UAppli
 *  Ubit GUI Toolkit - Version 6
 *  (C) 2009 | Eric Lecolinet | TELECOM ParisTech | http://www.enst.fr/~elc/ubit
 *
 * ***********************************************************************
 * COPYRIGHT NOTICE :
 * THIS PROGRAM IS DISTRIBUTED WITHOUT ANY WARRANTY AND WITHOUT EVEN THE
 * IMPLIED WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
 * YOU CAN REDISTRIBUTE IT AND/OR MODIFY IT UNDER THE TERMS OF THE GNU
 * GENERAL PUBLIC LICENSE AS PUBLISHED BY THE FREE SOFTWARE FOUNDATION;
 * EITHER VERSION 2 OF THE LICENSE, OR (AT YOUR OPTION) ANY LATER VERSION.
 * SEE FILES 'COPYRIGHT' AND 'COPYING' FOR MORE DETAILS.
 * ***********************************************************************/

#ifndef _uconf_hpp_
#define _uconf_hpp_ 1
#include <ubit/udefs.hpp>
#include <ubit/ustr.hpp>
#include <ubit/ufont.hpp>
namespace ubit {


class UOption {
public:
  const char *begname, *endname;
  class UOptionArg* arg;

  static class UOptionArg* Arg(bool& val);
  static class UOptionArg* Arg(int& val);
  static class UOptionArg* Arg(float& val);
  static class UOptionArg* Arg(UStr& val);
  static class UOptionArg* Arg(char*& val);
  static class UOptionArg* Arg(const char*& val);
  static void parseOptions(int& argc, char** argv, UOption* options);
};

/* ==================================================== ======== ======= */
class UConf {
public:  
  UConf();
  virtual ~UConf();
  
  void useGL(bool = true);
  void useFreeType(bool = true);
  void setDepthBuffer(int size);
  void setStencilBuffer(int size);
  void setBpp(int bpp);
  void setLocale(const UStr& s);

  void setScale(float v);

  void setVerbose(int v);

  void setDefaultBackground(const UBackground&);
    
  void setTransparentScrollbars(bool);
  
  virtual void printHelp();
  
  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  
  bool isUsingGL() const {return is_using_gl;}  
  bool isUsingFreeType() const {return is_using_freetype;}
  bool isVerbose() const {return verbosity != 0;}
  int  getVerbosity() const {return verbosity;}
  
  const UStr& getLocale() const {return locale;}
  
  float getScale() const {return scale;}
  
  int getMouseSelectButton() const {return mouse_select_button;}
  
  int getMouseMenuButton() const {return mouse_menu_button;}
  
  int getMouseAltButton() const {return mouse_alt_button;}
  // - - - misc options - - - - - - - - - - - - - - - - - - - - - - - - - - -  -

  bool 
    xsync, usync,
    
    menu_grab,
        
    postpone_delete,

    soft_dbf,
  
    soft_wins, soft_menus,
    
    transp_scrollbars,
    
    tele_pointers,

    generic_textsel;
        
  int click_radius;  // (pas unsigned, les dist ne le sont jamais)

  unsigned long multi_click_delay;   
  
  unsigned long auto_repeat_delay;

  unsigned long open_tip_delay;

  unsigned long open_submenu_delay; 

  // - - - option parsing  - - - - - - - - - - - - - - - - - - - - - - - - - - -
  
  virtual void parseOptions(int& argc, char** argv, UOption* options);
  virtual void readAttributes(const char* pathname);
  UAttrList* getAttributes(const char* category);
  
  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
private:
  friend class UDisp;
  friend class UAppli;
  friend class UAppliImpl;
  friend class UUpdateContext;
  friend class UEventFlow;
  friend class UElem;
  friend class UBox;
  friend class UWin;
  friend class UEdit;
  friend class UIma;
  friend class UPix;
  friend class UGraph;
  friend class UFont;
  friend class UFontDesc;
  friend class UHardFont;
  friend class UFilebox;
  friend class UGlcanvas;
  friend class U3Dcanvas;
  virtual void parseUbitOptions(int& argc, char** argv);
  
protected:
  bool freeze_options;
  const char* const windowing_toolkit;
  bool is_using_gl, is_using_freetype;
  int bpp;
  int depth_size, stencil_size;
  int verbosity; // verbose mode.
  float scale;   // scaling factor for rendering the application [default = 1,0].
  int filebox_width, filebox_height, filebox_line_count;   // 400, 230, 10. !!!@@@ A VIRER !!!
  const int& mouse_select_button;  
  const int& mouse_menu_button; 
  const int& mouse_alt_button; 
  UStr locale;   // locale of the application [default = "" : the environment locale]
  UStr display;         // name of the X11 display [default = "": the local X server is used)
  UFont* default_font;  // the default font of the application [default = UFont::sans_serif].
  UPix* unknow_image;   // the image that appears instead of an unknown image (when applicable].
  UFont*  selection_font;    // font of the text selection (can be null)
  UColor* selection_color;   // text color of the text selection (can be null)
  UColor* selection_bgcolor; // background color of the text selection (can be null)
  UBackground& default_background;  // the default background of the application.
};

}
#endif