include/wx/generic/laywin.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        laywin.h
   3 // Purpose:     Implements a simple layout algorithm, plus
   4 //              wxSashLayoutWindow which is an example of a window with
   5 //              layout-awareness (via event handlers). This is suited to
   6 //              IDE-style window layout.
   7 // Author:      Julian Smart
   8 // Modified by:
   9 // Created:     04/01/98
  10 // RCS-ID:      $Id$
  11 // Copyright:   (c) Julian Smart
  12 // Licence:     wxWindows licence
  13 /////////////////////////////////////////////////////////////////////////////
  14
  15 #ifndef _WX_LAYWIN_H_G_
  16 #define _WX_LAYWIN_H_G_
  17
  18 #ifdef __GNUG__
  19 #pragma interface "laywin.h"
  20 #endif
  21
  22 #include "wx/sashwin.h"
  23
  24 const wxEventType wxEVT_QUERY_LAYOUT_INFO =     wxEVT_FIRST + 1500;
  25 const wxEventType wxEVT_CALCULATE_LAYOUT =      wxEVT_FIRST + 1501;
  26
  27 enum wxLayoutOrientation {
  28     wxLAYOUT_HORIZONTAL,
  29     wxLAYOUT_VERTICAL
  30 };
  31
  32 enum wxLayoutAlignment {
  33     wxLAYOUT_NONE,
  34     wxLAYOUT_TOP,
  35     wxLAYOUT_LEFT,
  36     wxLAYOUT_RIGHT,
  37     wxLAYOUT_BOTTOM,
  38 };
  39
  40 // Not sure this is necessary
  41 // Tell window which dimension we're sizing on
  42 #define wxLAYOUT_LENGTH_Y       0x0008
  43 #define wxLAYOUT_LENGTH_X       0x0000
  44
  45 // Use most recently used length
  46 #define wxLAYOUT_MRU_LENGTH     0x0010
  47
  48 // Only a query, so don't actually move it.
  49 #define wxLAYOUT_QUERY          0x0100
  50
  51 /*
  52  * This event is used to get information about window alignment,
  53  * orientation and size.
  54  */
  55
  56 class wxQueryLayoutInfoEvent: public wxEvent
  57 {
  58 DECLARE_DYNAMIC_CLASS(wxQueryLayoutInfoEvent)
  59 public:
  60
  61     wxQueryLayoutInfoEvent(wxWindowID id = 0)
  62     {
  63         SetEventType(wxEVT_QUERY_LAYOUT_INFO);
  64         m_requestedLength = 0;
  65         m_flags = 0;
  66         m_alignment = wxLAYOUT_TOP;
  67         m_orientation = wxLAYOUT_HORIZONTAL;
  68     }
  69 // Read by the app
  70     inline void SetRequestedLength(int length) { m_requestedLength = length; }
  71     inline int GetRequestedLength() const { return m_requestedLength; }
  72
  73     inline void SetFlags(int flags) { m_flags = flags; }
  74     inline int GetFlags() const { return m_flags; }
  75
  76 // Set by the app
  77     inline void SetSize(const wxSize& size) { m_size = size; }
  78     inline wxSize GetSize() const { return m_size; }
  79
  80     inline void SetOrientation(wxLayoutOrientation orient) { m_orientation = orient; }
  81     inline wxLayoutOrientation GetOrientation() const { return m_orientation; }
  82
  83     inline void SetAlignment(wxLayoutAlignment align) { m_alignment = align; }
  84     inline wxLayoutAlignment GetAlignment() const { return m_alignment; }
  85 protected:
  86     int                     m_flags;
  87     int                     m_requestedLength;
  88     wxSize                  m_size;
  89     wxLayoutOrientation     m_orientation;
  90     wxLayoutAlignment       m_alignment;
  91
  92 };
  93
  94 typedef void (wxEvtHandler::*wxQueryLayoutInfoEventFunction)(wxQueryLayoutInfoEvent&);
  95
  96 #define EVT_QUERY_LAYOUT_INFO(func)  { wxEVT_QUERY_LAYOUT_INFO, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxQueryLayoutInfoEventFunction) & func, NULL },
  97
  98 /*
  99  * This event is used to take a bite out of the available client area.
 100  */
 101
 102 class wxCalculateLayoutEvent: public wxEvent
 103 {
 104 DECLARE_DYNAMIC_CLASS(wxCalculateLayoutEvent)
 105 public:
 106     wxCalculateLayoutEvent(wxWindowID id = 0)
 107     {
 108         SetEventType(wxEVT_CALCULATE_LAYOUT);
 109         m_flags = 0;
 110     }
 111 // Read by the app
 112     inline void SetFlags(int flags) { m_flags = flags; }
 113     inline int GetFlags() const { return m_flags; }
 114
 115 // Set by the app
 116     inline void SetRect(const wxRect& rect) { m_rect = rect; }
 117     inline wxRect GetRect() const { return m_rect; }
 118 protected:
 119     int                     m_flags;
 120     wxRect                  m_rect;
 121 };
 122
 123 typedef void (wxEvtHandler::*wxCalculateLayoutEventFunction)(wxCalculateLayoutEvent&);
 124
 125 #define EVT_CALCULATE_LAYOUT(func)  { wxEVT_CALCULATE_LAYOUT, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCalculateLayoutEventFunction) & func, NULL },
 126
 127 // This is window that can remember alignment/orientation, does its own layout,
 128 // and can provide sashes too. Useful for implementing docked windows with sashes in
 129 // an IDE-style interface.
 130 class wxSashLayoutWindow: public wxSashWindow
 131 {
 132     DECLARE_CLASS(wxSashLayoutWindow)
 133 public:
 134     wxSashLayoutWindow(wxWindow *parent, wxWindowID id = -1, const wxPoint& pos = wxDefaultPosition,
 135         const wxSize& size = wxDefaultSize, long style = wxSW_3D|wxCLIP_CHILDREN, const wxString& name = "layoutWindow");
 136
 137 // Accessors
 138     inline wxLayoutAlignment GetAlignment() const { return m_alignment; };
 139     inline wxLayoutOrientation GetOrientation() const { return m_orientation; };
 140
 141     inline void SetAlignment(wxLayoutAlignment align) { m_alignment = align; };
 142     inline void SetOrientation(wxLayoutOrientation orient) { m_orientation = orient; };
 143
 144     // Give the window default dimensions
 145     inline void SetDefaultSize(const wxSize& size) { m_defaultSize = size; }
 146
 147 // Event handlers
 148     // Called by layout algorithm to allow window to take a bit out of the
 149     // client rectangle, and size itself if not in wxLAYOUT_QUERY mode.
 150     void OnCalculateLayout(wxCalculateLayoutEvent& event);
 151
 152     // Called by layout algorithm to retrieve information about the window.
 153     void OnQueryLayoutInfo(wxQueryLayoutInfoEvent& event);
 154 protected:
 155     wxLayoutAlignment           m_alignment;
 156     wxLayoutOrientation         m_orientation;
 157     wxSize                      m_defaultSize;
 158
 159 DECLARE_EVENT_TABLE()
 160 };
 161
 162 class WXDLLEXPORT wxMDIParentFrame;
 163 class WXDLLEXPORT wxFrame;
 164
 165 // This class implements the layout algorithm
 166 class wxLayoutAlgorithm: public wxObject
 167 {
 168 public:
 169     wxLayoutAlgorithm() {}
 170
 171     // The MDI client window is sized to whatever's left over.
 172     bool LayoutMDIFrame(wxMDIParentFrame* frame);
 173
 174     // mainWindow is sized to whatever's left over.
 175     bool LayoutFrame(wxFrame* frame, wxWindow* mainWindow);
 176 };
 177
 178 #endif
 179     // _WX_LAYWIN_H_G_