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 WXDLLEXPORT 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_id = id;
  67         m_alignment = wxLAYOUT_TOP;
  68         m_orientation = wxLAYOUT_HORIZONTAL;
  69     }
  70 // Read by the app
  71     inline void SetRequestedLength(int length) { m_requestedLength = length; }
  72     inline int GetRequestedLength() const { return m_requestedLength; }
  73
  74     inline void SetFlags(int flags) { m_flags = flags; }
  75     inline int GetFlags() const { return m_flags; }
  76
  77 // Set by the app
  78     inline void SetSize(const wxSize& size) { m_size = size; }
  79     inline wxSize GetSize() const { return m_size; }
  80
  81     inline void SetOrientation(wxLayoutOrientation orient) { m_orientation = orient; }
  82     inline wxLayoutOrientation GetOrientation() const { return m_orientation; }
  83
  84     inline void SetAlignment(wxLayoutAlignment align) { m_alignment = align; }
  85     inline wxLayoutAlignment GetAlignment() const { return m_alignment; }
  86 protected:
  87     int                     m_flags;
  88     int                     m_requestedLength;
  89     wxSize                  m_size;
  90     wxLayoutOrientation     m_orientation;
  91     wxLayoutAlignment       m_alignment;
  92
  93 };
  94
  95 typedef void (wxEvtHandler::*wxQueryLayoutInfoEventFunction)(wxQueryLayoutInfoEvent&);
  96
  97 #define EVT_QUERY_LAYOUT_INFO(func)  { wxEVT_QUERY_LAYOUT_INFO, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxQueryLayoutInfoEventFunction) & func, NULL },
  98
  99 /*
 100  * This event is used to take a bite out of the available client area.
 101  */
 102
 103 class WXDLLEXPORT wxCalculateLayoutEvent: public wxEvent
 104 {
 105 DECLARE_DYNAMIC_CLASS(wxCalculateLayoutEvent)
 106 public:
 107     wxCalculateLayoutEvent(wxWindowID id = 0)
 108     {
 109         SetEventType(wxEVT_CALCULATE_LAYOUT);
 110         m_flags = 0;
 111         m_id = id;
 112     }
 113 // Read by the app
 114     inline void SetFlags(int flags) { m_flags = flags; }
 115     inline int GetFlags() const { return m_flags; }
 116
 117 // Set by the app
 118     inline void SetRect(const wxRect& rect) { m_rect = rect; }
 119     inline wxRect GetRect() const { return m_rect; }
 120 protected:
 121     int                     m_flags;
 122     wxRect                  m_rect;
 123 };
 124
 125 typedef void (wxEvtHandler::*wxCalculateLayoutEventFunction)(wxCalculateLayoutEvent&);
 126
 127 #define EVT_CALCULATE_LAYOUT(func)  { wxEVT_CALCULATE_LAYOUT, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCalculateLayoutEventFunction) & func, NULL },
 128
 129 // This is window that can remember alignment/orientation, does its own layout,
 130 // and can provide sashes too. Useful for implementing docked windows with sashes in
 131 // an IDE-style interface.
 132 class WXDLLEXPORT wxSashLayoutWindow: public wxSashWindow
 133 {
 134     DECLARE_CLASS(wxSashLayoutWindow)
 135 public:
 136     wxSashLayoutWindow(wxWindow *parent, wxWindowID id = -1, const wxPoint& pos = wxDefaultPosition,
 137         const wxSize& size = wxDefaultSize, long style = wxSW_3D|wxCLIP_CHILDREN, const wxString& name = "layoutWindow");
 138
 139 // Accessors
 140     inline wxLayoutAlignment GetAlignment() const { return m_alignment; };
 141     inline wxLayoutOrientation GetOrientation() const { return m_orientation; };
 142
 143     inline void SetAlignment(wxLayoutAlignment align) { m_alignment = align; };
 144     inline void SetOrientation(wxLayoutOrientation orient) { m_orientation = orient; };
 145
 146     // Give the window default dimensions
 147     inline void SetDefaultSize(const wxSize& size) { m_defaultSize = size; }
 148
 149 // Event handlers
 150     // Called by layout algorithm to allow window to take a bit out of the
 151     // client rectangle, and size itself if not in wxLAYOUT_QUERY mode.
 152     void OnCalculateLayout(wxCalculateLayoutEvent& event);
 153
 154     // Called by layout algorithm to retrieve information about the window.
 155     void OnQueryLayoutInfo(wxQueryLayoutInfoEvent& event);
 156 protected:
 157     wxLayoutAlignment           m_alignment;
 158     wxLayoutOrientation         m_orientation;
 159     wxSize                      m_defaultSize;
 160
 161 DECLARE_EVENT_TABLE()
 162 };
 163
 164 class WXDLLEXPORT wxMDIParentFrame;
 165 class WXDLLEXPORT wxFrame;
 166
 167 // This class implements the layout algorithm
 168 class WXDLLEXPORT wxLayoutAlgorithm: public wxObject
 169 {
 170 public:
 171     wxLayoutAlgorithm() {}
 172
 173     // The MDI client window is sized to whatever's left over.
 174     bool LayoutMDIFrame(wxMDIParentFrame* frame, wxRect* rect = (wxRect*) NULL);
 175
 176     // mainWindow is sized to whatever's left over. This function for backward
 177     // compatibility; use LayoutWindow.
 178     bool LayoutFrame(wxFrame* frame, wxWindow* mainWindow = (wxWindow*) NULL)
 179     {
 180         return LayoutWindow(frame, mainWindow);
 181     }
 182
 183     // mainWindow is sized to whatever's left over. This function for backward
 184     bool LayoutWindow(wxWindow* frame, wxWindow* mainWindow = (wxWindow*) NULL);
 185 };
 186
 187 #endif
 188     // _WX_LAYWIN_H_G_