include/wx/motif/window.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/motif/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 #include "wx/region.h"
  16
  17 // ----------------------------------------------------------------------------
  18 // wxWindow class for Motif - see also wxWindowBase
  19 // ----------------------------------------------------------------------------
  20
  21 class WXDLLIMPEXP_CORE wxWindow : public wxWindowBase
  22 {
  23     friend class WXDLLIMPEXP_FWD_CORE wxDC;
  24     friend class WXDLLIMPEXP_FWD_CORE wxWindowDC;
  25
  26 public:
  27     wxWindow() { Init(); }
  28
  29     wxWindow(wxWindow *parent,
  30              wxWindowID id,
  31              const wxPoint& pos = wxDefaultPosition,
  32              const wxSize& size = wxDefaultSize,
  33              long style = 0,
  34              const wxString& name = wxPanelNameStr)
  35     {
  36         Init();
  37         Create(parent, id, pos, size, style, name);
  38     }
  39
  40     virtual ~wxWindow();
  41
  42     bool Create(wxWindow *parent,
  43                 wxWindowID id,
  44                 const wxPoint& pos = wxDefaultPosition,
  45                 const wxSize& size = wxDefaultSize,
  46                 long style = 0,
  47                 const wxString& name = wxPanelNameStr);
  48
  49     // implement base class pure virtuals
  50     virtual void SetLabel(const wxString& label);
  51     virtual wxString GetLabel() const;
  52
  53     virtual void Raise();
  54     virtual void Lower();
  55
  56     virtual bool Show( bool show = true );
  57     virtual bool Enable( bool enable = true );
  58
  59     virtual void SetFocus();
  60
  61     virtual void WarpPointer(int x, int y);
  62
  63     virtual void Refresh( bool eraseBackground = true,
  64         const wxRect *rect = (const wxRect *) NULL );
  65
  66     virtual bool SetBackgroundColour( const wxColour &colour );
  67     virtual bool SetForegroundColour( const wxColour &colour );
  68
  69     virtual bool SetCursor( const wxCursor &cursor );
  70     virtual bool SetFont( const wxFont &font );
  71
  72     virtual int GetCharHeight() const;
  73     virtual int GetCharWidth() const;
  74     virtual void GetTextExtent(const wxString& string,
  75         int *x, int *y,
  76         int *descent = (int *) NULL,
  77         int *externalLeading = (int *) NULL,
  78         const wxFont *theFont = (const wxFont *) NULL)
  79         const;
  80
  81     virtual void SetScrollbar( int orient, int pos, int thumbVisible,
  82         int range, bool refresh = true );
  83     virtual void SetScrollPos( int orient, int pos, bool refresh = true );
  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,
  88         const wxRect* rect = (wxRect *) NULL );
  89
  90 #if wxUSE_DRAG_AND_DROP
  91     virtual void SetDropTarget( wxDropTarget *dropTarget );
  92 #endif // wxUSE_DRAG_AND_DROP
  93
  94     // Accept files for dragging
  95     virtual void DragAcceptFiles(bool accept);
  96
  97     // Get the unique identifier of a window
  98     virtual WXWidget GetHandle() const { return GetMainWidget(); }
  99
 100     // implementation from now on
 101     // --------------------------
 102
 103     // accessors
 104     // ---------
 105
 106     // Get main widget for this window, e.g. a text widget
 107     virtual WXWidget GetMainWidget() const;
 108     // Get the widget that corresponds to the label (for font setting,
 109     // label setting etc.)
 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;
 118
 119     // Get the underlying X window and display
 120     WXWindow GetClientXWindow() const;
 121     WXWindow GetXWindow() const;
 122     WXDisplay *GetXDisplay() const;
 123
 124     void SetLastClick(int button, long timestamp)
 125     { m_lastButton = button; m_lastTS = timestamp; }
 126
 127     int GetLastClickedButton() const { return m_lastButton; }
 128     long GetLastClickTime() const { return m_lastTS; }
 129
 130     // Gives window a chance to do something in response to a size message,
 131     // e.g. arrange status bar, toolbar etc.
 132     virtual bool PreResize();
 133
 134     // Generates a paint event
 135     virtual void DoPaint();
 136
 137     // update rectangle/region manipulation
 138     // (for wxWindowDC and Motif callbacks only)
 139     // -----------------------------------------
 140
 141     // Adds a recangle to the updates list
 142     void AddUpdateRect(int x, int y, int w, int h);
 143
 144     void ClearUpdateRegion() { m_updateRegion.Clear(); }
 145     void SetUpdateRegion(const wxRegion& region) { m_updateRegion = region; }
 146
 147     // Process idle (send update events)
 148     void OnInternalIdle();
 149
 150     // post-creation activities
 151     void PostCreation();
 152
 153     // pre-creation activities
 154     void PreCreation();
 155
 156 protected:
 157     // Responds to colour changes: passes event on to children.
 158     void OnSysColourChanged(wxSysColourChangedEvent& event);
 159
 160     // Motif-specific
 161
 162     void SetMainWidget(WXWidget w) { m_mainWidget = w; }
 163
 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);
 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);
 183
 184     // helper function, to remove duplicate code, used in wxScrollBar
 185     WXWidget DoCreateScrollBar(WXWidget parent, wxOrientation orientation,
 186                                void (*callback)());
 187 public:
 188     WXPixmap GetBackingPixmap() const { return m_backingPixmap; }
 189     void SetBackingPixmap(WXPixmap pixmap) { m_backingPixmap = pixmap; }
 190     int GetPixmapWidth() const { return m_pixmapWidth; }
 191     int GetPixmapHeight() const { return m_pixmapHeight; }
 192     void SetPixmapWidth(int w) { m_pixmapWidth = w; }
 193     void SetPixmapHeight(int h) { m_pixmapHeight = h; }
 194
 195     // Change properties
 196     // Change to the current font (often overridden)
 197     virtual void ChangeFont(bool keepOriginalSize = true);
 198
 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();
 204
 205 protected:
 206     // Adds the widget to the hash table and adds event handlers.
 207     bool AttachWidget(wxWindow* parent, WXWidget mainWidget,
 208         WXWidget formWidget, int x, int y, int width, int height);
 209     bool DetachWidget(WXWidget widget);
 210
 211     // How to implement accelerators. If we find a key event, translate to
 212     // wxWidgets wxKeyEvent form. Find a widget for the window. Now find a
 213     // wxWindow for the widget. If there isn't one, go up the widget hierarchy
 214     // trying to find one. Once one is found, call ProcessAccelerator for the
 215     // window. If it returns true (processed the event), skip the X event,
 216     // otherwise carry on up the wxWidgets window hierarchy calling
 217     // ProcessAccelerator. If all return false, process the X event as normal.
 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
 222     // event and send it.
 223 public:
 224     virtual bool ProcessAccelerator(wxKeyEvent& event);
 225
 226 protected:
 227     // unmanage and destroy an X widget f it's !NULL (passing NULL is ok)
 228     void UnmanageAndDestroy(WXWidget widget);
 229
 230     // map or unmap an X widget (passing NULL is ok),
 231     // returns true if widget was mapped/unmapped
 232     bool MapOrUnmap(WXWidget widget, bool map);
 233
 234     // scrolling stuff
 235     // ---------------
 236
 237     // create/destroy window scrollbars
 238     void CreateScrollbar(wxOrientation orientation);
 239     void DestroyScrollbar(wxOrientation orientation);
 240
 241     // get either hor or vert scrollbar widget
 242     WXWidget GetScrollbar(wxOrientation orient) const
 243     { return orient == wxHORIZONTAL ? m_hScrollBar : m_vScrollBar; }
 244
 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     }
 253
 254     // Motif-specific flags
 255     // --------------------
 256
 257     bool m_needsRefresh:1;          // repaint backing store?
 258
 259     // For double-click detection
 260     long                  m_lastTS;           // last timestamp
 261     unsigned              m_lastButton:2;     // last pressed button
 262
 263 protected:
 264     WXWidget              m_mainWidget;
 265     WXWidget              m_hScrollBar;
 266     WXWidget              m_vScrollBar;
 267     WXWidget              m_borderWidget;
 268     WXWidget              m_scrolledWindow;
 269     WXWidget              m_drawingArea;
 270     bool                  m_winCaptured:1;
 271     WXPixmap              m_backingPixmap;
 272     int                   m_pixmapWidth;
 273     int                   m_pixmapHeight;
 274     int                   m_pixmapOffsetX;
 275     int                   m_pixmapOffsetY;
 276
 277     // Store the last scroll pos, since in wxWin the pos isn't set
 278     // automatically by system
 279     int                   m_scrollPosX;
 280     int                   m_scrollPosY;
 281
 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;
 288     virtual void DoSetSize(int x, int y,
 289         int width, int height,
 290         int sizeFlags = wxSIZE_AUTO);
 291     virtual void DoSetClientSize(int width, int height);
 292     virtual void DoMoveWindow(int x, int y, int width, int height);
 293     virtual bool DoPopupMenu(wxMenu *menu, int x, int y);
 294     virtual void DoCaptureMouse();
 295     virtual void DoReleaseMouse();
 296
 297 #if wxUSE_TOOLTIPS
 298     virtual void DoSetToolTip( wxToolTip *tip );
 299 #endif // wxUSE_TOOLTIPS
 300
 301 private:
 302     // common part of all ctors
 303     void Init();
 304
 305     DECLARE_DYNAMIC_CLASS(wxWindow)
 306     DECLARE_NO_COPY_CLASS(wxWindow)
 307     DECLARE_EVENT_TABLE()
 308 };
 309
 310 // ----------------------------------------------------------------------------
 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.
 316 //
 317 // Usage: create an instance of this class on the stack to disable the size
 318 // optimisation, it will be reenabled as soon as the object goes out
 319 // from scope.
 320 // ----------------------------------------------------------------------------
 321
 322 class WXDLLIMPEXP_CORE wxNoOptimize
 323 {
 324 public:
 325     wxNoOptimize() { ms_count++; }
 326     ~wxNoOptimize() { ms_count--; }
 327
 328     static bool CanOptimize() { return ms_count == 0; }
 329
 330 protected:
 331     static int ms_count;
 332 };
 333
 334 #endif // _WX_WINDOW_H_