]> git.saurik.com Git - wxWidgets.git/blob - include/wx/univ/window.h
moved ProvidesBackground() from wxUniv to base wxWindow class; use it to prevent...
[wxWidgets.git] / include / wx / univ / window.h
1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: wx/univ/window.h
3 // Purpose: wxWindow class which is the base class for all
4 // wxUniv port controls, it supports the customization of the
5 // window drawing and input processing.
6 // Author: Vadim Zeitlin
7 // Modified by:
8 // Created: 06.08.00
9 // RCS-ID: $Id$
10 // Copyright: (c) 2000 SciTech Software, Inc. (www.scitechsoft.com)
11 // Licence: wxWindows licence
12 ///////////////////////////////////////////////////////////////////////////////
13
14 #ifndef _WX_UNIV_WINDOW_H_
15 #define _WX_UNIV_WINDOW_H_
16
17 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
18 #pragma interface "univwindow.h"
19 #endif
20
21 #include "wx/bitmap.h" // for m_bitmapBg
22
23 class WXDLLEXPORT wxControlRenderer;
24 class WXDLLEXPORT wxEventLoop;
25 class WXDLLEXPORT wxMenu;
26 class WXDLLEXPORT wxMenuBar;
27 class WXDLLEXPORT wxRenderer;
28 class WXDLLEXPORT wxScrollBar;
29
30 #ifdef __WXX11__
31 #define wxUSE_TWO_WINDOWS 1
32 #else
33 #define wxUSE_TWO_WINDOWS 0
34 #endif
35
36 // ----------------------------------------------------------------------------
37 // wxWindow
38 // ----------------------------------------------------------------------------
39
40 #if defined(__WXMSW__)
41 #define wxWindowNative wxWindowMSW
42 #elif defined(__WXGTK__)
43 #define wxWindowNative wxWindowGTK
44 #elif defined(__WXMGL__)
45 #define wxWindowNative wxWindowMGL
46 #elif defined(__WXX11__)
47 #define wxWindowNative wxWindowX11
48 #elif defined(__WXMAC__)
49 #define wxWindowNative wxWindowMac
50 #endif
51
52 class WXDLLEXPORT wxWindow : public wxWindowNative
53 {
54 public:
55 // ctors and create functions
56 // ---------------------------
57
58 wxWindow() { Init(); }
59
60 wxWindow(wxWindow *parent,
61 wxWindowID id,
62 const wxPoint& pos = wxDefaultPosition,
63 const wxSize& size = wxDefaultSize,
64 long style = 0,
65 const wxString& name = wxPanelNameStr)
66 : wxWindowNative(parent, id, pos, size, style | wxCLIP_CHILDREN, name)
67 { Init(); }
68
69 bool Create(wxWindow *parent,
70 wxWindowID id,
71 const wxPoint& pos = wxDefaultPosition,
72 const wxSize& size = wxDefaultSize,
73 long style = 0,
74 const wxString& name = wxPanelNameStr);
75
76 virtual ~wxWindow();
77
78 // background pixmap support
79 // -------------------------
80
81 virtual void SetBackground(const wxBitmap& bitmap,
82 int alignment = wxALIGN_CENTRE,
83 wxStretch stretch = wxSTRETCH_NOT);
84
85 const wxBitmap& GetBackgroundBitmap(int *alignment = NULL,
86 wxStretch *stretch = NULL) const;
87
88 // scrollbars: we (re)implement it ourselves using our own scrollbars
89 // instead of the native ones
90 // ------------------------------------------------------------------
91
92 virtual void SetScrollbar(int orient,
93 int pos,
94 int page,
95 int range,
96 bool refresh = true );
97 virtual void SetScrollPos(int orient, int pos, bool refresh = true);
98 virtual int GetScrollPos(int orient) const;
99 virtual int GetScrollThumb(int orient) const;
100 virtual int GetScrollRange(int orient) const;
101 virtual void ScrollWindow(int dx, int dy,
102 const wxRect* rect = (wxRect *) NULL);
103
104 // take into account the borders here
105 virtual wxPoint GetClientAreaOrigin() const;
106
107 // popup menu support
108 // ------------------
109
110 // NB: all menu related functions are implemented in menu.cpp
111
112 #if wxUSE_MENUS
113 virtual bool DoPopupMenu(wxMenu *menu, int x, int y);
114
115 // this is wxUniv-specific private method to be used only by wxMenu
116 void DismissPopupMenu();
117 #endif // wxUSE_MENUS
118
119 // miscellaneous other methods
120 // ---------------------------
121
122 // get the state information
123 virtual bool IsFocused() const;
124 virtual bool IsCurrent() const;
125 virtual bool IsPressed() const;
126 virtual bool IsDefault() const;
127
128 // return all state flags at once (combination of wxCONTROL_XXX values)
129 int GetStateFlags() const;
130
131 // set the "highlighted" flag and return true if it changed
132 virtual bool SetCurrent(bool doit = true);
133
134 // get the scrollbar (may be NULL) for the given orientation
135 wxScrollBar *GetScrollbar(int orient) const
136 {
137 return orient & wxVERTICAL ? m_scrollbarVert : m_scrollbarHorz;
138 }
139
140 // methods used by wxColourScheme to choose the colours for this window
141 // --------------------------------------------------------------------
142
143 // return true if this is a panel/canvas window which contains other
144 // controls only
145 virtual bool IsCanvasWindow() const { return false; }
146
147 // returns true if the control has "transparent" areas such
148 // as a wxStaticText and wxCheckBox and the background should
149 // be adapted from a parent window
150 virtual bool HasTransparentBackground() { return false; }
151
152 // return true if this control can be highlighted when the mouse is over
153 // it (the theme decides itself whether it is really highlighted or not)
154 virtual bool CanBeHighlighted() const { return false; }
155
156 // return true if we should use the colours/fonts returned by the
157 // corresponding GetXXX() methods instead of the default ones
158 bool UseBgCol() const { return m_hasBgCol; }
159 bool UseFgCol() const { return m_hasFgCol; }
160 bool UseFont() const { return m_hasFont; }
161
162 // return true if this window serves as a container for the other windows
163 // only and doesn't get any input itself
164 virtual bool IsStaticBox() const { return false; }
165
166 // returns the (low level) renderer to use for drawing the control by
167 // querying the current theme
168 wxRenderer *GetRenderer() const { return m_renderer; }
169
170 // scrolling helper: like ScrollWindow() except that it doesn't refresh the
171 // uncovered window areas but returns the rectangle to update (don't call
172 // this with both dx and dy non zero)
173 wxRect ScrollNoRefresh(int dx, int dy, const wxRect *rect = NULL);
174
175 // after scrollbars are added or removed they must be refreshed by calling
176 // this function
177 void RefreshScrollbars();
178
179 // erase part of the control
180 virtual void EraseBackground(wxDC& dc, const wxRect& rect);
181
182 // overridden base class methods
183 // -----------------------------
184
185 // the rect coordinates are, for us, in client coords, but if no rect is
186 // specified, the entire window is refreshed
187 virtual void Refresh(bool eraseBackground = true,
188 const wxRect *rect = (const wxRect *) NULL);
189
190 // we refresh the window when it is dis/enabled
191 virtual bool Enable(bool enable = true);
192
193 // should we use the standard control colours or not?
194 virtual bool ShouldInheritColours() const { return false; }
195
196 protected:
197 // common part of all ctors
198 void Init();
199
200 // overridden base class virtuals
201
202 // we deal with the scrollbars in these functions
203 virtual void DoSetClientSize(int width, int height);
204 virtual void DoGetClientSize(int *width, int *height) const;
205 virtual wxHitTest DoHitTest(wxCoord x, wxCoord y) const;
206
207 // event handlers
208 void OnSize(wxSizeEvent& event);
209 void OnNcPaint(wxNcPaintEvent& event);
210 void OnPaint(wxPaintEvent& event);
211 void OnErase(wxEraseEvent& event);
212
213 #if wxUSE_ACCEL || wxUSE_MENUS
214 void OnKeyDown(wxKeyEvent& event);
215 #endif // wxUSE_ACCEL
216
217 #if wxUSE_MENUS
218 void OnChar(wxKeyEvent& event);
219 void OnKeyUp(wxKeyEvent& event);
220 #endif // wxUSE_MENUS
221
222 // draw the control background, return true if done
223 virtual bool DoDrawBackground(wxDC& dc);
224
225 // draw the controls border
226 virtual void DoDrawBorder(wxDC& dc, const wxRect& rect);
227
228 // draw the controls contents
229 virtual void DoDraw(wxControlRenderer *renderer);
230
231 // calculate the best size for the client area of the window: default
232 // implementation of DoGetBestSize() uses this method and adds the border
233 // width to the result
234 virtual wxSize DoGetBestClientSize() const;
235 virtual wxSize DoGetBestSize() const;
236
237 // adjust the size of the window to take into account its borders
238 wxSize AdjustSize(const wxSize& size) const;
239
240 // put the scrollbars along the edges of the window
241 void PositionScrollbars();
242
243 #if wxUSE_MENUS
244 // return the menubar of the parent frame or NULL
245 wxMenuBar *GetParentFrameMenuBar() const;
246 #endif // wxUSE_MENUS
247
248 // the renderer we use
249 wxRenderer *m_renderer;
250
251 // background bitmap info
252 wxBitmap m_bitmapBg;
253 int m_alignBgBitmap;
254 wxStretch m_stretchBgBitmap;
255
256 // old size
257 wxSize m_oldSize;
258
259 // is the mouse currently inside the window?
260 bool m_isCurrent:1;
261
262 #ifdef __WXMSW__
263 // override MSWWindowProc() to process WM_NCHITTEST
264 WXLRESULT MSWWindowProc(WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
265 #endif // __WXMSW__
266
267 private:
268 // the window scrollbars
269 wxScrollBar *m_scrollbarHorz,
270 *m_scrollbarVert;
271
272 #if wxUSE_MENUS
273 // the current modal event loop for the popup menu we show or NULL
274 static wxEventLoop *ms_evtLoopPopup;
275
276 // the last window over which Alt was pressed (used by OnKeyUp)
277 static wxWindow *ms_winLastAltPress;
278 #endif // wxUSE_MENUS
279
280 DECLARE_DYNAMIC_CLASS(wxWindow)
281 DECLARE_EVENT_TABLE()
282 };
283
284 #endif // _WX_UNIV_WINDOW_H_
285