]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/generic/laywin.h
Fix missing documentation for several GDI functions.
[wxWidgets.git] / include / wx / generic / laywin.h
index 81785a3d6d303f7794d474bc54ecfb0be8fb1d2c..76ec0a8f5ae25f03e0ee74d7cb087ee5b36015c5 100644 (file)
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        laywin.h
+// Name:        wx/generic/laywin.h
 // Purpose:     Implements a simple layout algorithm, plus
 //              wxSashLayoutWindow which is an example of a window with
 //              layout-awareness (via event handlers). This is suited to
 #ifndef _WX_LAYWIN_H_G_
 #define _WX_LAYWIN_H_G_
 
-#ifdef __GNUG__
-#pragma interface "laywin.h"
-#endif
-
 #if wxUSE_SASH
     #include "wx/sashwin.h"
 #endif // wxUSE_SASH
 
-BEGIN_DECLARE_EVENT_TYPES()
-    DECLARE_EVENT_TYPE(wxEVT_QUERY_LAYOUT_INFO, 1500)
-    DECLARE_EVENT_TYPE(wxEVT_CALCULATE_LAYOUT, 1501)
-END_DECLARE_EVENT_TYPES()
+#include "wx/event.h"
+
+class WXDLLIMPEXP_FWD_ADV wxQueryLayoutInfoEvent;
+class WXDLLIMPEXP_FWD_ADV wxCalculateLayoutEvent;
+
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_QUERY_LAYOUT_INFO, wxQueryLayoutInfoEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_CALCULATE_LAYOUT,  wxCalculateLayoutEvent );
 
 enum wxLayoutOrientation
 {
@@ -59,11 +58,9 @@ enum wxLayoutAlignment
  * orientation and size.
  */
 
-class WXDLLEXPORT wxQueryLayoutInfoEvent: public wxEvent
+class WXDLLIMPEXP_ADV wxQueryLayoutInfoEvent: public wxEvent
 {
-DECLARE_DYNAMIC_CLASS(wxQueryLayoutInfoEvent)
 public:
-
     wxQueryLayoutInfoEvent(wxWindowID id = 0)
     {
         SetEventType(wxEVT_QUERY_LAYOUT_INFO);
@@ -91,6 +88,8 @@ public:
     void SetAlignment(wxLayoutAlignment align) { m_alignment = align; }
     wxLayoutAlignment GetAlignment() const { return m_alignment; }
 
+    virtual wxEvent *Clone() const { return new wxQueryLayoutInfoEvent(*this); }
+
 protected:
     int                     m_flags;
     int                     m_requestedLength;
@@ -98,20 +97,24 @@ protected:
     wxLayoutOrientation     m_orientation;
     wxLayoutAlignment       m_alignment;
 
+private:
+    DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxQueryLayoutInfoEvent)
 };
 
 typedef void (wxEvtHandler::*wxQueryLayoutInfoEventFunction)(wxQueryLayoutInfoEvent&);
 
+#define wxQueryLayoutInfoEventHandler( func ) \
+    wxEVENT_HANDLER_CAST( wxQueryLayoutInfoEventFunction, func )
+
 #define EVT_QUERY_LAYOUT_INFO(func) \
-    DECLARE_EVENT_TABLE_ENTRY( wxEVT_QUERY_LAYOUT_INFO, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxQueryLayoutInfoEventFunction) & func, NULL ),
+    wxDECLARE_EVENT_TABLE_ENTRY( wxEVT_QUERY_LAYOUT_INFO, wxID_ANY, wxID_ANY, wxQueryLayoutInfoEventHandler( func ), NULL ),
 
 /*
  * This event is used to take a bite out of the available client area.
  */
 
-class WXDLLEXPORT wxCalculateLayoutEvent: public wxEvent
+class WXDLLIMPEXP_ADV wxCalculateLayoutEvent: public wxEvent
 {
-DECLARE_DYNAMIC_CLASS(wxCalculateLayoutEvent)
 public:
     wxCalculateLayoutEvent(wxWindowID id = 0)
     {
@@ -119,52 +122,60 @@ public:
         m_flags = 0;
         m_id = id;
     }
-// Read by the app
-    inline void SetFlags(int flags) { m_flags = flags; }
-    inline int GetFlags() const { return m_flags; }
 
-// Set by the app
-    inline void SetRect(const wxRect& rect) { m_rect = rect; }
-    inline wxRect GetRect() const { return m_rect; }
+    // Read by the app
+    void SetFlags(int flags) { m_flags = flags; }
+    int GetFlags() const { return m_flags; }
+
+    // Set by the app
+    void SetRect(const wxRect& rect) { m_rect = rect; }
+    wxRect GetRect() const { return m_rect; }
+
+    virtual wxEvent *Clone() const { return new wxCalculateLayoutEvent(*this); }
+
 protected:
     int                     m_flags;
     wxRect                  m_rect;
+
+private:
+    DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxCalculateLayoutEvent)
 };
 
 typedef void (wxEvtHandler::*wxCalculateLayoutEventFunction)(wxCalculateLayoutEvent&);
 
+#define wxCalculateLayoutEventHandler( func ) wxEVENT_HANDLER_CAST(wxCalculateLayoutEventFunction, func)
+
 #define EVT_CALCULATE_LAYOUT(func) \
-    DECLARE_EVENT_TABLE_ENTRY( wxEVT_CALCULATE_LAYOUT, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCalculateLayoutEventFunction) & func, NULL ),
+    wxDECLARE_EVENT_TABLE_ENTRY( wxEVT_CALCULATE_LAYOUT, wxID_ANY, wxID_ANY, wxCalculateLayoutEventHandler( func ), NULL ),
 
 #if wxUSE_SASH
 
 // This is window that can remember alignment/orientation, does its own layout,
 // and can provide sashes too. Useful for implementing docked windows with sashes in
 // an IDE-style interface.
-class WXDLLEXPORT wxSashLayoutWindow: public wxSashWindow
+class WXDLLIMPEXP_ADV wxSashLayoutWindow: public wxSashWindow
 {
-    DECLARE_CLASS(wxSashLayoutWindow)
 public:
     wxSashLayoutWindow()
     {
         Init();
     }
 
-    wxSashLayoutWindow(wxWindow *parent, wxWindowID id = -1, const wxPoint& pos = wxDefaultPosition,
-        const wxSize& size = wxDefaultSize, long style = wxSW_3D|wxCLIP_CHILDREN, const wxString& name = "layoutWindow")
+    wxSashLayoutWindow(wxWindow *parent, wxWindowID id = wxID_ANY, const wxPoint& pos = wxDefaultPosition,
+        const wxSize& size = wxDefaultSize, long style = wxSW_3D|wxCLIP_CHILDREN, const wxString& name = wxT("layoutWindow"))
     {
         Create(parent, id, pos, size, style, name);
     }
 
-    bool Create(wxWindow *parent, wxWindowID id = -1, const wxPoint& pos = wxDefaultPosition,
-        const wxSize& size = wxDefaultSize, long style = wxSW_3D|wxCLIP_CHILDREN, const wxString& name = "layoutWindow");
+    bool Create(wxWindow *parent, wxWindowID id = wxID_ANY, const wxPoint& pos = wxDefaultPosition,
+        const wxSize& size = wxDefaultSize, long style = wxSW_3D|wxCLIP_CHILDREN, const wxString& name = wxT("layoutWindow"));
 
 // Accessors
-    inline wxLayoutAlignment GetAlignment() const { return m_alignment; };
-    inline wxLayoutOrientation GetOrientation() const { return m_orientation; };
+    inline wxLayoutAlignment GetAlignment() const { return m_alignment; }
+    inline wxLayoutOrientation GetOrientation() const { return m_orientation; }
 
-    inline void SetAlignment(wxLayoutAlignment align) { m_alignment = align; };
-    inline void SetOrientation(wxLayoutOrientation orient) { m_orientation = orient; };
+    inline void SetAlignment(wxLayoutAlignment align) { m_alignment = align; }
+    inline void SetOrientation(wxLayoutOrientation orient) { m_orientation = orient; }
 
     // Give the window default dimensions
     inline void SetDefaultSize(const wxSize& size) { m_defaultSize = size; }
@@ -184,34 +195,33 @@ private:
     wxLayoutOrientation         m_orientation;
     wxSize                      m_defaultSize;
 
-DECLARE_EVENT_TABLE()
+private:
+    DECLARE_DYNAMIC_CLASS_NO_COPY(wxSashLayoutWindow)
+    DECLARE_EVENT_TABLE()
 };
 
 #endif // wxUSE_SASH
 
-class WXDLLEXPORT wxMDIParentFrame;
-class WXDLLEXPORT wxFrame;
+class WXDLLIMPEXP_FWD_CORE wxMDIParentFrame;
+class WXDLLIMPEXP_FWD_CORE wxFrame;
 
 // This class implements the layout algorithm
-class WXDLLEXPORT wxLayoutAlgorithm: public wxObject
+class WXDLLIMPEXP_ADV wxLayoutAlgorithm: public wxObject
 {
 public:
     wxLayoutAlgorithm() {}
 
 #if wxUSE_MDI_ARCHITECTURE
     // The MDI client window is sized to whatever's left over.
-    bool LayoutMDIFrame(wxMDIParentFrame* frame, wxRect* rect = (wxRect*) NULL);
+    bool LayoutMDIFrame(wxMDIParentFrame* frame, wxRect* rect = NULL);
 #endif // wxUSE_MDI_ARCHITECTURE
 
     // mainWindow is sized to whatever's left over. This function for backward
     // compatibility; use LayoutWindow.
-    bool LayoutFrame(wxFrame* frame, wxWindow* mainWindow = (wxWindow*) NULL)
-    {
-        return LayoutWindow(frame, mainWindow);
-    }
+    bool LayoutFrame(wxFrame* frame, wxWindow* mainWindow = NULL);
 
     // mainWindow is sized to whatever's left over.
-    bool LayoutWindow(wxWindow* frame, wxWindow* mainWindow = (wxWindow*) NULL);
+    bool LayoutWindow(wxWindow* frame, wxWindow* mainWindow = NULL);
 };
 
 #endif