udisp.hpp

/* ==================================================== ======== ======= *
 *
 *  udisp.hpp
 *  Ubit Project
 *  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 _udisp_hpp_
#define _udisp_hpp_
//pragma ident  "@(#)udisp.hpp  ubit:05.05.00"
#include <ubit/ubrick.hpp>
#include <ubit/ustr.hpp>
#include <ubit/ugroup.hpp>
namespace ubit {

/* ==================================================== ======== ======= */
class UDisp {
public:
  UDisp(const UStr& display_name);
  UDisp(UConf&);
  virtual ~UDisp();

  const UConf& getConf() const {return conf;}

  int getID() const {return id;}
  bool isOpened() const;
  
  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

  virtual void add(UWin&);
  virtual void remove(UWin&, bool auto_delete);
  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  
  int getDepth() const;
  
  const UStr& getDisplayName() const;

  int getScreenWidth() const;
  int getScreenHeight() const;
  
  int getScreenNumber() const;
  
  int getScreenCount() const;
  //< returns the total number of Screens on this X Server.

  void flush();
  
  bool isRealized() const;
   
  // - - - pointer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

  void setPointerPos(const UPoint& screen_pos, int channel = 0) const;

  UPoint getPointerPos(int channel = 0) const;

  int getPointerState(int channel = 0) const;

  bool grabPointer(const UCursor* = null);
  void ungrabPointer();
  bool pickWindow(UNatWin& picked_win, int& x_in_win, int& y_in_win, 
                  UCursor* = null);
  bool pickWindow(UNatWin& picked_win, int& x_in_win, int& y_in_win, 
                  UCall& callback, UCursor* = null);
  // - - - event flow - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  
  UEventFlow* getDispFlow(int channel) const;
  UEventFlow* obtainDispFlow(int channel);
  USelection* getDispSelection(int channel);
  // - - - impl - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

#ifndef WITH_GDK
  int setTrueColors(int depth_hint);
  int setPseudoColors(int depth_hint);
#endif

  virtual void realize();
  UNatDisp* getNatDisp() const {return natdisp;}

  void copySelection(UEvent&, USelection&);
  void pasteSelection(UEvent& e, UStr* _paste_to_str, int _paste_to_pos);
  void addHardWin(UWin*);
  void removeHardWin(UWin*);

  void realizeFont(const UFont&);
  bool realizeColor(UColor&);
  bool realizeCursor(UCursor&);
  
  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
#ifndef NO_DOC
protected:
  friend class UConf;
  friend class UWin;
  friend class UHardWinImpl;
  friend class UView;
  friend class UGraph;
  friend class UNatDisp;
  friend class UEvent;
  friend class UFontMetrics;

  // attention: l'ordre de destruction importe ici: winlist doit etre
  // detruit en premier ca ca entraine des destructions qui font reference
  // a flowlist => winlist doit etre declare en DERNIER

  int id;
  UConf& conf;             // configuration data (may be shared with the UAppli)
  UStr display_name;       // name of the X Display
  UNatDisp* natdisp;       // native Display
  UChildren hardwin_list;  // list of hardwins that are event managed

  // copySelection() copies the content of the selection in this buffer
  // note: there is 1 selection per UEventFlow but only 1 copy_buffer per UDisp
  UStr copy_buffer;

  // pasteSelection() specifies that the selection will be pasted in this
  // UStr at this pos (uptr<> to avoid deletion)
  uptr<UStr> paste_to_str;
  int paste_to_pos;

  // attention: winlist doit etre detruit en premier!
  UGroup winlist;  // list of windows belonging to this display
  
  bool pickWindow(UNatWin& w, int& x, int& y, UCall* call, UCursor* curs);
#endif
};

}
#endif
/* ==================================================== [TheEnd] ======= */

---