uappli.hpp

/* ==================================================== ======== ======= *
 *
 *  uappli.hpp
 *  Ubit Project
 *  Author: Eric Lecolinet
 *  Part of the Ubit Toolkit: A Brick Construction Game Model for Creating GUIs
 *  (C) 1999-2006 / Eric Lecolinet / ENST Paris / 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.
 * ***********************************************************************
 * ==================================================== [(c)Elc] ======= *
 * ==================================================== ======== ======= */

#ifndef _uappli_hpp_
#define _uappli_hpp_
//pragma ident  "@(#)uappli.hpp ubit:05.05.00"
#include <ubit/udisp.hpp>
#include <ubit/uconf.hpp>
#include <ubit/uerror.hpp>
namespace ubit {

/* ==================================================== ======== ======= */
typedef std::vector<UEventFlow*> UFlowList;
typedef std::vector<UDisp*> UDispList;

/* ==================================================== ======== ======= */
class UAppli: public UDisp {
public:
  static UConf conf;
  UAppli(int& argc, char** argv,
         UOption* command_line_options = null, 
         const char* configuration_file = null);
  virtual ~UAppli();

  static bool usingGL() {return conf.using_gl;}
  
  static bool using3D() {return conf.using_3d;}
  
  static UAppli& getApp() throw (UFatalError);
  static UFrame* getMainFrame();
  static const UStr& getName();

  static const char* getVersion();

  
  static void setTitle(const UStr& title);
  static const UStr& getImaPath();
  static void setImaPath(const UStr& pathname);
  static USelection* getSelection(int ID = 0);
  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  // main loop

  static int start();
  static int mainLoop() {return start();}
  static void quit(int status = 0);
  static bool isRunning();
  //< returns true if the main loop is running.
  
  static UTime getTime();
  
  static void setMotionLag(UTime app_lag, UTime nat_lag);
  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  // Windows

  virtual void add(UWin&);
  virtual void remove(UWin& child, bool auto_delete);
  virtual void updateAll(const UUpdate& upatemode = UUpdate::layoutAndPaint); 
  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  // Errors
  
  static UErrorLog log;
  static void error(const char* location, const char* format, ...);
  static void warning(const char* location, const char* format, ...);
  static void fatalError(const char* location, const char* format, ...) throw (UFatalError);
  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  // Styles and Classes.  
  
  static UStyleSheet& getStyleSheet();

  static const UStyle& getDefaultStyle();

  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  // postponing and timeouts
  
  static void postpone(UCall& callback);
  static void onTimeout(UTime msec_delay, int ntimes, UCall& callback);
  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  // Ubit messages.
  
  static void onMessage(const UStr& port_name, UCall& callback);
  static UMessagePort& getMessagePort(const UStr& name);
  static UMessagePort* findMessagePort(const UStr& name);

  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  // Multiple Displays

  static const UDispList& getDispList();
  //< returns the list of Displays that are connected with this UAppli.

  static UDisp* getDisp(int ID);
  //< returns the display with this ID (null if not found).

  static UDisp* openDisp(const UStr& display);
  static void closeDisp(UDisp*);

  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  // Multiple Event Flows.

  static const UFlowList& getFlowList();
  
  static UEventFlow* getFlow(int ID);
  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  // implementation

  UNatAppli* getNatAppli() const;
  
  UGroup* getOpenedMenu();
  
  static bool hasTelePointers();

  static bool isTerminated();
  
  virtual bool isRealized() const;

  virtual void realize();

#ifndef NO_DOC
  friend class UEventFlow;  

  static void internalError(const char* location, const char* format, ...);
                    
  virtual UConf& initConf(int& argc, char** argv, UOption*, const char* confile);

  virtual void constructs();

  static void deleteNotify(UView*  deleted_view);
  static void deleteNotify(UGroup* deleted_group);
  static void deleteNotify(UDisp*  deleted_disp);
  
  void addModalwin(UWin*);
  void removeModalwin(UWin*);
  
  int startSubLoop();
  void quitSubLoop(int status);

  static class UAppliImpl& impl;
#endif
};

}
#endif
/* ==================================================== [TheEnd] ======= */
/* ==================================================== [(c)Elc] ======= */

---