X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/fadc2df6823d988f7a264b94e69a7e1bbcac1337..89a1395ebc336eb41780578ccde676520b5811d6:/interface/wx/splitter.h diff --git a/interface/wx/splitter.h b/interface/wx/splitter.h index 3561831d42..6a9de45dc2 100644 --- a/interface/wx/splitter.h +++ b/interface/wx/splitter.h @@ -3,7 +3,7 @@ // Purpose: interface of wxSplitterWindow // Author: wxWidgets team // RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// /** @@ -37,7 +37,7 @@ @endStyleTable - @beginEventTable{wxSplitterEvent} + @beginEventEmissionTable{wxSplitterEvent} @event{EVT_SPLITTER_SASH_POS_CHANGING(id, func)} The sash position is in the process of being changed. May be used to modify the position of the tracking bar to properly @@ -95,7 +95,7 @@ public: @see Initialize(), SplitVertically(), SplitHorizontally(), Create() */ - wxSplitterWindow(wxWindow* parent, wxWindowID id, + wxSplitterWindow(wxWindow* parent, wxWindowID id = wxID_ANY, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style = wxSP_3D, @@ -110,11 +110,10 @@ public: Creation function, for two-step construction. See wxSplitterWindow() for details. */ - bool Create(wxWindow* parent, wxWindowID id, + bool Create(wxWindow* parent, wxWindowID id = wxID_ANY, const wxPoint& point = wxDefaultPosition, - const wxSize& size = wxDefaultSize, - long style = wxSP_3D, - const wxString& name = "splitterWindow"); + const wxSize& size = wxDefaultSize, long style = wxSP_3D, + const wxString& name = "splitter"); /** Returns the current minimum pane size (defaults to zero). @@ -137,12 +136,24 @@ public: */ int GetSashPosition() const; + /** + Returns the sash size in pixels. + + The size of the sash is its width for a vertically split window and its + height for a horizontally split one. Its other direction is the same as + the client size of the window in the corresponding direction. + + The sash size is platform-dependent because it conforms to the current + platform look-and-feel and cannot be changed. + */ + int GetSashSize() const; + /** Gets the split mode. @see SetSplitMode(), SplitVertically(), SplitHorizontally(). */ - int GetSplitMode() const; + wxSplitMode GetSplitMode() const; /** Returns the left/top or only pane. @@ -284,16 +295,7 @@ public: @see GetSashPosition() */ - void SetSashPosition(int position, const bool redraw = true); - - /** - Sets the sash size. Normally, the sash size is determined according to the - metrics - of each platform, but the application can override this, for example to show - a thin sash that the user is not expected to drag. If @a size is more -1, - the custom sash size will be used. - */ - void SetSashSize(int size); + void SetSashPosition(int position, bool redraw = true); /** Sets the split mode. @@ -424,7 +426,7 @@ public: @library{wxcore} @category{events} - @see wxSplitterWindow, @ref overview_eventhandling + @see wxSplitterWindow, @ref overview_events */ class wxSplitterEvent : public wxNotifyEvent {