include/wx/motif/window.h

   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 public:
 207     WXPixmap GetBackingPixmap() const { return m_backingPixmap; }
 208     void SetBackingPixmap(WXPixmap pixmap) { m_backingPixmap = pixmap; }
 209     int GetPixmapWidth() const { return m_pixmapWidth; }
 210     int GetPixmapHeight() const { return m_pixmapHeight; }
 211     void SetPixmapWidth(int w) { m_pixmapWidth = w; }
 212     void SetPixmapHeight(int h) { m_pixmapHeight = h; }
 213
 214     // Change properties
 215     virtual void ChangeFont(bool keepOriginalSize = TRUE);             // Change to the current font (often overridden)
 216
 217     // Change background and foreground colour using current background colour
 218     // setting (Motif generates foreground based on background)
 219     virtual void ChangeBackgroundColour();
 220     // Change foreground colour using current foreground colour setting
 221     virtual void ChangeForegroundColour();
 222
 223 protected:
 224     // Adds the widget to the hash table and adds event handlers.
 225     bool AttachWidget(wxWindow* parent, WXWidget mainWidget,
 226                       WXWidget formWidget, int x, int y, int width, int height);
 227     bool DetachWidget(WXWidget widget);
 228
 229     // How to implement accelerators. If we find a key event, translate to
 230     // wxWindows wxKeyEvent form. Find a widget for the window. Now find a
 231     // wxWindow for the widget. If there isn't one, go up the widget hierarchy
 232     // trying to find one. Once one is found, call ProcessAccelerator for the
 233     // window. If it returns TRUE (processed the event), skip the X event,
 234     // otherwise carry on up the wxWindows window hierarchy calling
 235     // ProcessAccelerator. If all return FALSE, process the X event as normal.
 236     // Eventually we can implement OnCharHook the same way, but concentrate on
 237     // accelerators for now. ProcessAccelerator must look at the current
 238     // accelerator table, and try to find what menu id or window (beneath it)
 239     // has this ID. Then construct an appropriate command
 240     // event and send it.
 241 public:
 242     virtual bool ProcessAccelerator(wxKeyEvent& event);
 243
 244 protected:
 245     // unmanage and destroy an X widget f it's !NULL (passing NULL is ok)
 246     void UnmanageAndDestroy(WXWidget widget);
 247
 248     // map or unmap an X widget (passing NULL is ok), returns TRUE if widget was
 249     // mapped/unmapped
 250     bool MapOrUnmap(WXWidget widget, bool map);
 251
 252     // scrolling stuff
 253     // ---------------
 254
 255     // create/destroy window scrollbars
 256     void CreateScrollbar(wxOrientation orientation);
 257     void DestroyScrollbar(wxOrientation orientation);
 258
 259     // get either hor or vert scrollbar widget
 260     WXWidget GetScrollbar(wxOrientation orient) const
 261         { return orient == wxHORIZONTAL ? m_hScrollBar : m_vScrollBar; }
 262
 263     // set the scroll pos
 264     void SetInternalScrollPos(wxOrientation orient, int pos)
 265     {
 266         if ( orient == wxHORIZONTAL )
 267             m_scrollPosX = pos;
 268         else
 269             m_scrollPosY = pos;
 270     }
 271
 272     // Motif-specific flags
 273     // --------------------
 274
 275     bool m_needsRefresh:1;          // repaint backing store?
 276     bool m_canAddEventHandler:1;    // ???
 277     bool m_button1Pressed:1;
 278     bool m_button2Pressed:1;
 279     bool m_button3Pressed:1;
 280
 281     // For double-click detection
 282     long   m_lastTS;         // last timestamp
 283     int    m_lastButton;     // last pressed button
 284
 285     // List of wxRects representing damaged region
 286     wxRectList m_updateRects;
 287
 288 protected:
 289     WXWidget              m_mainWidget;
 290     WXWidget              m_hScrollBar;
 291     WXWidget              m_vScrollBar;
 292     WXWidget              m_borderWidget;
 293     WXWidget              m_scrolledWindow;
 294     WXWidget              m_drawingArea;
 295     bool                  m_winCaptured;
 296     bool                  m_hScroll;
 297     bool                  m_vScroll;
 298     WXPixmap              m_backingPixmap;
 299     int                   m_pixmapWidth;
 300     int                   m_pixmapHeight;
 301     int                   m_pixmapOffsetX;
 302     int                   m_pixmapOffsetY;
 303
 304     // Store the last scroll pos, since in wxWin the pos isn't set automatically
 305     // by system
 306     int                   m_scrollPosX;
 307     int                   m_scrollPosY;
 308
 309     // implement the base class pure virtuals
 310     virtual void DoClientToScreen( int *x, int *y ) const;
 311     virtual void DoScreenToClient( int *x, int *y ) const;
 312     virtual void DoGetPosition( int *x, int *y ) const;
 313     virtual void DoGetSize( int *width, int *height ) const;
 314     virtual void DoGetClientSize( int *width, int *height ) const;
 315     virtual void DoSetSize(int x, int y,
 316                            int width, int height,
 317                            int sizeFlags = wxSIZE_AUTO);
 318     virtual void DoSetClientSize(int width, int height);
 319     virtual void DoMoveWindow(int x, int y, int width, int height);
 320     virtual bool DoPopupMenu(wxMenu *menu, int x, int y);
 321
 322 #if wxUSE_TOOLTIPS
 323     virtual void DoSetToolTip( wxToolTip *tip );
 324 #endif // wxUSE_TOOLTIPS
 325
 326 private:
 327     // common part of all ctors
 328     void Init();
 329
 330     DECLARE_NO_COPY_CLASS(wxWindow);
 331     DECLARE_EVENT_TABLE()
 332 };
 333
 334 // ----------------------------------------------------------------------------
 335 // A little class to switch off `size optimization' while an instance of the
 336 // object exists: this may be useful to temporarily disable the optimisation
 337 // which consists to do nothing when the new size is equal to the old size -
 338 // although quite useful usually to avoid flicker, sometimes it leads to
 339 // undesired effects.
 340 //
 341 // Usage: create an instance of this class on the stack to disable the size
 342 // optimisation, it will be reenabled as soon as the object goes out from scope.
 343 // ----------------------------------------------------------------------------
 344
 345 class WXDLLEXPORT wxNoOptimize
 346 {
 347 public:
 348   wxNoOptimize() { ms_count++; }
 349   ~wxNoOptimize() { ms_count--; }
 350
 351   static bool CanOptimize() { return ms_count == 0; }
 352
 353 protected:
 354   static int ms_count;
 355 };
 356
 357 #endif
 358     // _WX_WINDOW_H_