]>
Commit | Line | Data |
---|---|---|
1 | ///////////////////////////////////////////////////////////////////////////// | |
2 | // Name: sashwin.h | |
3 | // Purpose: wxSashWindow implementation. A sash window has an optional | |
4 | // sash on each edge, allowing it to be dragged. An event | |
5 | // is generated when the sash is released. | |
6 | // Author: Julian Smart | |
7 | // Modified by: | |
8 | // Created: 01/02/97 | |
9 | // RCS-ID: $Id$ | |
10 | // Copyright: (c) Julian Smart | |
11 | // Licence: wxWindows licence | |
12 | ///////////////////////////////////////////////////////////////////////////// | |
13 | ||
14 | #ifndef _WX_SASHWIN_H_G_ | |
15 | #define _WX_SASHWIN_H_G_ | |
16 | ||
17 | #if defined(__GNUG__) && !defined(__APPLE__) | |
18 | #pragma interface "sashwin.h" | |
19 | #endif | |
20 | ||
21 | #if wxUSE_SASH | |
22 | ||
23 | #include "wx/defs.h" | |
24 | #include "wx/window.h" | |
25 | #include "wx/string.h" | |
26 | ||
27 | #define wxSASH_DRAG_NONE 0 | |
28 | #define wxSASH_DRAG_DRAGGING 1 | |
29 | #define wxSASH_DRAG_LEFT_DOWN 2 | |
30 | ||
31 | enum wxSashEdgePosition { | |
32 | wxSASH_TOP = 0, | |
33 | wxSASH_RIGHT, | |
34 | wxSASH_BOTTOM, | |
35 | wxSASH_LEFT, | |
36 | wxSASH_NONE = 100 | |
37 | }; | |
38 | ||
39 | /* | |
40 | * wxSashEdge represents one of the four edges of a window. | |
41 | */ | |
42 | ||
43 | class WXDLLEXPORT wxSashEdge | |
44 | { | |
45 | public: | |
46 | wxSashEdge() { m_show = FALSE; m_border = FALSE; m_margin = 0; } | |
47 | ||
48 | bool m_show; // Is the sash showing? | |
49 | bool m_border; // Do we draw a border? | |
50 | int m_margin; // The margin size | |
51 | }; | |
52 | ||
53 | /* | |
54 | * wxSashWindow flags | |
55 | */ | |
56 | ||
57 | #define wxSW_NOBORDER 0x0000 | |
58 | //#define wxSW_3D 0x0010 | |
59 | #define wxSW_BORDER 0x0020 | |
60 | #define wxSW_3DSASH 0x0040 | |
61 | #define wxSW_3DBORDER 0x0080 | |
62 | #define wxSW_3D (wxSW_3DSASH | wxSW_3DBORDER) | |
63 | ||
64 | /* | |
65 | * wxSashWindow allows any of its edges to have a sash which can be dragged | |
66 | * to resize the window. The actual content window will be created as a child | |
67 | * of wxSashWindow. | |
68 | */ | |
69 | ||
70 | class WXDLLEXPORT wxSashWindow: public wxWindow | |
71 | { | |
72 | public: | |
73 | // Default constructor | |
74 | wxSashWindow() | |
75 | { | |
76 | Init(); | |
77 | } | |
78 | ||
79 | // Normal constructor | |
80 | wxSashWindow(wxWindow *parent, wxWindowID id = -1, const wxPoint& pos = wxDefaultPosition, | |
81 | const wxSize& size = wxDefaultSize, long style = wxSW_3D|wxCLIP_CHILDREN, const wxString& name = wxT("sashWindow")) | |
82 | { | |
83 | Init(); | |
84 | Create(parent, id, pos, size, style, name); | |
85 | } | |
86 | ||
87 | ~wxSashWindow(); | |
88 | ||
89 | bool Create(wxWindow *parent, wxWindowID id = -1, const wxPoint& pos = wxDefaultPosition, | |
90 | const wxSize& size = wxDefaultSize, long style = wxSW_3D|wxCLIP_CHILDREN, const wxString& name = wxT("sashWindow")); | |
91 | ||
92 | // Set whether there's a sash in this position | |
93 | void SetSashVisible(wxSashEdgePosition edge, bool sash); | |
94 | ||
95 | // Get whether there's a sash in this position | |
96 | inline bool GetSashVisible(wxSashEdgePosition edge) const { return m_sashes[edge].m_show; } | |
97 | ||
98 | // Set whether there's a border in this position | |
99 | inline void SetSashBorder(wxSashEdgePosition edge, bool border) { m_sashes[edge].m_border = border; } | |
100 | ||
101 | // Get whether there's a border in this position | |
102 | inline bool HasBorder(wxSashEdgePosition edge) const { return m_sashes[edge].m_border; } | |
103 | ||
104 | // Get border size | |
105 | inline int GetEdgeMargin(wxSashEdgePosition edge) const { return m_sashes[edge].m_margin; } | |
106 | ||
107 | // Sets the default sash border size | |
108 | inline void SetDefaultBorderSize(int width) { m_borderSize = width; } | |
109 | ||
110 | // Gets the default sash border size | |
111 | inline int GetDefaultBorderSize() const { return m_borderSize; } | |
112 | ||
113 | // Sets the addition border size between child and sash window | |
114 | inline void SetExtraBorderSize(int width) { m_extraBorderSize = width; } | |
115 | ||
116 | // Gets the addition border size between child and sash window | |
117 | inline int GetExtraBorderSize() const { return m_extraBorderSize; } | |
118 | ||
119 | virtual void SetMinimumSizeX(int min) { m_minimumPaneSizeX = min; } | |
120 | virtual void SetMinimumSizeY(int min) { m_minimumPaneSizeY = min; } | |
121 | virtual int GetMinimumSizeX() const { return m_minimumPaneSizeX; } | |
122 | virtual int GetMinimumSizeY() const { return m_minimumPaneSizeY; } | |
123 | ||
124 | virtual void SetMaximumSizeX(int max) { m_maximumPaneSizeX = max; } | |
125 | virtual void SetMaximumSizeY(int max) { m_maximumPaneSizeY = max; } | |
126 | virtual int GetMaximumSizeX() const { return m_maximumPaneSizeX; } | |
127 | virtual int GetMaximumSizeY() const { return m_maximumPaneSizeY; } | |
128 | ||
129 | //////////////////////////////////////////////////////////////////////////// | |
130 | // Implementation | |
131 | ||
132 | // Paints the border and sash | |
133 | void OnPaint(wxPaintEvent& event); | |
134 | ||
135 | // Handles mouse events | |
136 | void OnMouseEvent(wxMouseEvent& ev); | |
137 | ||
138 | // Adjusts the panes | |
139 | void OnSize(wxSizeEvent& event); | |
140 | ||
141 | #if defined(__WXMSW__) || defined(__WXMAC__) | |
142 | // Handle cursor correctly | |
143 | void OnSetCursor(wxSetCursorEvent& event); | |
144 | #endif // wxMSW | |
145 | ||
146 | // Draws borders | |
147 | void DrawBorders(wxDC& dc); | |
148 | ||
149 | // Draws the sashes | |
150 | void DrawSash(wxSashEdgePosition edge, wxDC& dc); | |
151 | ||
152 | // Draws the sashes | |
153 | void DrawSashes(wxDC& dc); | |
154 | ||
155 | // Draws the sash tracker (for whilst moving the sash) | |
156 | void DrawSashTracker(wxSashEdgePosition edge, int x, int y); | |
157 | ||
158 | // Tests for x, y over sash | |
159 | wxSashEdgePosition SashHitTest(int x, int y, int tolerance = 2); | |
160 | ||
161 | // Resizes subwindows | |
162 | void SizeWindows(); | |
163 | ||
164 | // Initialize colours | |
165 | void InitColours(); | |
166 | ||
167 | private: | |
168 | void Init(); | |
169 | ||
170 | wxSashEdge m_sashes[4]; | |
171 | int m_dragMode; | |
172 | wxSashEdgePosition m_draggingEdge; | |
173 | int m_oldX; | |
174 | int m_oldY; | |
175 | int m_borderSize; | |
176 | int m_extraBorderSize; | |
177 | int m_firstX; | |
178 | int m_firstY; | |
179 | int m_minimumPaneSizeX; | |
180 | int m_minimumPaneSizeY; | |
181 | int m_maximumPaneSizeX; | |
182 | int m_maximumPaneSizeY; | |
183 | wxCursor* m_sashCursorWE; | |
184 | wxCursor* m_sashCursorNS; | |
185 | wxColour m_lightShadowColour; | |
186 | wxColour m_mediumShadowColour; | |
187 | wxColour m_darkShadowColour; | |
188 | wxColour m_hilightColour; | |
189 | wxColour m_faceColour; | |
190 | bool m_mouseCaptured; | |
191 | wxCursor* m_currentCursor; | |
192 | ||
193 | private: | |
194 | DECLARE_DYNAMIC_CLASS(wxSashWindow) | |
195 | DECLARE_EVENT_TABLE() | |
196 | DECLARE_NO_COPY_CLASS(wxSashWindow) | |
197 | }; | |
198 | ||
199 | BEGIN_DECLARE_EVENT_TYPES() | |
200 | DECLARE_EVENT_TYPE(wxEVT_SASH_DRAGGED, wxEVT_FIRST + 1200) | |
201 | END_DECLARE_EVENT_TYPES() | |
202 | ||
203 | // #define wxEVT_SASH_DRAGGED (wxEVT_FIRST + 1200) | |
204 | ||
205 | enum wxSashDragStatus | |
206 | { | |
207 | wxSASH_STATUS_OK, | |
208 | wxSASH_STATUS_OUT_OF_RANGE | |
209 | }; | |
210 | ||
211 | class WXDLLEXPORT wxSashEvent: public wxCommandEvent | |
212 | { | |
213 | public: | |
214 | inline wxSashEvent(int id = 0, wxSashEdgePosition edge = wxSASH_NONE) { | |
215 | m_eventType = (wxEventType) wxEVT_SASH_DRAGGED; m_id = id; m_edge = edge; } | |
216 | ||
217 | inline void SetEdge(wxSashEdgePosition edge) { m_edge = edge; } | |
218 | inline wxSashEdgePosition GetEdge() const { return m_edge; } | |
219 | ||
220 | //// The rectangle formed by the drag operation | |
221 | inline void SetDragRect(const wxRect& rect) { m_dragRect = rect; } | |
222 | inline wxRect GetDragRect() const { return m_dragRect; } | |
223 | ||
224 | //// Whether the drag caused the rectangle to be reversed (e.g. | |
225 | //// dragging the top below the bottom) | |
226 | inline void SetDragStatus(wxSashDragStatus status) { m_dragStatus = status; } | |
227 | inline wxSashDragStatus GetDragStatus() const { return m_dragStatus; } | |
228 | ||
229 | private: | |
230 | wxSashEdgePosition m_edge; | |
231 | wxRect m_dragRect; | |
232 | wxSashDragStatus m_dragStatus; | |
233 | ||
234 | private: | |
235 | DECLARE_DYNAMIC_CLASS(wxSashEvent) | |
236 | }; | |
237 | ||
238 | typedef void (wxEvtHandler::*wxSashEventFunction)(wxSashEvent&); | |
239 | ||
240 | #define EVT_SASH_DRAGGED(id, fn) \ | |
241 | DECLARE_EVENT_TABLE_ENTRY( wxEVT_SASH_DRAGGED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxSashEventFunction) & fn, NULL ), | |
242 | #define EVT_SASH_DRAGGED_RANGE(id1, id2, fn) \ | |
243 | DECLARE_EVENT_TABLE_ENTRY( wxEVT_SASH_DRAGGED, id1, id2, (wxObjectEventFunction) (wxEventFunction) (wxSashEventFunction) & fn, NULL ), | |
244 | ||
245 | #endif // wxUSE_SASH | |
246 | ||
247 | #endif | |
248 | // _WX_SASHWIN_H_G_ |