| 1 | ///////////////////////////////////////////////////////////////////////////// |
| 2 | // Name: window.h |
| 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 |
| 9 | // Licence: wxWindows licence |
| 10 | ///////////////////////////////////////////////////////////////////////////// |
| 11 | |
| 12 | #ifndef _WX_WINDOW_H_ |
| 13 | #define _WX_WINDOW_H_ |
| 14 | |
| 15 | #ifdef __GNUG__ |
| 16 | #pragma interface "window.h" |
| 17 | #endif |
| 18 | |
| 19 | #include "wx/region.h" |
| 20 | |
| 21 | // ---------------------------------------------------------------------------- |
| 22 | // wxWindow class for Motif - see also wxWindowBase |
| 23 | // ---------------------------------------------------------------------------- |
| 24 | |
| 25 | class wxWindow : public wxWindowBase |
| 26 | { |
| 27 | DECLARE_DYNAMIC_CLASS(wxWindow) |
| 28 | |
| 29 | friend class WXDLLEXPORT wxDC; |
| 30 | friend class WXDLLEXPORT wxWindowDC; |
| 31 | |
| 32 | public: |
| 33 | wxWindow() { Init(); } |
| 34 | |
| 35 | wxWindow(wxWindow *parent, |
| 36 | wxWindowID id, |
| 37 | const wxPoint& pos = wxDefaultPosition, |
| 38 | const wxSize& size = wxDefaultSize, |
| 39 | long style = 0, |
| 40 | const wxString& name = wxPanelNameStr) |
| 41 | { |
| 42 | Init(); |
| 43 | Create(parent, id, pos, size, style, name); |
| 44 | } |
| 45 | |
| 46 | virtual ~wxWindow(); |
| 47 | |
| 48 | bool Create(wxWindow *parent, |
| 49 | wxWindowID id, |
| 50 | const wxPoint& pos = wxDefaultPosition, |
| 51 | const wxSize& size = wxDefaultSize, |
| 52 | long style = 0, |
| 53 | const wxString& name = wxPanelNameStr); |
| 54 | |
| 55 | // implement base class pure virtuals |
| 56 | virtual void SetTitle( const wxString& title); |
| 57 | virtual wxString GetTitle() const; |
| 58 | |
| 59 | virtual void Raise(); |
| 60 | virtual void Lower(); |
| 61 | |
| 62 | virtual bool Show( bool show = TRUE ); |
| 63 | virtual bool Enable( bool enable = TRUE ); |
| 64 | |
| 65 | virtual void SetFocus(); |
| 66 | |
| 67 | virtual void WarpPointer(int x, int y); |
| 68 | virtual void CaptureMouse(); |
| 69 | virtual void ReleaseMouse(); |
| 70 | |
| 71 | virtual void Refresh( bool eraseBackground = TRUE, |
| 72 | const wxRect *rect = (const wxRect *) NULL ); |
| 73 | virtual void Clear(); |
| 74 | |
| 75 | virtual bool SetBackgroundColour( const wxColour &colour ); |
| 76 | virtual bool SetForegroundColour( const wxColour &colour ); |
| 77 | |
| 78 | virtual bool SetCursor( const wxCursor &cursor ); |
| 79 | virtual bool SetFont( const wxFont &font ); |
| 80 | |
| 81 | virtual int GetCharHeight() const; |
| 82 | virtual int GetCharWidth() const; |
| 83 | virtual void GetTextExtent(const wxString& string, |
| 84 | int *x, int *y, |
| 85 | int *descent = (int *) NULL, |
| 86 | int *externalLeading = (int *) NULL, |
| 87 | const wxFont *theFont = (const wxFont *) NULL) |
| 88 | const; |
| 89 | |
| 90 | virtual void SetScrollbar( int orient, int pos, int thumbVisible, |
| 91 | int range, bool refresh = TRUE ); |
| 92 | virtual void SetScrollPos( int orient, int pos, bool refresh = TRUE ); |
| 93 | virtual int GetScrollPos( int orient ) const; |
| 94 | virtual int GetScrollThumb( int orient ) const; |
| 95 | virtual int GetScrollRange( int orient ) const; |
| 96 | virtual void ScrollWindow( int dx, int dy, |
| 97 | const wxRect* rect = (wxRect *) NULL ); |
| 98 | |
| 99 | virtual void SetSizeHints(int minW, int minH, |
| 100 | int maxW = -1, int maxH = -1, |
| 101 | int incW = -1, int incH = -1); |
| 102 | #if wxUSE_DRAG_AND_DROP |
| 103 | virtual void SetDropTarget( wxDropTarget *dropTarget ); |
| 104 | #endif // wxUSE_DRAG_AND_DROP |
| 105 | |
| 106 | // Accept files for dragging |
| 107 | virtual void DragAcceptFiles(bool accept); |
| 108 | |
| 109 | // Get the unique identifier of a window |
| 110 | virtual WXWidget GetHandle() const { return GetMainWidget(); } |
| 111 | |
| 112 | // implementation from now on |
| 113 | // -------------------------- |
| 114 | |
| 115 | // accessors |
| 116 | // --------- |
| 117 | |
| 118 | // Get main widget for this window, e.g. a text widget |
| 119 | virtual WXWidget GetMainWidget() const; |
| 120 | // Get the widget that corresponds to the label (for font setting, label setting etc.) |
| 121 | virtual WXWidget GetLabelWidget() const; |
| 122 | // Get the client widget for this window (something we can create other |
| 123 | // windows on) |
| 124 | virtual WXWidget GetClientWidget() const; |
| 125 | // Get the top widget for this window, e.g. the scrolled widget parent of a |
| 126 | // multi-line text widget. Top means, top in the window hierarchy that |
| 127 | // implements this window. |
| 128 | virtual WXWidget GetTopWidget() const; |
| 129 | |
| 130 | // Get the underlying X window and display |
| 131 | WXWindow GetXWindow() const; |
| 132 | WXDisplay *GetXDisplay() const; |
| 133 | |
| 134 | // called from Motif callbacks - and should only be called from there |
| 135 | |
| 136 | void SetButton1(bool pressed) { m_button1Pressed = pressed; } |
| 137 | void SetButton2(bool pressed) { m_button2Pressed = pressed; } |
| 138 | void SetButton3(bool pressed) { m_button3Pressed = pressed; } |
| 139 | |
| 140 | void SetLastClick(int button, long timestamp) |
| 141 | { m_lastButton = button; m_lastTS = timestamp; } |
| 142 | |
| 143 | int GetLastClickedButton() const { return m_lastButton; } |
| 144 | long GetLastClickTime() const { return m_lastTS; } |
| 145 | |
| 146 | // Gives window a chance to do something in response to a size message, e.g. |
| 147 | // arrange status bar, toolbar etc. |
| 148 | virtual bool PreResize(); |
| 149 | |
| 150 | // Generates a paint event |
| 151 | virtual void DoPaint(); |
| 152 | |
| 153 | // update rectangle/region manipulation |
| 154 | // (for wxWindowDC and Motif callbacks only) |
| 155 | // ----------------------------------------- |
| 156 | |
| 157 | // read/write access to the update rect list |
| 158 | const wxRectList& GetUpdateRects() const { return m_updateRects; } |
| 159 | |
| 160 | // Adds a recangle to the updates list |
| 161 | void AddUpdateRect(int x, int y, int w, int h) |
| 162 | { m_updateRects.Append(new wxRect(x, y, w, h)); } |
| 163 | |
| 164 | // Empties the m_updateRects list |
| 165 | void ClearUpdateRects(); |
| 166 | |
| 167 | void ClearUpdateRegion() { m_updateRegion.Clear(); } |
| 168 | void SetUpdateRegion(const wxRegion& region) { m_updateRegion = region; } |
| 169 | |
| 170 | // sets the fore/background colour for the given widget |
| 171 | static void DoChangeForegroundColour(WXWidget widget, wxColour& foregroundColour); |
| 172 | static void DoChangeBackgroundColour(WXWidget widget, wxColour& backgroundColour, bool changeArmColour = FALSE); |
| 173 | |
| 174 | protected: |
| 175 | // event handlers (not virtual by design) |
| 176 | void OnIdle(wxIdleEvent& event); |
| 177 | |
| 178 | // For implementation purposes - sometimes decorations make the client area |
| 179 | // smaller |
| 180 | virtual wxPoint GetClientAreaOrigin() const; |
| 181 | |
| 182 | // Makes an adjustment to the window position (for example, a frame that has |
| 183 | // a toolbar that it manages itself). |
| 184 | virtual void AdjustForParentClientOrigin(int& x, int& y, int sizeFlags); |
| 185 | |
| 186 | wxWindow *GetChild(int number) const |
| 187 | { return GetChildren().Item(number)->GetData(); } |
| 188 | |
| 189 | // Responds to colour changes: passes event on to children. |
| 190 | void OnSysColourChanged(wxSysColourChangedEvent& event); |
| 191 | |
| 192 | // Motif-specific |
| 193 | |
| 194 | // CanvasXXXSiize functions |
| 195 | void CanvasGetSize(int* width, int* height) const; // If have drawing area |
| 196 | void CanvasGetClientSize(int *width, int *height) const; |
| 197 | void CanvasGetPosition(int *x, int *y) const; // If have drawing area |
| 198 | void CanvasSetClientSize(int width, int size); |
| 199 | void CanvasSetSize(int x, int y, int width, int height, int sizeFlags = wxSIZE_AUTO); |
| 200 | |
| 201 | void SetMainWidget(WXWidget w) { m_mainWidget = w; } |
| 202 | |
| 203 | bool CanAddEventHandler() const { return m_canAddEventHandler; } |
| 204 | void SetCanAddEventHandler(bool flag) { m_canAddEventHandler = flag; } |
| 205 | |
| 206 | WXPixmap GetBackingPixmap() const { return m_backingPixmap; } |
| 207 | int GetPixmapWidth() const { return m_pixmapWidth; } |
| 208 | int GetPixmapHeight() const { return m_pixmapHeight; } |
| 209 | |
| 210 | public: |
| 211 | // Change properties |
| 212 | virtual void ChangeFont(bool keepOriginalSize = TRUE); // Change to the current font (often overridden) |
| 213 | |
| 214 | // Change background and foreground colour using current background colour |
| 215 | // setting (Motif generates foreground based on background) |
| 216 | virtual void ChangeBackgroundColour(); |
| 217 | // Change foreground colour using current foreground colour setting |
| 218 | virtual void ChangeForegroundColour(); |
| 219 | |
| 220 | protected: |
| 221 | // Adds the widget to the hash table and adds event handlers. |
| 222 | bool AttachWidget(wxWindow* parent, WXWidget mainWidget, |
| 223 | WXWidget formWidget, int x, int y, int width, int height); |
| 224 | bool DetachWidget(WXWidget widget); |
| 225 | |
| 226 | // How to implement accelerators. If we find a key event, translate to |
| 227 | // wxWindows wxKeyEvent form. Find a widget for the window. Now find a |
| 228 | // wxWindow for the widget. If there isn't one, go up the widget hierarchy |
| 229 | // trying to find one. Once one is found, call ProcessAccelerator for the |
| 230 | // window. If it returns TRUE (processed the event), skip the X event, |
| 231 | // otherwise carry on up the wxWindows window hierarchy calling |
| 232 | // ProcessAccelerator. If all return FALSE, process the X event as normal. |
| 233 | // Eventually we can implement OnCharHook the same way, but concentrate on |
| 234 | // accelerators for now. ProcessAccelerator must look at the current |
| 235 | // accelerator table, and try to find what menu id or window (beneath it) |
| 236 | // has this ID. Then construct an appropriate command |
| 237 | // event and send it. |
| 238 | public: |
| 239 | virtual bool ProcessAccelerator(wxKeyEvent& event); |
| 240 | |
| 241 | protected: |
| 242 | // unmanage and destroy an X widget f it's !NULL (passing NULL is ok) |
| 243 | void UnmanageAndDestroy(WXWidget widget); |
| 244 | |
| 245 | // map or unmap an X widget (passing NULL is ok), returns TRUE if widget was |
| 246 | // mapped/unmapped |
| 247 | bool MapOrUnmap(WXWidget widget, bool map); |
| 248 | |
| 249 | // scrolling stuff |
| 250 | // --------------- |
| 251 | |
| 252 | // create/destroy window scrollbars |
| 253 | void CreateScrollbar(wxOrientation orientation); |
| 254 | void DestroyScrollbar(wxOrientation orientation); |
| 255 | |
| 256 | // get either hor or vert scrollbar widget |
| 257 | WXWidget GetScrollbar(wxOrientation orient) const |
| 258 | { return orient == wxHORIZONTAL ? m_hScrollBar : m_vScrollBar; } |
| 259 | |
| 260 | // set the scroll pos |
| 261 | void SetInternalScrollPos(wxOrientation orient, int pos) |
| 262 | { |
| 263 | if ( orient == wxHORIZONTAL ) |
| 264 | m_scrollPosX = pos; |
| 265 | else |
| 266 | m_scrollPosY = pos; |
| 267 | } |
| 268 | |
| 269 | // Motif-specific flags |
| 270 | // -------------------- |
| 271 | |
| 272 | bool m_needsRefresh:1; // repaint backing store? |
| 273 | bool m_canAddEventHandler:1; // ??? |
| 274 | bool m_button1Pressed:1; |
| 275 | bool m_button2Pressed:1; |
| 276 | bool m_button3Pressed:1; |
| 277 | |
| 278 | // For double-click detection |
| 279 | long m_lastTS; // last timestamp |
| 280 | int m_lastButton; // last pressed button |
| 281 | |
| 282 | // List of wxRects representing damaged region |
| 283 | wxRectList m_updateRects; |
| 284 | |
| 285 | protected: |
| 286 | WXWidget m_mainWidget; |
| 287 | WXWidget m_hScrollBar; |
| 288 | WXWidget m_vScrollBar; |
| 289 | WXWidget m_borderWidget; |
| 290 | WXWidget m_scrolledWindow; |
| 291 | WXWidget m_drawingArea; |
| 292 | bool m_winCaptured; |
| 293 | bool m_hScroll; |
| 294 | bool m_vScroll; |
| 295 | WXPixmap m_backingPixmap; |
| 296 | int m_pixmapWidth; |
| 297 | int m_pixmapHeight; |
| 298 | int m_pixmapOffsetX; |
| 299 | int m_pixmapOffsetY; |
| 300 | |
| 301 | // Store the last scroll pos, since in wxWin the pos isn't set automatically |
| 302 | // by system |
| 303 | int m_scrollPosX; |
| 304 | int m_scrollPosY; |
| 305 | |
| 306 | // implement the base class pure virtuals |
| 307 | virtual void DoClientToScreen( int *x, int *y ) const; |
| 308 | virtual void DoScreenToClient( int *x, int *y ) const; |
| 309 | virtual void DoGetPosition( int *x, int *y ) const; |
| 310 | virtual void DoGetSize( int *width, int *height ) const; |
| 311 | virtual void DoGetClientSize( int *width, int *height ) const; |
| 312 | virtual void DoSetSize(int x, int y, |
| 313 | int width, int height, |
| 314 | int sizeFlags = wxSIZE_AUTO); |
| 315 | virtual void DoSetClientSize(int width, int height); |
| 316 | virtual bool DoPopupMenu(wxMenu *menu, int x, int y); |
| 317 | |
| 318 | #if wxUSE_TOOLTIPS |
| 319 | virtual void DoSetToolTip( wxToolTip *tip ); |
| 320 | #endif // wxUSE_TOOLTIPS |
| 321 | |
| 322 | private: |
| 323 | // common part of all ctors |
| 324 | void Init(); |
| 325 | |
| 326 | DECLARE_NO_COPY_CLASS(wxWindow); |
| 327 | DECLARE_EVENT_TABLE() |
| 328 | }; |
| 329 | |
| 330 | // ---------------------------------------------------------------------------- |
| 331 | // A little class to switch off `size optimization' while an instance of the |
| 332 | // object exists: this may be useful to temporarily disable the optimisation |
| 333 | // which consists to do nothing when the new size is equal to the old size - |
| 334 | // although quite useful usually to avoid flicker, sometimes it leads to |
| 335 | // undesired effects. |
| 336 | // |
| 337 | // Usage: create an instance of this class on the stack to disable the size |
| 338 | // optimisation, it will be reenabled as soon as the object goes out from scope. |
| 339 | // ---------------------------------------------------------------------------- |
| 340 | |
| 341 | class WXDLLEXPORT wxNoOptimize |
| 342 | { |
| 343 | public: |
| 344 | wxNoOptimize() { ms_count++; } |
| 345 | ~wxNoOptimize() { ms_count--; } |
| 346 | |
| 347 | static bool CanOptimize() { return ms_count == 0; } |
| 348 | |
| 349 | protected: |
| 350 | static int ms_count; |
| 351 | }; |
| 352 | |
| 353 | #endif |
| 354 | // _WX_WINDOW_H_ |