Resolve ambiguity between GetClientXXX() methods in wxOSX wxComboBox.

[wxWidgets.git] / interface / wx / aui / framemanager.h

diff --git a/interface/wx/aui/framemanager.h b/interface/wx/aui/framemanager.h
index 2ad6b9471f78e729bf5c696f2665d33dbe591287..25a0c73ddbeb4555b736c4f9ccf917f4593e9bfe 100644 (file)
--- a/interface/wx/aui/framemanager.h
+++ b/interface/wx/aui/framemanager.h
@@ -3,12 +3,12 @@
 // Purpose:     interface of wxAuiManager
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxAuiManager
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 
 /**
 /////////////////////////////////////////////////////////////////////////////
 
 
 /**

-    @todo TOWRITE
+    @todo wxAuiPaneInfo dock direction types used with wxAuiManager.

 */
 enum wxAuiManagerDock
 {
 */
 enum wxAuiManagerDock
 {


@@ -23,7 +23,7 @@ enum wxAuiManagerDock
 
 
 /**
 
 
 /**

-    @todo TOWRITE
+    @todo wxAuiManager behaviour style flags.

 */
 enum wxAuiManagerOption
 {
 */
 enum wxAuiManagerOption
 {


@@ -35,6 +35,7 @@ enum wxAuiManagerOption
     wxAUI_MGR_RECTANGLE_HINT           = 1 << 5,
     wxAUI_MGR_HINT_FADE                = 1 << 6,
     wxAUI_MGR_NO_VENETIAN_BLINDS_FADE  = 1 << 7,
     wxAUI_MGR_RECTANGLE_HINT           = 1 << 5,
     wxAUI_MGR_HINT_FADE                = 1 << 6,
     wxAUI_MGR_NO_VENETIAN_BLINDS_FADE  = 1 << 7,

+    wxAUI_MGR_LIVE_RESIZE              = 1 << 8,

 
     wxAUI_MGR_DEFAULT = wxAUI_MGR_ALLOW_FLOATING |
                         wxAUI_MGR_TRANSPARENT_HINT |
 
     wxAUI_MGR_DEFAULT = wxAUI_MGR_ALLOW_FLOATING |
                         wxAUI_MGR_TRANSPARENT_HINT |


@@ -46,16 +47,15 @@ enum wxAuiManagerOption
     @class wxAuiManager
 
     wxAuiManager is the central class of the wxAUI class framework.
     @class wxAuiManager
 
     wxAuiManager is the central class of the wxAUI class framework.

-    See also @ref overview_aui.

 
     wxAuiManager manages the panes associated with it for a particular wxFrame,
     using a pane's wxAuiPaneInfo information to determine each pane's docking
 
     wxAuiManager manages the panes associated with it for a particular wxFrame,
     using a pane's wxAuiPaneInfo information to determine each pane's docking

-    and floating behavior.
+    and floating behaviour.

 
 

-    wxAuiManager uses wxWidgets' sizer mechanism to plan the layout of each frame.
-    It uses a replaceable dock art class to do all drawing, so all drawing is
-    localized in one area, and may be customized depending on an application's
-    specific needs.
+    wxAuiManager uses wxWidgets' sizer mechanism to plan the layout of each
+    frame. It uses a replaceable dock art class to do all drawing, so all
+    drawing is localized in one area, and may be customized depending on an
+    application's specific needs.

 
     wxAuiManager works as follows: the programmer adds panes to the class,
     or makes changes to existing pane properties (dock position, floating
 
     wxAuiManager works as follows: the programmer adds panes to the class,
     or makes changes to existing pane properties (dock position, floating


@@ -69,8 +69,8 @@ enum wxAuiManagerOption
     @code
     wxTextCtrl* text1 = new wxTextCtrl(this, -1);
     wxTextCtrl* text2 = new wxTextCtrl(this, -1);
     @code
     wxTextCtrl* text1 = new wxTextCtrl(this, -1);
     wxTextCtrl* text2 = new wxTextCtrl(this, -1);

-    m_mgr.AddPane(text1, wxLEFT, wxT("Pane Caption"));
-    m_mgr.AddPane(text2, wxBOTTOM, wxT("Pane Caption"));
+    m_mgr.AddPane(text1, wxLEFT, "Pane Caption");
+    m_mgr.AddPane(text2, wxBOTTOM, "Pane Caption");

     m_mgr.Update();
     @endcode
 
     m_mgr.Update();
     @endcode
 


@@ -85,40 +85,57 @@ enum wxAuiManagerOption
     @section auimanager_layers Layers, Rows and Directions, Positions
 
     Inside wxAUI, the docking layout is figured out by checking several pane
     @section auimanager_layers Layers, Rows and Directions, Positions
 
     Inside wxAUI, the docking layout is figured out by checking several pane

-    parameters. Four of these are important for determining where a pane will end up:
-
-    @li Direction: Each docked pane has a direction, Top, Bottom, Left, Right, or Center.
-        This is fairly self-explanatory. The pane will be placed in the location specified
-        by this variable.
-    @li Position: More than one pane can be placed inside of a dock. Imagine two panes
-        being docked on the left side of a window. One pane can be placed over another.
-        In proportionally managed docks, the pane position indicates its sequential position,
-        starting with zero. So, in our scenario with two panes docked on the left side,
-        the top pane in the dock would have position 0, and the second one would occupy
+    parameters. Four of these are important for determining where a pane will
+    end up:
+
+    @li Direction: Each docked pane has a direction, Top, Bottom, Left, Right,
+        or Center. This is fairly self-explanatory. The pane will be placed in
+        the location specified by this variable.
+    @li Position: More than one pane can be placed inside of a dock. Imagine
+        two panes being docked on the left side of a window. One pane can be
+        placed over another. In proportionally managed docks, the pane
+        position indicates its sequential position, starting with zero. So, in
+        our scenario with two panes docked on the left side, the top pane in
+        the dock would have position 0, and the second one would occupy

         position 1.
         position 1.

-    @li Row: A row can allow for two docks to be placed next to each other. One of the
-        most common places for this to happen is in the toolbar. Multiple toolbar rows
-        are allowed, the first row being row 0, and the second row 1. Rows can also be
-        used on vertically docked panes.
-    @li Layer: A layer is akin to an onion. Layer 0 is the very center of the managed pane.
-        Thus, if a pane is in layer 0, it will be closest to the center window (also
-        sometimes known as the "content window"). Increasing layers "swallow up" all
-        layers of a lower value. This can look very similar to multiple rows, but is
-        different because all panes in a lower level yield to panes in higher levels.
-        The best way to understand layers is by running the wxAUI sample.
-
+    @li Row: A row can allow for two docks to be placed next to each other.
+        One of the most common places for this to happen is in the toolbar.
+        Multiple toolbar rows are allowed, the first row being row 0, and the
+        second row 1. Rows can also be used on vertically docked panes.
+    @li Layer: A layer is akin to an onion. Layer 0 is the very center of the
+        managed pane. Thus, if a pane is in layer 0, it will be closest to the
+        center window (also sometimes known as the "content window").
+        Increasing layers "swallow up" all layers of a lower value. This can
+        look very similar to multiple rows, but is different because all panes
+        in a lower level yield to panes in higher levels. The best way to
+        understand layers is by running the wxAUI sample.
+
+
+    @beginEventEmissionTable{wxAuiManagerEvent}
+    @event{EVT_AUI_PANE_BUTTON(func)}
+        Triggered when any button is pressed for any docked panes.
+    @event{EVT_AUI_PANE_CLOSE(func)}
+        Triggered when a docked or floating pane is closed.
+    @event{EVT_AUI_PANE_MAXIMIZE(func)}
+        Triggered when a pane is maximized.
+    @event{EVT_AUI_PANE_RESTORE(func)}
+        Triggered when a pane is restored.
+    @event{EVT_AUI_RENDER(func)}
+        This event can be caught to override the default renderer in order to
+        custom draw your wxAuiManager window (not recommended).
+    @endEventTable

 
     @library{wxbase}
     @category{aui}
 
 
     @library{wxbase}
     @category{aui}
 

-    @see wxAuiPaneInfo, wxAuiDockArt
+    @see @ref overview_aui, wxAuiNotebook, wxAuiDockArt, wxAuiPaneInfo

 */
 class wxAuiManager : public wxEvtHandler
 {
 public:
     /**
         Constructor. @a managed_wnd specifies the wxFrame which should be managed.
 */
 class wxAuiManager : public wxEvtHandler
 {
 public:
     /**
         Constructor. @a managed_wnd specifies the wxFrame which should be managed.

-        @a flags  specifies options which allow the frame management behavior
+        @a flags  specifies options which allow the frame management behaviour

         to be modified.
     */
     wxAuiManager(wxWindow* managed_wnd = NULL,
         to be modified.
     */
     wxAuiManager(wxWindow* managed_wnd = NULL,


@@ -202,8 +219,8 @@ public:
         interface. If the lookup failed (meaning the pane could not be found in the
         manager), a call to the returned wxAuiPaneInfo's IsOk() method will return @false.
     */
         interface. If the lookup failed (meaning the pane could not be found in the
         manager), a call to the returned wxAuiPaneInfo's IsOk() method will return @false.
     */

-    wxAuiPaneInfo GetPane(wxWindow* window);
-    wxAuiPaneInfo GetPane(const wxString& name);
+    wxAuiPaneInfo& GetPane(wxWindow* window);
+    wxAuiPaneInfo& GetPane(const wxString& name);

     //@}
 
     /**
     //@}
 
     /**


@@ -227,7 +244,7 @@ public:
                     int insert_level = wxAUI_INSERT_PANE);
 
     /**
                     int insert_level = wxAUI_INSERT_PANE);
 
     /**

-        LoadPaneInfo() is similar to to LoadPerspective, with the exception that it
+        LoadPaneInfo() is similar to LoadPerspective, with the exception that it

         only loads information about a single pane.  It is used in combination with
         SavePaneInfo().
     */
         only loads information about a single pane.  It is used in combination with
         SavePaneInfo().
     */


@@ -282,9 +299,9 @@ public:
 
     /**
         This method is used to specify wxAuiManager's settings flags. @a flags
 
     /**
         This method is used to specify wxAuiManager's settings flags. @a flags

-        specifies options which allow the frame management behavior to be modified.
+        specifies options which allow the frame management behaviour to be modified.

     */
     */

-    void SetFlags(int flags);
+    void SetFlags(unsigned int flags);

 
     /**
         Called to specify the frame or window which is to be managed by wxAuiManager.
 
     /**
         Called to specify the frame or window which is to be managed by wxAuiManager.


@@ -365,8 +382,8 @@ public:
         BestSize() sets the ideal size for the pane. The docking manager will attempt
         to use this size as much as possible when docking or floating the pane.
     */
         BestSize() sets the ideal size for the pane. The docking manager will attempt
         to use this size as much as possible when docking or floating the pane.
     */

-    wxAuiPaneInfo BestSize(const wxSize& size);
-    wxAuiPaneInfo BestSize(int x, int y);
+    wxAuiPaneInfo& BestSize(const wxSize& size);
+    wxAuiPaneInfo& BestSize(int x, int y);

     //@}
 
     /**
     //@}
 
     /**


@@ -399,8 +416,8 @@ public:
         right, bottom) are subtracted from the layout.
         This is the same thing as calling Direction(wxAUI_DOCK_CENTRE).
     */
         right, bottom) are subtracted from the layout.
         This is the same thing as calling Direction(wxAUI_DOCK_CENTRE).
     */

-    wxAuiPaneInfo Centre();
-    wxAuiPaneInfo Center();
+    wxAuiPaneInfo& Centre();
+    wxAuiPaneInfo& Center();

     //@}
 
     //@{
     //@}
 
     //@{


@@ -410,8 +427,8 @@ public:
         This function provides an easy way of preparing a pane to be displayed in
         the center dock position.
     */
         This function provides an easy way of preparing a pane to be displayed in
         the center dock position.
     */

-    wxAuiPaneInfo CentrePane();
-    wxAuiPaneInfo CenterPane();
+    wxAuiPaneInfo& CentrePane();
+    wxAuiPaneInfo& CenterPane();

     //@}
 
     /**
     //@}
 
     /**


@@ -425,7 +442,7 @@ public:
     wxAuiPaneInfo& DefaultPane();
 
     /**
     wxAuiPaneInfo& DefaultPane();
 
     /**

-        DestroyOnClose() indicates whether a pane should be detroyed when it is closed.
+        DestroyOnClose() indicates whether a pane should be destroyed when it is closed.

         Normally a pane is simply hidden when the close button is clicked.
         Setting DestroyOnClose to @true will cause the window to be destroyed when
         the user clicks the pane's close button.
         Normally a pane is simply hidden when the close button is clicked.
         Setting DestroyOnClose to @true will cause the window to be destroyed when
         the user clicks the pane's close button.


@@ -478,16 +495,16 @@ public:
     /**
         FloatingPosition() sets the position of the floating pane.
     */
     /**
         FloatingPosition() sets the position of the floating pane.
     */

-    wxAuiPaneInfo FloatingPosition(const wxPoint& pos);
-    wxAuiPaneInfo FloatingPosition(int x, int y);
+    wxAuiPaneInfo& FloatingPosition(const wxPoint& pos);
+    wxAuiPaneInfo& FloatingPosition(int x, int y);

     //@}
 
     //@{
     /**
         FloatingSize() sets the size of the floating pane.
     */
     //@}
 
     //@{
     /**
         FloatingSize() sets the size of the floating pane.
     */

-    wxAuiPaneInfo FloatingSize(const wxSize& size);
-    wxAuiPaneInfo FloatingSize(int x, int y);
+    wxAuiPaneInfo& FloatingSize(const wxSize& size);
+    wxAuiPaneInfo& FloatingSize(int x, int y);

     //@}
 
     /**
     //@}
 
     /**


@@ -553,14 +570,36 @@ public:
     */
     wxAuiPaneInfo& Hide();
 
     */
     wxAuiPaneInfo& Hide();
 

+    /**
+        Icon() sets the icon of the pane.
+
+        Notice that the height of the icon should be smaller than the value
+        returned by wxAuiDockArt::GetMetric(wxAUI_DOCKART_CAPTION_SIZE) to
+        ensure that it appears correctly.
+
+        @since 2.9.2
+    */
+    wxAuiPaneInfo& Icon(const wxBitmap& b);
+

     /**
         IsBottomDockable() returns @true if the pane can be docked at the bottom of the
         managed frame.
     /**
         IsBottomDockable() returns @true if the pane can be docked at the bottom of the
         managed frame.

+
+        @see IsDockable()

     */
     bool IsBottomDockable() const;
 
     /**
     */
     bool IsBottomDockable() const;
 
     /**

-        IsDocked() returns @true if the pane is docked.
+        Returns @true if the pane can be docked at any side.
+
+        @see IsTopDockable(), IsBottomDockable(), IsLeftDockable(), IsRightDockable()
+
+        @since 2.9.2
+    */
+    bool IsDockable() const;
+
+    /**
+        IsDocked() returns @true if the pane is currently docked.

     */
     bool IsDocked() const;
 
     */
     bool IsDocked() const;
 


@@ -583,6 +622,8 @@ public:
     /**
         IsLeftDockable() returns @true if the pane can be docked on the left of the
         managed frame.
     /**
         IsLeftDockable() returns @true if the pane can be docked on the left of the
         managed frame.

+
+        @see IsDockable()

     */
     bool IsLeftDockable() const;
 
     */
     bool IsLeftDockable() const;
 


@@ -606,6 +647,8 @@ public:
     /**
         IsRightDockable() returns @true if the pane can be docked on the right of the
         managed frame.
     /**
         IsRightDockable() returns @true if the pane can be docked on the right of the
         managed frame.

+
+        @see IsDockable()

     */
     bool IsRightDockable() const;
 
     */
     bool IsRightDockable() const;
 


@@ -622,6 +665,8 @@ public:
     /**
         IsTopDockable() returns @true if the pane can be docked at the top of the
         managed frame.
     /**
         IsTopDockable() returns @true if the pane can be docked at the top of the
         managed frame.

+
+        @see IsDockable()

     */
     bool IsTopDockable() const;
 
     */
     bool IsTopDockable() const;
 


@@ -648,8 +693,8 @@ public:
     /**
         MaxSize() sets the maximum size of the pane.
     */
     /**
         MaxSize() sets the maximum size of the pane.
     */

-    wxAuiPaneInfo MaxSize(const wxSize& size);
-    wxAuiPaneInfo MaxSize(int x, int y);
+    wxAuiPaneInfo& MaxSize(const wxSize& size);
+    wxAuiPaneInfo& MaxSize(int x, int y);

     //@}
 
     /**
     //@}
 
     /**


@@ -662,8 +707,8 @@ public:
         MinSize() sets the minimum size of the pane. Please note that this is only
         partially supported as of this writing.
     */
         MinSize() sets the minimum size of the pane. Please note that this is only
         partially supported as of this writing.
     */

-    wxAuiPaneInfo MinSize(const wxSize& size);
-    wxAuiPaneInfo MinSize(int x, int y);
+    wxAuiPaneInfo& MinSize(const wxSize& size);
+    wxAuiPaneInfo& MinSize(int x, int y);

     //@}
 
     /**
     //@}
 
     /**


@@ -730,7 +775,7 @@ public:
         SetFlag() turns the property given by flag on or off with the option_state
         parameter.
     */
         SetFlag() turns the property given by flag on or off with the option_state
         parameter.
     */

-    wxAuiPaneInfo& SetFlag(unsigned int flag, bool option_state);
+    wxAuiPaneInfo& SetFlag(int flag, bool option_state);

 
     /**
         Show() indicates that a pane should be shown.
 
     /**
         Show() indicates that a pane should be shown.


@@ -767,3 +812,104 @@ public:
     wxAuiPaneInfo& operator=(const wxAuiPaneInfo& c);
 };
 
     wxAuiPaneInfo& operator=(const wxAuiPaneInfo& c);
 };
 

+
+
+/**
+    @class wxAuiManagerEvent
+
+    Event used to indicate various actions taken with wxAuiManager.
+
+    See wxAuiManager for available event types.
+
+    @beginEventTable{wxAuiManagerEvent}
+    @event{EVT_AUI_PANE_BUTTON(func)}
+        Triggered when any button is pressed for any docked panes.
+    @event{EVT_AUI_PANE_CLOSE(func)}
+        Triggered when a docked or floating pane is closed.
+    @event{EVT_AUI_PANE_MAXIMIZE(func)}
+        Triggered when a pane is maximized.
+    @event{EVT_AUI_PANE_RESTORE(func)}
+        Triggered when a pane is restored.
+    @event{EVT_AUI_RENDER(func)}
+        This event can be caught to override the default renderer in order to
+        custom draw your wxAuiManager window (not recommended).
+    @endEventTable
+    
+    @library{wxaui}
+    @category{events,aui}
+
+    @see wxAuiManager, wxAuiPaneInfo
+*/
+class wxAuiManagerEvent : public wxEvent
+{
+public:
+    /**
+        Constructor.
+    */
+    wxAuiManagerEvent(wxEventType type = wxEVT_NULL);
+
+    /**
+        @return @true if this event can be vetoed.
+
+        @see Veto()
+    */
+    bool CanVeto();
+
+    /**
+        @return The ID of the button that was clicked.
+    */
+    int GetButton();
+
+    /**
+        @todo What is this?
+    */
+    wxDC* GetDC();
+
+    /**
+        @return @true if this event was vetoed.
+
+        @see Veto()
+    */
+    bool GetVeto();
+
+    /**
+        @return The wxAuiManager this event is associated with.
+    */
+    wxAuiManager* GetManager();
+
+    /**
+        @return The pane this event is associated with.
+    */
+    wxAuiPaneInfo* GetPane();
+
+    /**
+        Sets the ID of the button clicked that triggered this event.
+    */
+    void SetButton(int button);
+
+    /**
+        Sets whether or not this event can be vetoed.
+    */
+    void SetCanVeto(bool can_veto);
+
+    /**
+        @todo What is this?
+    */
+    void SetDC(wxDC* pdc);
+
+    /**
+        Sets the wxAuiManager this event is associated with.
+    */
+    void SetManager(wxAuiManager* manager);
+
+    /**
+        Sets the pane this event is associated with.
+    */
+    void SetPane(wxAuiPaneInfo* pane);
+
+    /**
+        Cancels the action indicated by this event if CanVeto() is @true.
+    */
+    void Veto(bool veto = true);
+};
+