X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/12f5e1e78fe906050ff2fee9529476db332633f0..92c0fc34c104c8d7c12d6a3b78ea232690fc23f4:/interface/wx/sashwin.h diff --git a/interface/wx/sashwin.h b/interface/wx/sashwin.h index 50dc95bf3d..2310448dc7 100644 --- a/interface/wx/sashwin.h +++ b/interface/wx/sashwin.h @@ -2,19 +2,50 @@ // Name: sashwin.h // Purpose: interface of wxSashWindow // Author: wxWidgets team -// RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// +/** + wxSashWindow flags +*/ +#define wxSW_NOBORDER 0x0000 +#define wxSW_BORDER 0x0020 +#define wxSW_3DSASH 0x0040 +#define wxSW_3DBORDER 0x0080 +#define wxSW_3D (wxSW_3DSASH | wxSW_3DBORDER) + + +/** + See wxSashWindow. +*/ +enum wxSashEdgePosition +{ + wxSASH_TOP = 0, + wxSASH_RIGHT, + wxSASH_BOTTOM, + wxSASH_LEFT, + wxSASH_NONE = 100 +}; + +/** + See wxSashEvent. +*/ +enum wxSashDragStatus +{ + wxSASH_STATUS_OK, + wxSASH_STATUS_OUT_OF_RANGE +}; + + /** @class wxSashWindow wxSashWindow allows any of its edges to have a sash which can be dragged to resize the window. The actual content window will be created by the - application - as a child of wxSashWindow. The window (or an ancestor) will be notified of a - drag - via a wxSashEvent notification. + application as a child of wxSashWindow. + + The window (or an ancestor) will be notified of a drag via a + wxSashEvent notification. @beginStyleTable @style{wxSW_3D} @@ -27,12 +58,12 @@ Draws a thin black border. @endStyleTable - @beginEventTable{wxSashEvent} + @beginEventEmissionTable{wxSashEvent} @event{EVT_SASH_DRAGGED(id, func)} - Process a wxEVT_SASH_DRAGGED event, when the user has finished + Process a @c wxEVT_SASH_DRAGGED event, when the user has finished dragging a sash. @event{EVT_SASH_DRAGGED_RANGE(id1, id2, func)} - Process a wxEVT_SASH_DRAGGED_RANGE event, when the user has + Process a @c wxEVT_SASH_DRAGGED_RANGE event, when the user has finished dragging a sash. The event handler is called when windows with ids in the given range have their sashes dragged. @endEventTable @@ -40,12 +71,16 @@ @library{wxadv} @category{miscwnd} - @see wxSashEvent, wxSashLayoutWindow, @ref overview_eventhandling + @see wxSashEvent, wxSashLayoutWindow, @ref overview_events */ class wxSashWindow : public wxWindow { public: - //@{ + /** + Default ctor. + */ + wxSashWindow(); + /** Constructs a sash window, which can be a child of a frame, dialog or any other non-control window. @@ -56,10 +91,8 @@ public: Window identifier. If -1, will automatically create an identifier. @param pos Window position. wxDefaultPosition is (-1, -1) which indicates that - wxSashWindows - should generate a default position for the window. If using the - wxSashWindow class directly, supply - an actual position. + wxSashWindows should generate a default position for the window. + If using the wxSashWindow class directly, supply an actual position. @param size Window size. wxDefaultSize is (-1, -1) which indicates that wxSashWindows should generate a default size for the window. @@ -68,38 +101,36 @@ public: @param name Window name. */ - wxSashWindow(); wxSashWindow(wxWindow* parent, wxWindowID id, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style = wxCLIP_CHILDREN | wxSW_3D, const wxString& name = "sashWindow"); - //@} /** Destructor. */ - ~wxSashWindow(); + virtual ~wxSashWindow(); /** Gets the maximum window size in the x direction. */ - int GetMaximumSizeX() const; + virtual int GetMaximumSizeX() const; /** Gets the maximum window size in the y direction. */ - int GetMaximumSizeY() const; + virtual int GetMaximumSizeY() const; /** Gets the minimum window size in the x direction. */ - int GetMinimumSizeX(); + virtual int GetMinimumSizeX() const; /** Gets the minimum window size in the y direction. */ - int GetMinimumSizeY() const; + virtual int GetMinimumSizeY() const; /** Returns @true if a sash is visible on the given edge, @false otherwise. @@ -111,47 +142,25 @@ public: */ bool GetSashVisible(wxSashEdgePosition edge) const; - /** - Returns @true if the sash has a border, @false otherwise. - This function is obsolete since the sash border property is unused. - - @param edge - Edge. One of wxSASH_TOP, wxSASH_RIGHT, wxSASH_BOTTOM, wxSASH_LEFT. - - @see SetSashBorder() - */ - bool HasBorder(wxSashEdgePosition edge) const; - /** Sets the maximum window size in the x direction. */ - void SetMaximumSizeX(int min); + virtual void SetMaximumSizeX(int min); /** Sets the maximum window size in the y direction. */ - void SetMaximumSizeY(int min); + virtual void SetMaximumSizeY(int min); /** Sets the minimum window size in the x direction. */ - void SetMinimumSizeX(int min); + virtual void SetMinimumSizeX(int min); /** Sets the minimum window size in the y direction. */ - void SetMinimumSizeY(int min); - - /** - Call this function to give the sash a border, or remove the border. - This function is obsolete since the sash border property is unused. - - @param edge - Edge to change. One of wxSASH_TOP, wxSASH_RIGHT, wxSASH_BOTTOM, wxSASH_LEFT. - @param hasBorder - @true to give the sash a border visible, @false to remove it. - */ - void SetSashBorder(wxSashEdgePosition edge, bool hasBorder); + virtual void SetMinimumSizeY(int min); /** Call this function to make a sash visible or invisible on a particular edge. @@ -164,6 +173,42 @@ public: @see GetSashVisible() */ void SetSashVisible(wxSashEdgePosition edge, bool visible); + + + /** + Get border size + */ + int GetEdgeMargin(wxSashEdgePosition edge) const; + + /** + Sets the default sash border size + */ + void SetDefaultBorderSize(int width); + + /** + Gets the default sash border size + */ + int GetDefaultBorderSize() const; + + /** + Sets the additional border size between child and sash window + */ + void SetExtraBorderSize(int width); + + /** + Gets the addition border size between child and sash window + */ + int GetExtraBorderSize() const; + + /** + Tests for x, y over sash + */ + wxSashEdgePosition SashHitTest(int x, int y, int tolerance = 2); + + /** + Resizes subwindows + */ + void SizeWindows(); }; @@ -174,10 +219,32 @@ public: A sash event is sent when the sash of a wxSashWindow has been dragged by the user. + @remarks + When a sash belonging to a sash window is dragged by the user, and then released, + this event is sent to the window, where it may be processed by an event table + entry in a derived class, a plug-in event handler or an ancestor class. + Note that the wxSashWindow doesn't change the window's size itself. + It relies on the application's event handler to do that. + This is because the application may have to handle other consequences of the resize, + or it may wish to veto it altogether. The event handler should look at the drag + rectangle: see wxSashEvent::GetDragRect to see what the new size of the window + would be if the resize were to be applied. + It should also call wxSashEvent::GetDragStatus to see whether the drag was + OK or out of the current allowed range. + + @beginEventTable{wxSashEvent} + @event{EVT_SASH_DRAGGED(id, func)} + Process a @c wxEVT_SASH_DRAGGED event, when the user has finished dragging a sash. + @event{EVT_SASH_DRAGGED_RANGE(id1, id2, func)} + Process a @c wxEVT_SASH_DRAGGED_RANGE event, when the user has finished + dragging a sash. The event handler is called when windows with ids in + the given range have their sashes dragged. + @endEventTable + @library{wxadv} - @category{FIXME} + @category{events} - @see wxSashWindow, @ref overview_eventhandlingoverview + @see wxSashWindow, @ref overview_events */ class wxSashEvent : public wxCommandEvent { @@ -189,23 +256,29 @@ public: /** Returns the rectangle representing the new size the window would be if the - resize was applied. It is - up to the application to set the window size if required. + resize was applied. It is up to the application to set the window size if required. */ wxRect GetDragRect() const; /** - Returns the status of the sash: one of wxSASH_STATUS_OK, - wxSASH_STATUS_OUT_OF_RANGE. + Returns the status of the sash: one of wxSASH_STATUS_OK, wxSASH_STATUS_OUT_OF_RANGE. + If the drag caused the notional bounding box of the window to flip over, for example, the drag will be out of rage. */ wxSashDragStatus GetDragStatus() const; /** - Returns the dragged edge. The return value is one of wxSASH_TOP, wxSASH_RIGHT, - wxSASH_BOTTOM, wxSASH_LEFT. + Returns the dragged edge. + + The return value is one of wxSASH_TOP, wxSASH_RIGHT, wxSASH_BOTTOM, wxSASH_LEFT. */ wxSashEdgePosition GetEdge() const; + + + void SetEdge(wxSashEdgePosition edge); + void SetDragRect(const wxRect& rect); + void SetDragStatus(wxSashDragStatus status); }; +wxEventType wxEVT_SASH_DRAGGED;