]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/layout.h
projects / wxWidgets.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Fix missing documentation for several GDI functions.
[wxWidgets.git] / include / wx / layout.h
diff --git a/include/wx/layout.h b/include/wx/layout.h
index 13ae082ee2bf25a97c68f43a8cf712aa24417a29..accc8836eb9108d6f77b152ac2ea2de6f7195818 100644 (file)
--- a/include/wx/layout.h
+++ b/include/wx/layout.h
@@ -1,304 +1,191 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////
-// Name:        layout.h
-// Purpose:     Layout classes
+// Name:        wx/layout.h
+// Purpose:     OBSOLETE layout constraint classes, use sizers instead
 // Author:      Julian Smart
 // Modified by:
 // Created:     29/01/98
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Julian Smart
 // Author:      Julian Smart
 // Modified by:
 // Created:     29/01/98
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Julian Smart
-// Licence:    wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 
-#ifndef __LAYOUTH__
-#define __LAYOUTH__
+#ifndef _WX_LAYOUT_H_
+#define _WX_LAYOUT_H_
 
 
-#ifdef __GNUG__
-#pragma interface "layout.h"
-#endif
-
-#include "wx/defs.h"
+// ----------------------------------------------------------------------------
+// headers
+// ----------------------------------------------------------------------------
 
 
-class WXDLLEXPORT wxWindow;
+#include "wx/object.h"
 
 // X stupidly defines these in X.h
 #ifdef Above
 
 // X stupidly defines these in X.h
 #ifdef Above
-#undef Above
+    #undef Above
 #endif
 #ifdef Below
 #endif
 #ifdef Below
-#undef Below
+    #undef Below
 #endif
 
 #endif
 
+#if wxUSE_CONSTRAINTS
+
+// ----------------------------------------------------------------------------
+// forward declrations
+// ----------------------------------------------------------------------------
+
+class WXDLLIMPEXP_FWD_CORE wxWindowBase;
+class WXDLLIMPEXP_FWD_CORE wxLayoutConstraints;
+
+// ----------------------------------------------------------------------------
+// constants
+// ----------------------------------------------------------------------------
+
 #define wxLAYOUT_DEFAULT_MARGIN 0
 
 #define wxLAYOUT_DEFAULT_MARGIN 0
 
-enum wxEdge { wxLeft, wxTop, wxRight, wxBottom, wxWidth, wxHeight,
-  wxCentre, wxCenter = wxCentre, wxCentreX, wxCentreY };
-enum wxRelationship { wxUnconstrained = 0,
-                      wxAsIs,
-                      wxPercentOf,
-                      wxAbove,
-                      wxBelow,
-                      wxLeftOf,
-                      wxRightOf,
-                      wxSameAs,
-                      wxAbsolute };
-
-class WXDLLEXPORT wxLayoutConstraints;
-class WXDLLEXPORT wxIndividualLayoutConstraint: public wxObject
+enum wxEdge
 {
 {
-  DECLARE_DYNAMIC_CLASS(wxIndividualLayoutConstraint)
-
- protected:
-   // 'This' window is the parent or sibling of otherWin
-   wxWindow *otherWin;
-
-   wxEdge myEdge;
-   wxRelationship relationship;
-   int margin;
-   int value;
-   int percent;
-   wxEdge otherEdge;
-   bool done;
-
- public:
-   wxIndividualLayoutConstraint(void);
-   ~wxIndividualLayoutConstraint(void);
-
-  void Set(wxRelationship rel, wxWindow *otherW, wxEdge otherE, int val = 0, int marg = wxLAYOUT_DEFAULT_MARGIN);
-
-  //
-  // Sibling relationships
-  //
-  void LeftOf(wxWindow *sibling, int marg = wxLAYOUT_DEFAULT_MARGIN);
-  void RightOf(wxWindow *sibling, int marg = wxLAYOUT_DEFAULT_MARGIN);
-  void Above(wxWindow *sibling, int marg = wxLAYOUT_DEFAULT_MARGIN);
-  void Below(wxWindow *sibling, int marg = wxLAYOUT_DEFAULT_MARGIN);
-
-  //
-  // 'Same edge' alignment
-  //
-  void SameAs(wxWindow *otherW, wxEdge edge, int marg = wxLAYOUT_DEFAULT_MARGIN);
-
-  // The edge is a percentage of the other window's edge
-  void PercentOf(wxWindow *otherW, wxEdge wh, int per);
-
-  //
-  // Edge has absolute value
-  //
-  void Absolute(int val);
-
-  //
-  // Dimension is unconstrained
-  //
-  inline void Unconstrained(void) { relationship = wxUnconstrained; }
-
-  //
-  // Dimension is 'as is' (use current size settings)
-  //
-  inline void AsIs(void) { relationship = wxAsIs; }
-
-  //
-  // Accessors
-  //
-  inline wxWindow *GetOtherWindow(void) { return otherWin; }
-  inline wxEdge GetMyEdge(void) { return myEdge; }
-  inline void SetEdge(wxEdge which) { myEdge = which; }
-  inline void SetValue(int v) { value = v; }
-  inline int GetMargin(void) { return margin; }
-  inline void SetMargin(int m) { margin = m; }
-  inline int GetValue(void) { return value; }
-  inline int GetPercent(void) { return percent; }
-  inline int GetOtherEdge(void) { return otherEdge; }
-  inline bool GetDone(void) { return done; }
-  inline void SetDone(bool d) { done = d; }
-  inline wxRelationship GetRelationship(void) { return relationship; }
-  inline void SetRelationship(wxRelationship r) { relationship = r; }
-
-  // Reset constraint if it mentions otherWin
-  bool ResetIfWin(wxWindow *otherW);
-
-  // Try to satisfy constraint
-  bool SatisfyConstraint(wxLayoutConstraints *constraints, wxWindow *win);
-
-  // Get the value of this edge or dimension, or if this
-  // is not determinable, -1.
-  int GetEdge(wxEdge which, wxWindow *thisWin, wxWindow *other);
+    wxLeft, wxTop, wxRight, wxBottom, wxWidth, wxHeight,
+    wxCentre, wxCenter = wxCentre, wxCentreX, wxCentreY
 };
 
 };
 
-class WXDLLEXPORT wxLayoutConstraints: public wxObject
+enum wxRelationship
 {
 {
-  DECLARE_DYNAMIC_CLASS(wxLayoutConstraints)
-
- public:
-  // Edge constraints
-  wxIndividualLayoutConstraint left;
-  wxIndividualLayoutConstraint top;
-  wxIndividualLayoutConstraint right;
-  wxIndividualLayoutConstraint bottom;
-  // Size constraints
-  wxIndividualLayoutConstraint width;
-  wxIndividualLayoutConstraint height;
-  // Centre constraints
-  wxIndividualLayoutConstraint centreX;
-  wxIndividualLayoutConstraint centreY;
-
-  wxLayoutConstraints(void);
-  ~wxLayoutConstraints(void);
-
-  bool SatisfyConstraints(wxWindow *win, int *noChanges);
+    wxUnconstrained = 0,
+    wxAsIs,
+    wxPercentOf,
+    wxAbove,
+    wxBelow,
+    wxLeftOf,
+    wxRightOf,
+    wxSameAs,
+    wxAbsolute
 };
 
 };
 
-bool WXDLLEXPORT wxOldDoLayout(wxWindow *win);
-
-/*
-
-Algorithm:
-
- Each sizer has a Layout function.
-
- wxExpandSizer::Layout                  ; E.g. for resizeable windows
- 
-   - parent size must be known (i.e. called
-      from OnSize or explicitly)
-   - call Layout on each child to give it a chance to resize
-     (e.g. child shrinks around its own children):
-     stop when all children return TRUE, or no change
-   - evaluate constraints on self to set size
-
- wxShrinkSizer::Layout                  ; E.g. fit-to-contents windows
-                                        ; Perhaps 2 rowcols, one above other.
- 
-   - call Layout on each child to give it a chance to resize
-     (e.g. child shrinks around its own children):
-     stop when each returns TRUE, or no change
-   - fit around children
-        (what if some want to be centred? E.g. OK/Cancel rowcol.
-         - done by centring e.g. bottom sizer w.r.t. top sizer.
-           (sibling relationship only))
-   - evaluate own constraints (e.g. may be below another window)
-   - IF parent is a real window (remember: a real window can
-     have only one child sizer, although a sizer can have several child
-     (real) windows), then resize this parent WITHOUT invoking Layout
-     again.
-     Frame and dialog box OnSizes can check if the sizer is a shrink
-     sizer; if not, can call layout. Maybe have virtual bool AutoSizeLayout()
-     to determine this.
-
-How to relayout if a child sizer/window changes? Need to go all the way
-to the top of the hierarchy and call Layout() again.
-     
- wxRowColSizer::Layout
-
-   - Similar to wxShrinkSizer only instead of shrinking to fit
-     contents, more sophisticated layout of contents, and THEN
-     shrinking (possibly).
-   - Do the same parent window check/setsize as for wxShrinkSizer.
- 
-*/
-
-typedef enum {
-    wxSizerShrink,
-    wxSizerExpand,
-    wxSizerNone
-} wxSizerBehaviour;
-
-#define wxTYPE_SIZER        90
-
-class WXDLLEXPORT wxSizer: public wxWindow
+// ----------------------------------------------------------------------------
+// wxIndividualLayoutConstraint: a constraint on window position
+// ----------------------------------------------------------------------------
+
+class WXDLLIMPEXP_CORE wxIndividualLayoutConstraint : public wxObject
 {
 {
-  DECLARE_DYNAMIC_CLASS(wxSizer)
-
- private:
- protected:
-  wxSizerBehaviour sizerBehaviour;
-  int borderX;
-  int borderY;
-  int sizerWidth;
-  int sizerHeight;
-  int sizerX;
-  int sizerY;
- public:
-  wxSizer(void);
-  wxSizer(wxWindow *parent, wxSizerBehaviour behav = wxSizerNone);
-  ~wxSizer(void);
-
-  bool Create(wxWindow *parent, wxSizerBehaviour behav = wxSizerNone);
-  virtual void SetSize(int x, int y, int w, int h, int flags = wxSIZE_AUTO);
-  // Avoid compiler warning
-  void SetSize(int w, int h) { wxWindow::SetSize(w, h); }
-  virtual void Move(int x, int y);
-  virtual void GetSize(int *w, int *h) const;
-  inline virtual void GetClientSize(int *w, int *h) const { GetSize(w, h); }
-  virtual void GetPosition(int *x, int *y) const;
-
-  inline void SizerSetSize(int x, int y, int w, int h)
-    { SetSize(x, y, w, h); }
-  inline void SizerMove(int x, int y)
-    { Move(x, y); }
-
-  virtual void SetBorder(int w, int h);
-  inline int GetBorderX(void) { return borderX ; }
-  inline int GetBorderY(void) { return borderY ; }
-
-  virtual void AddSizerChild(wxWindow *child);
-  virtual void RemoveSizerChild(wxWindow *child);
-
-  inline virtual void SetBehaviour(wxSizerBehaviour b) { sizerBehaviour = b; }
-  inline virtual wxSizerBehaviour GetBehaviour(void) { return sizerBehaviour; }
-
-  virtual bool LayoutPhase1(int *);
-  virtual bool LayoutPhase2(int *);
+public:
+    wxIndividualLayoutConstraint();
+
+    // note that default copy ctor and assignment operators are ok
+
+    virtual ~wxIndividualLayoutConstraint(){}
+
+    void Set(wxRelationship rel, wxWindowBase *otherW, wxEdge otherE, int val = 0, int marg = wxLAYOUT_DEFAULT_MARGIN);
+
+    //
+    // Sibling relationships
+    //
+    void LeftOf(wxWindowBase *sibling, int marg = wxLAYOUT_DEFAULT_MARGIN);
+    void RightOf(wxWindowBase *sibling, int marg = wxLAYOUT_DEFAULT_MARGIN);
+    void Above(wxWindowBase *sibling, int marg = wxLAYOUT_DEFAULT_MARGIN);
+    void Below(wxWindowBase *sibling, int marg = wxLAYOUT_DEFAULT_MARGIN);
+
+    //
+    // 'Same edge' alignment
+    //
+    void SameAs(wxWindowBase *otherW, wxEdge edge, int marg = wxLAYOUT_DEFAULT_MARGIN);
+
+    // The edge is a percentage of the other window's edge
+    void PercentOf(wxWindowBase *otherW, wxEdge wh, int per);
+
+    //
+    // Edge has absolute value
+    //
+    void Absolute(int val);
+
+    //
+    // Dimension is unconstrained
+    //
+    void Unconstrained() { relationship = wxUnconstrained; }
+
+    //
+    // Dimension is 'as is' (use current size settings)
+    //
+    void AsIs() { relationship = wxAsIs; }
+
+    //
+    // Accessors
+    //
+    wxWindowBase *GetOtherWindow() { return otherWin; }
+    wxEdge GetMyEdge() const { return myEdge; }
+    void SetEdge(wxEdge which) { myEdge = which; }
+    void SetValue(int v) { value = v; }
+    int GetMargin() { return margin; }
+    void SetMargin(int m) { margin = m; }
+    int GetValue() const { return value; }
+    int GetPercent() const { return percent; }
+    int GetOtherEdge() const { return otherEdge; }
+    bool GetDone() const { return done; }
+    void SetDone(bool d) { done = d; }
+    wxRelationship GetRelationship() { return relationship; }
+    void SetRelationship(wxRelationship r) { relationship = r; }
+
+    // Reset constraint if it mentions otherWin
+    bool ResetIfWin(wxWindowBase *otherW);
+
+    // Try to satisfy constraint
+    bool SatisfyConstraint(wxLayoutConstraints *constraints, wxWindowBase *win);
+
+    // Get the value of this edge or dimension, or if this
+    // is not determinable, -1.
+    int GetEdge(wxEdge which, wxWindowBase *thisWin, wxWindowBase *other) const;
+
+protected:
+    // To be allowed to modify the internal variables
+    friend class wxIndividualLayoutConstraint_Serialize;
+
+    // 'This' window is the parent or sibling of otherWin
+    wxWindowBase *otherWin;
+
+    wxEdge myEdge;
+    wxRelationship relationship;
+    int margin;
+    int value;
+    int percent;
+    wxEdge otherEdge;
+    bool done;
+
+    DECLARE_DYNAMIC_CLASS(wxIndividualLayoutConstraint)
 };
 
 };
 
-#define wxSIZER_ROWS  TRUE
-#define wxSIZER_COLS  FALSE
+// ----------------------------------------------------------------------------
+// wxLayoutConstraints: the complete set of constraints for a window
+// ----------------------------------------------------------------------------
 
 
-class WXDLLEXPORT wxRowColSizer: public wxSizer
+class WXDLLIMPEXP_CORE wxLayoutConstraints : public wxObject
 {
 {
-  DECLARE_DYNAMIC_CLASS(wxRowColSizer)
-
- private:
- protected:
-  bool rowOrCol;
-  int rowOrColSize;
-  int xSpacing;
-  int ySpacing;
- public:
-  // rowOrCol = TRUE to be laid out in rows, otherwise in columns.
-  wxRowColSizer(void);
-  wxRowColSizer(wxWindow *parent, bool rowOrCol = wxSIZER_ROWS, int rowsOrColSize = 20, wxSizerBehaviour = wxSizerShrink);
-  ~wxRowColSizer(void);
-
-  bool Create(wxWindow *parent, bool rowOrCol = wxSIZER_ROWS, int rowsOrColSize = 20, wxSizerBehaviour = wxSizerShrink);
-  void SetSize(int x, int y, int w, int h, int flags = wxSIZE_AUTO);
-  // Avoid compiler warning
-  void SetSize(int w, int h) { wxSizer::SetSize(w, h); }
-
-  inline virtual void SetRowOrCol(bool rc) { rowOrCol = rc; }
-  inline virtual bool GetRowOrCol(void) { return rowOrCol; }
-  inline virtual void SetRowOrColSize(int n) { rowOrColSize = n; }
-  inline virtual int GetRowOrColSize(void) { return rowOrColSize; }
-  inline virtual void SetSpacing(int x, int y) { xSpacing = x; ySpacing = y; }
-  inline virtual void GetSpacing(int *x, int *y) { *x = xSpacing; *y = ySpacing; }
-
-  bool LayoutPhase1(int *);
-  bool LayoutPhase2(int *);
+public:
+    // Edge constraints
+    wxIndividualLayoutConstraint left;
+    wxIndividualLayoutConstraint top;
+    wxIndividualLayoutConstraint right;
+    wxIndividualLayoutConstraint bottom;
+    // Size constraints
+    wxIndividualLayoutConstraint width;
+    wxIndividualLayoutConstraint height;
+    // Centre constraints
+    wxIndividualLayoutConstraint centreX;
+    wxIndividualLayoutConstraint centreY;
+
+    wxLayoutConstraints();
+
+    // note that default copy ctor and assignment operators are ok
+
+    virtual ~wxLayoutConstraints(){}
+
+    bool SatisfyConstraints(wxWindowBase *win, int *noChanges);
+    bool AreSatisfied() const
+    {
+        return left.GetDone() && top.GetDone() &&
+               width.GetDone() && height.GetDone();
+    }
+
+    DECLARE_DYNAMIC_CLASS(wxLayoutConstraints)
 };
 
 };
 
-class WXDLLEXPORT wxSpacingSizer: public wxSizer
-{
-  DECLARE_DYNAMIC_CLASS(wxSpacingSizer)
-
- private:
- protected:
- public:
-  wxSpacingSizer(void);
-  wxSpacingSizer(wxWindow *parent, wxRelationship rel, wxWindow *other, int spacing);
-  wxSpacingSizer(wxWindow *parent);
-  ~wxSpacingSizer(void);
-
-  bool Create(wxWindow *parent, wxRelationship rel, wxWindow *other, int sp);
-  bool Create(wxWindow *parent);
-};
+#endif // wxUSE_CONSTRAINTS
 
 
-#endif
-    // __LAYOUTH__
+#endif // _WX_LAYOUT_H_
wxWidgets (Impactor)