uwin.hpp

/* ==================================================== ======== ======= *
*
*  uwin.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 _uwin_hpp_
#define _uwin_hpp_
//pragma ident  "@(#)uwin.hpp   ubit:05.05.00"
#include <ubit/ubox.hpp>
#include <ubit/uview.hpp>
namespace ubit {

class UWinImpl;
class UPlacement;

/* ==================================================== ====== ======= */
class UWin : public UBox {
public:
  UBIT_ELEMENT_CLASS(UWin, UBox)

  UWin(const UArgs& = UArgs::none);

  virtual ~UWin();
  virtual class UWin* winCast() {return this;}

  // - - - position - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  
  UWin& addlist(const UArgs& a) {UGroup::addlist(a); return *this;}
  
  virtual UWin& setTitle(const UStr&, UDisp* = null);
  
  virtual void setPos(UMouseEvent&, float x = 0, float y = 0);
  virtual void setPos(const UWin& win, const UPoint&, UDisp* = null);

  virtual void setPos(const UView& view, const UPoint&);
  
  virtual void setPos(const UView& view, const UPlacement&);
  
  virtual void setPosOnScreen(const UPoint&, UDisp* = null);
  
  virtual void centerOnScreen(UDisp* = null);
  // centers the window on the screen.

  virtual UPoint getPos(const UWin& win, UDisp* = null) const;
  
  virtual UPoint getPos(const UView& view) const;
  
  virtual UPoint getPosOnScreen(UDisp* = null) const;

  // - - - size and stacking order - - - - - - - - - - - - - - - - - - - - - - -

  virtual float getWidth(UDisp* = null) const;
  
  virtual float getHeight(UDisp* = null) const;

  virtual UDimension getSize(UDisp* = null) const;
  
  virtual void setSize(const UDimension&, UDisp* = null);

  virtual void adjustSize();
  virtual void setFullScreen(bool state, UDisp* = null);

  virtual void toBack(UDisp* = null);
  
  virtual void toFront(UDisp* = null);
       
  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

  virtual bool isShown() const;
  virtual bool isShown(UDisp*) const;
  
  virtual void show(bool state, UDisp*);
  virtual void show(bool state = true) {UWin::show(state, null);}
  virtual bool isModal() const;
  
  virtual void setModal(bool = true) ;
  
  virtual int showModal(UDisp* = null);
  virtual void close(int status = 0);
  virtual void repaint() {update(UUpdate::paint);}          // redefined from UBox
  virtual void update() {update(UUpdate::layoutAndPaint);}  // redefined from UBox
  virtual void update(const UUpdate& mode);                 // redefined from UBox
  
  virtual void update(const UUpdate&, UDisp*);
  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

  bool isHardWin() const {return is_hardwin;}
  bool isSoftWin() const {return !is_hardwin;}
  virtual UWin& setSoftWin(bool = true);
  // - - - Impl. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  
  static  UStyle* createStyle();  

  virtual bool realize();
  UNatWin* getNatWin(UDisp* = null) const;
  
  UView* getWinView(UDisp*) const;
  
  virtual void highlight(bool state);

#ifndef NO_DOC
  friend class UBox;
  friend class UAppli;
  friend class UHardWinImpl;
  friend class USoftWinImpl;
  friend class UNatWin;
  friend class UNatDisp;
  
  virtual void initView(UChild* self, UView* ancestor_view);
  virtual UView* initViewImpl(UChild* self, UView* ancestor_view, UDisp*);
  virtual void deleteRelatedViews(UView* parview, UChild*);
  //NB: parview and link can be null for UWin::deleteRelatedViews
  
  void addWinView(UView*);
  UGroup* getSoftWins();
  UChildren* getSoftWinList(); 
  UHardWinImpl* hardImpl(UDisp*, const char* errmess = "") const;
  USoftWinImpl* softImpl(UDisp*, const char* errmess = "") const;

protected:
  bool is_hardwin;
  std::vector<UWinImpl*> wimpl; // pour multiwins
  
  virtual UView* realizeSoftWin(UWin* hardwin, UView* hardwin_view,
                                UDisp* disp, bool add_to_the_end);
  
  virtual bool realizeHardWin(unsigned short window_type);
  // internal realization function (window_type as defined in UNatWin).
  
  virtual void realizeChildren(UView* winview);
  // called by realize() to create the views of the children
  
  UView* getCurrentViewOfSoftwin() const;
#endif
};

/* ==================================================== [Elc:] ======= */
/* ==================================================== ====== ======= */
class UDialog : public UWin {
public:
  UBIT_ELEMENT_CLASS(UDialog, UWin)
  
  UDialog(const UArgs& = UArgs::none);
  friend UDialog& udialog(const UArgs& a = UArgs::none) {return *new UDialog(a);}

  virtual ~UDialog() {destructs();}
  
  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

  virtual void show(bool state, UDisp*);
  virtual void show(bool state = true) {UDialog::show(state, null);}

  // - - - Impl. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

  static  UStyle* createStyle();
  virtual bool realize();

#ifndef NO_DOC
  virtual void addingTo(UChild* self, UGroup *parent);
  virtual void removingFrom(UChild* self, UGroup *parent);  
private:
  UCall* open_call;
#endif
};

/* ==================================================== [Elc:] ======= */
/* ==================================================== ====== ======= */
class UFrame : public UDialog {
public: 
  UBIT_ELEMENT_CLASS(UFrame, UDialog)

  UFrame(const UArgs& a = UArgs::none);

  friend UFrame& uframe(const UArgs& a = UArgs::none) {return *new UFrame(a);}

  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

  bool isMainFrame() const {return is_main_frame;}

  virtual void show(bool state, UDisp*);
  virtual void show(bool state = true) {UFrame::show(state, null);}

  virtual void close(int status = 0);
  // - - - Impl. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  
  static UStyle* createStyle();
  virtual bool realize();
  
private:
  friend class UAppli;
  bool is_main_frame;
};

/* ==================================================== [Elc:] ======= */
/* ==================================================== ====== ======= */
struct UPlacement {
  UPlacement();

  // Horizontal placement. 
  // -- Explicit if &uleft() or &uright()
  // -- Default placement if null or other UHalign values.
  UHalign* halign;

  // vertical placement. Explicit if &utop() or &ubottom()
  UValign* valign;

  // Relative location from reference object:
  //
  // if oppositeBorder is true:
  //    the specified border (eg. uleft()) of the reference object is 
  //    aligned with the OPPOSITE border of 'this' object (eg. right)
  //    --> this implies that 'this' object will be located OUTSIDE
  //    the ref. object (exemple: a cascaded submenu located on the
  //    right side of its parent menu)
  //
  // if oppositeBorder is false:
  //    same borders are used for both objects (eg. both left
  //    sides are aligned together)
  //    --> this implies that 'this' object will be located INSIDE
  //    the ref. object (in the same way as for usual UH/Valign rules)

  bool hoppositeBorder, voppositeBorder;

  // relative 'distance' between reference and 'this' object borders.
  // Usually 1 or 0. Can be < 0 as it is a relative 'distance'.
  int hdist, vdist;
};

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

---