]> git.saurik.com Git - wxWidgets.git/blame - include/wx/motif/window.h
build fixes
[wxWidgets.git] / include / wx / motif / window.h
CommitLineData
9b6dbb09 1/////////////////////////////////////////////////////////////////////////////
34097680 2// Name: wx/motif/window.h
9b6dbb09
JS
3// Purpose: wxWindow class
4// Author: Julian Smart
5// Modified by:
6// Created: 17/09/98
7// RCS-ID: $Id$
8// Copyright: (c) Julian Smart
65571936 9// Licence: wxWindows licence
9b6dbb09
JS
10/////////////////////////////////////////////////////////////////////////////
11
12#ifndef _WX_WINDOW_H_
13#define _WX_WINDOW_H_
14
25f47127 15#include "wx/region.h"
af0bb3b1 16
34636400
VZ
17// ----------------------------------------------------------------------------
18// wxWindow class for Motif - see also wxWindowBase
19// ----------------------------------------------------------------------------
9b6dbb09 20
94c7b088 21class WXDLLIMPEXP_CORE wxWindow : public wxWindowBase
9b6dbb09 22{
b5dbe15d
VS
23 friend class WXDLLIMPEXP_FWD_CORE wxDC;
24 friend class WXDLLIMPEXP_FWD_CORE wxWindowDC;
34097680 25
9b6dbb09 26public:
34636400 27 wxWindow() { Init(); }
34097680 28
34636400 29 wxWindow(wxWindow *parent,
34097680
WS
30 wxWindowID id,
31 const wxPoint& pos = wxDefaultPosition,
32 const wxSize& size = wxDefaultSize,
33 long style = 0,
34 const wxString& name = wxPanelNameStr)
bfc6fde4 35 {
34636400 36 Init();
bfc6fde4
VZ
37 Create(parent, id, pos, size, style, name);
38 }
34097680 39
bfc6fde4 40 virtual ~wxWindow();
34097680 41
34636400 42 bool Create(wxWindow *parent,
34097680
WS
43 wxWindowID id,
44 const wxPoint& pos = wxDefaultPosition,
45 const wxSize& size = wxDefaultSize,
46 long style = 0,
47 const wxString& name = wxPanelNameStr);
48
34636400 49 // implement base class pure virtuals
34097680
WS
50 virtual void SetLabel(const wxString& label);
51 virtual wxString GetLabel() const;
52
bfc6fde4 53 virtual void Raise();
bfc6fde4 54 virtual void Lower();
34097680 55
96be256b
MB
56 virtual bool Show( bool show = true );
57 virtual bool Enable( bool enable = true );
34097680 58
34636400 59 virtual void SetFocus();
34097680 60
34636400 61 virtual void WarpPointer(int x, int y);
34097680 62
96be256b 63 virtual void Refresh( bool eraseBackground = true,
83df96d6 64 const wxRect *rect = (const wxRect *) NULL );
34097680 65
af0bb3b1
VZ
66 virtual bool SetBackgroundColour( const wxColour &colour );
67 virtual bool SetForegroundColour( const wxColour &colour );
34097680 68
34636400
VZ
69 virtual bool SetCursor( const wxCursor &cursor );
70 virtual bool SetFont( const wxFont &font );
34097680 71
bfc6fde4
VZ
72 virtual int GetCharHeight() const;
73 virtual int GetCharWidth() const;
34636400 74 virtual void GetTextExtent(const wxString& string,
83df96d6
JS
75 int *x, int *y,
76 int *descent = (int *) NULL,
77 int *externalLeading = (int *) NULL,
78 const wxFont *theFont = (const wxFont *) NULL)
79 const;
34097680 80
34636400 81 virtual void SetScrollbar( int orient, int pos, int thumbVisible,
96be256b
MB
82 int range, bool refresh = true );
83 virtual void SetScrollPos( int orient, int pos, bool refresh = true );
34636400
VZ
84 virtual int GetScrollPos( int orient ) const;
85 virtual int GetScrollThumb( int orient ) const;
86 virtual int GetScrollRange( int orient ) const;
87 virtual void ScrollWindow( int dx, int dy,
83df96d6 88 const wxRect* rect = (wxRect *) NULL );
34097680 89
47d67540 90#if wxUSE_DRAG_AND_DROP
34636400
VZ
91 virtual void SetDropTarget( wxDropTarget *dropTarget );
92#endif // wxUSE_DRAG_AND_DROP
34097680 93
bfc6fde4
VZ
94 // Accept files for dragging
95 virtual void DragAcceptFiles(bool accept);
53ce655c 96
af0bb3b1
VZ
97 // Get the unique identifier of a window
98 virtual WXWidget GetHandle() const { return GetMainWidget(); }
34097680 99
af0bb3b1
VZ
100 // implementation from now on
101 // --------------------------
34097680 102
af0bb3b1
VZ
103 // accessors
104 // ---------
34097680 105
af0bb3b1
VZ
106 // Get main widget for this window, e.g. a text widget
107 virtual WXWidget GetMainWidget() const;
a8680e3e
MB
108 // Get the widget that corresponds to the label (for font setting,
109 // label setting etc.)
af0bb3b1
VZ
110 virtual WXWidget GetLabelWidget() const;
111 // Get the client widget for this window (something we can create other
112 // windows on)
113 virtual WXWidget GetClientWidget() const;
114 // Get the top widget for this window, e.g. the scrolled widget parent of a
115 // multi-line text widget. Top means, top in the window hierarchy that
116 // implements this window.
117 virtual WXWidget GetTopWidget() const;
34097680 118
af0bb3b1 119 // Get the underlying X window and display
1807c27d 120 WXWindow GetClientXWindow() const;
af0bb3b1
VZ
121 WXWindow GetXWindow() const;
122 WXDisplay *GetXDisplay() const;
34097680 123
af0bb3b1 124 void SetLastClick(int button, long timestamp)
83df96d6 125 { m_lastButton = button; m_lastTS = timestamp; }
34097680 126
af0bb3b1
VZ
127 int GetLastClickedButton() const { return m_lastButton; }
128 long GetLastClickTime() const { return m_lastTS; }
34097680 129
a8680e3e
MB
130 // Gives window a chance to do something in response to a size message,
131 // e.g. arrange status bar, toolbar etc.
af0bb3b1 132 virtual bool PreResize();
34097680 133
af0bb3b1
VZ
134 // Generates a paint event
135 virtual void DoPaint();
34097680 136
af0bb3b1
VZ
137 // update rectangle/region manipulation
138 // (for wxWindowDC and Motif callbacks only)
139 // -----------------------------------------
34097680 140
af0bb3b1 141 // Adds a recangle to the updates list
148b44a1 142 void AddUpdateRect(int x, int y, int w, int h);
34097680 143
af0bb3b1
VZ
144 void ClearUpdateRegion() { m_updateRegion.Clear(); }
145 void SetUpdateRegion(const wxRegion& region) { m_updateRegion = region; }
34097680 146
e39af974
JS
147 // Process idle (send update events)
148 void OnInternalIdle();
34097680 149
105fbe1f
MB
150 // post-creation activities
151 void PostCreation();
152
153 // pre-creation activities
154 void PreCreation();
155
d6eaea28 156protected:
bfc6fde4
VZ
157 // Responds to colour changes: passes event on to children.
158 void OnSysColourChanged(wxSysColourChangedEvent& event);
34097680 159
34636400 160 // Motif-specific
34097680 161
34636400 162 void SetMainWidget(WXWidget w) { m_mainWidget = w; }
34097680 163
37c997b4
MB
164 // See src/motif/window.cpp, near the top, for an explanation
165 // why this is necessary
166 void CanvasSetSizeIntr(int x, int y, int width, int height,
167 int sizeFlags, bool fromCtor);
168 void DoSetSizeIntr(int x, int y,
169 int width, int height,
170 int sizeFlags, bool fromCtor);
fc7ca9b3
MB
171
172 // for DoMoveWindowIntr flags
173 enum
174 {
175 wxMOVE_X = 1,
176 wxMOVE_Y = 2,
177 wxMOVE_WIDTH = 4,
178 wxMOVE_HEIGHT = 8
179 };
180
181 void DoMoveWindowIntr(int x, int y, int width, int height,
182 int flags);
148b44a1
MB
183
184 // helper function, to remove duplicate code, used in wxScrollBar
185 WXWidget DoCreateScrollBar(WXWidget parent, wxOrientation orientation,
186 void (*callback)());
9806a47c 187public:
34636400 188 WXPixmap GetBackingPixmap() const { return m_backingPixmap; }
9806a47c 189 void SetBackingPixmap(WXPixmap pixmap) { m_backingPixmap = pixmap; }
bfc6fde4
VZ
190 int GetPixmapWidth() const { return m_pixmapWidth; }
191 int GetPixmapHeight() const { return m_pixmapHeight; }
9806a47c
JS
192 void SetPixmapWidth(int w) { m_pixmapWidth = w; }
193 void SetPixmapHeight(int h) { m_pixmapHeight = h; }
34097680 194
bfc6fde4 195 // Change properties
a8680e3e 196 // Change to the current font (often overridden)
96be256b 197 virtual void ChangeFont(bool keepOriginalSize = true);
34097680 198
34636400
VZ
199 // Change background and foreground colour using current background colour
200 // setting (Motif generates foreground based on background)
201 virtual void ChangeBackgroundColour();
202 // Change foreground colour using current foreground colour setting
203 virtual void ChangeForegroundColour();
34097680 204
da175b2c 205protected:
bfc6fde4 206 // Adds the widget to the hash table and adds event handlers.
34636400 207 bool AttachWidget(wxWindow* parent, WXWidget mainWidget,
83df96d6 208 WXWidget formWidget, int x, int y, int width, int height);
bfc6fde4 209 bool DetachWidget(WXWidget widget);
34097680 210
34636400 211 // How to implement accelerators. If we find a key event, translate to
77ffb593 212 // wxWidgets wxKeyEvent form. Find a widget for the window. Now find a
34636400 213 // wxWindow for the widget. If there isn't one, go up the widget hierarchy
bfc6fde4 214 // trying to find one. Once one is found, call ProcessAccelerator for the
96be256b 215 // window. If it returns true (processed the event), skip the X event,
77ffb593 216 // otherwise carry on up the wxWidgets window hierarchy calling
96be256b 217 // ProcessAccelerator. If all return false, process the X event as normal.
34636400
VZ
218 // Eventually we can implement OnCharHook the same way, but concentrate on
219 // accelerators for now. ProcessAccelerator must look at the current
220 // accelerator table, and try to find what menu id or window (beneath it)
221 // has this ID. Then construct an appropriate command
bfc6fde4 222 // event and send it.
d75638f8 223public:
bfc6fde4 224 virtual bool ProcessAccelerator(wxKeyEvent& event);
34097680 225
d75638f8 226protected:
34636400
VZ
227 // unmanage and destroy an X widget f it's !NULL (passing NULL is ok)
228 void UnmanageAndDestroy(WXWidget widget);
34097680 229
a8680e3e 230 // map or unmap an X widget (passing NULL is ok),
96be256b 231 // returns true if widget was mapped/unmapped
34636400 232 bool MapOrUnmap(WXWidget widget, bool map);
34097680 233
af0bb3b1
VZ
234 // scrolling stuff
235 // ---------------
34097680 236
af0bb3b1
VZ
237 // create/destroy window scrollbars
238 void CreateScrollbar(wxOrientation orientation);
239 void DestroyScrollbar(wxOrientation orientation);
34097680 240
34636400
VZ
241 // get either hor or vert scrollbar widget
242 WXWidget GetScrollbar(wxOrientation orient) const
83df96d6 243 { return orient == wxHORIZONTAL ? m_hScrollBar : m_vScrollBar; }
34097680 244
34636400
VZ
245 // set the scroll pos
246 void SetInternalScrollPos(wxOrientation orient, int pos)
247 {
248 if ( orient == wxHORIZONTAL )
249 m_scrollPosX = pos;
250 else
251 m_scrollPosY = pos;
252 }
34097680 253
34636400 254 // Motif-specific flags
af0bb3b1 255 // --------------------
34097680 256
34636400 257 bool m_needsRefresh:1; // repaint backing store?
34097680 258
bfc6fde4 259 // For double-click detection
a8680e3e
MB
260 long m_lastTS; // last timestamp
261 unsigned m_lastButton:2; // last pressed button
34097680 262
9b6dbb09 263protected:
bfc6fde4
VZ
264 WXWidget m_mainWidget;
265 WXWidget m_hScrollBar;
266 WXWidget m_vScrollBar;
267 WXWidget m_borderWidget;
268 WXWidget m_scrolledWindow;
269 WXWidget m_drawingArea;
a8680e3e 270 bool m_winCaptured:1;
bfc6fde4
VZ
271 WXPixmap m_backingPixmap;
272 int m_pixmapWidth;
273 int m_pixmapHeight;
274 int m_pixmapOffsetX;
275 int m_pixmapOffsetY;
34097680 276
a8680e3e
MB
277 // Store the last scroll pos, since in wxWin the pos isn't set
278 // automatically by system
34636400
VZ
279 int m_scrollPosX;
280 int m_scrollPosY;
34097680 281
34636400
VZ
282 // implement the base class pure virtuals
283 virtual void DoClientToScreen( int *x, int *y ) const;
284 virtual void DoScreenToClient( int *x, int *y ) const;
285 virtual void DoGetPosition( int *x, int *y ) const;
286 virtual void DoGetSize( int *width, int *height ) const;
287 virtual void DoGetClientSize( int *width, int *height ) const;
bfc6fde4 288 virtual void DoSetSize(int x, int y,
83df96d6
JS
289 int width, int height,
290 int sizeFlags = wxSIZE_AUTO);
bfc6fde4 291 virtual void DoSetClientSize(int width, int height);
9d9b7755 292 virtual void DoMoveWindow(int x, int y, int width, int height);
ee31c392 293 virtual bool DoPopupMenu(wxMenu *menu, int x, int y);
4116c221
VZ
294 virtual void DoCaptureMouse();
295 virtual void DoReleaseMouse();
53ce655c 296
34636400
VZ
297#if wxUSE_TOOLTIPS
298 virtual void DoSetToolTip( wxToolTip *tip );
299#endif // wxUSE_TOOLTIPS
34097680 300
bfc6fde4 301private:
34636400
VZ
302 // common part of all ctors
303 void Init();
34097680 304
c4ea2971
GD
305 DECLARE_DYNAMIC_CLASS(wxWindow)
306 DECLARE_NO_COPY_CLASS(wxWindow)
bfc6fde4 307 DECLARE_EVENT_TABLE()
9b6dbb09
JS
308};
309
34636400 310// ----------------------------------------------------------------------------
af0bb3b1
VZ
311// A little class to switch off `size optimization' while an instance of the
312// object exists: this may be useful to temporarily disable the optimisation
313// which consists to do nothing when the new size is equal to the old size -
314// although quite useful usually to avoid flicker, sometimes it leads to
315// undesired effects.
34636400 316//
af0bb3b1 317// Usage: create an instance of this class on the stack to disable the size
a8680e3e
MB
318// optimisation, it will be reenabled as soon as the object goes out
319// from scope.
34636400 320// ----------------------------------------------------------------------------
af0bb3b1
VZ
321
322class WXDLLEXPORT wxNoOptimize
88150e60
JS
323{
324public:
83df96d6
JS
325 wxNoOptimize() { ms_count++; }
326 ~wxNoOptimize() { ms_count--; }
34097680 327
83df96d6 328 static bool CanOptimize() { return ms_count == 0; }
34097680 329
88150e60 330protected:
83df96d6 331 static int ms_count;
88150e60
JS
332};
333
34097680 334#endif // _WX_WINDOW_H_