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