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 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  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
  70     virtual bool SetBackgroundColour( const wxColour &colour );
  71     virtual bool SetForegroundColour( const wxColour &colour );
  72
  73     virtual bool SetCursor( const wxCursor &cursor );
  74     virtual bool SetFont( const wxFont &font );
  75
  76     virtual int GetCharHeight() const;
  77     virtual int GetCharWidth() const;
  78     virtual void GetTextExtent(const wxString& string,
  79         int *x, int *y,
  80         int *descent = (int *) NULL,
  81         int *externalLeading = (int *) NULL,
  82         const wxFont *theFont = (const wxFont *) NULL)
  83         const;
  84
  85     virtual void SetScrollbar( int orient, int pos, int thumbVisible,
  86         int range, bool refresh = true );
  87     virtual void SetScrollPos( int orient, int pos, bool refresh = true );
  88     virtual int GetScrollPos( int orient ) const;
  89     virtual int GetScrollThumb( int orient ) const;
  90     virtual int GetScrollRange( int orient ) const;
  91     virtual void ScrollWindow( int dx, int dy,
  92         const wxRect* rect = (wxRect *) NULL );
  93
  94 #if wxUSE_DRAG_AND_DROP
  95     virtual void SetDropTarget( wxDropTarget *dropTarget );
  96 #endif // wxUSE_DRAG_AND_DROP
  97
  98     // Accept files for dragging
  99     virtual void DragAcceptFiles(bool accept);
 100
 101     // Get the unique identifier of a window
 102     virtual WXWidget GetHandle() const { return GetMainWidget(); }
 103
 104     // implementation from now on
 105     // --------------------------
 106
 107     // accessors
 108     // ---------
 109
 110     // Get main widget for this window, e.g. a text widget
 111     virtual WXWidget GetMainWidget() const;
 112     // Get the widget that corresponds to the label (for font setting,
 113     // 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 GetClientXWindow() const;
 125     WXWindow GetXWindow() const;
 126     WXDisplay *GetXDisplay() const;
 127
 128     void SetLastClick(int button, long timestamp)
 129     { m_lastButton = button; m_lastTS = timestamp; }
 130
 131     int GetLastClickedButton() const { return m_lastButton; }
 132     long GetLastClickTime() const { return m_lastTS; }
 133
 134     // Gives window a chance to do something in response to a size message,
 135     // e.g. arrange status bar, toolbar etc.
 136     virtual bool PreResize();
 137
 138     // Generates a paint event
 139     virtual void DoPaint();
 140
 141     // update rectangle/region manipulation
 142     // (for wxWindowDC and Motif callbacks only)
 143     // -----------------------------------------
 144
 145     // Adds a recangle to the updates list
 146     void AddUpdateRect(int x, int y, int w, int h);
 147
 148     void ClearUpdateRegion() { m_updateRegion.Clear(); }
 149     void SetUpdateRegion(const wxRegion& region) { m_updateRegion = region; }
 150
 151     // Process idle (send update events)
 152     void OnInternalIdle();
 153
 154 protected:
 155     // Responds to colour changes: passes event on to children.
 156     void OnSysColourChanged(wxSysColourChangedEvent& event);
 157
 158     // Motif-specific
 159
 160     void SetMainWidget(WXWidget w) { m_mainWidget = w; }
 161
 162     // See src/motif/window.cpp, near the top, for an explanation
 163     // why this is necessary
 164     void CanvasSetSizeIntr(int x, int y, int width, int height,
 165                            int sizeFlags, bool fromCtor);
 166     void DoSetSizeIntr(int x, int y,
 167                        int width, int height,
 168                        int sizeFlags, bool fromCtor);
 169
 170     // for DoMoveWindowIntr flags
 171     enum
 172     {
 173         wxMOVE_X = 1,
 174         wxMOVE_Y = 2,
 175         wxMOVE_WIDTH = 4,
 176         wxMOVE_HEIGHT = 8
 177     };
 178
 179     void DoMoveWindowIntr(int x, int y, int width, int height,
 180                           int flags);
 181
 182     // helper function, to remove duplicate code, used in wxScrollBar
 183     WXWidget DoCreateScrollBar(WXWidget parent, wxOrientation orientation,
 184                                void (*callback)());
 185 public:
 186     WXPixmap GetBackingPixmap() const { return m_backingPixmap; }
 187     void SetBackingPixmap(WXPixmap pixmap) { m_backingPixmap = pixmap; }
 188     int GetPixmapWidth() const { return m_pixmapWidth; }
 189     int GetPixmapHeight() const { return m_pixmapHeight; }
 190     void SetPixmapWidth(int w) { m_pixmapWidth = w; }
 191     void SetPixmapHeight(int h) { m_pixmapHeight = h; }
 192
 193     // Change properties
 194     // Change to the current font (often overridden)
 195     virtual void ChangeFont(bool keepOriginalSize = true);
 196
 197     // Change background and foreground colour using current background colour
 198     // setting (Motif generates foreground based on background)
 199     virtual void ChangeBackgroundColour();
 200     // Change foreground colour using current foreground colour setting
 201     virtual void ChangeForegroundColour();
 202
 203 protected:
 204     // Adds the widget to the hash table and adds event handlers.
 205     bool AttachWidget(wxWindow* parent, WXWidget mainWidget,
 206         WXWidget formWidget, int x, int y, int width, int height);
 207     bool DetachWidget(WXWidget widget);
 208
 209     // How to implement accelerators. If we find a key event, translate to
 210     // wxWidgets wxKeyEvent form. Find a widget for the window. Now find a
 211     // wxWindow for the widget. If there isn't one, go up the widget hierarchy
 212     // trying to find one. Once one is found, call ProcessAccelerator for the
 213     // window. If it returns true (processed the event), skip the X event,
 214     // otherwise carry on up the wxWidgets window hierarchy calling
 215     // ProcessAccelerator. If all return false, process the X event as normal.
 216     // Eventually we can implement OnCharHook the same way, but concentrate on
 217     // accelerators for now. ProcessAccelerator must look at the current
 218     // accelerator table, and try to find what menu id or window (beneath it)
 219     // has this ID. Then construct an appropriate command
 220     // event and send it.
 221 public:
 222     virtual bool ProcessAccelerator(wxKeyEvent& event);
 223
 224 protected:
 225     // unmanage and destroy an X widget f it's !NULL (passing NULL is ok)
 226     void UnmanageAndDestroy(WXWidget widget);
 227
 228     // map or unmap an X widget (passing NULL is ok),
 229     // returns true if widget was mapped/unmapped
 230     bool MapOrUnmap(WXWidget widget, bool map);
 231
 232     // scrolling stuff
 233     // ---------------
 234
 235     // create/destroy window scrollbars
 236     void CreateScrollbar(wxOrientation orientation);
 237     void DestroyScrollbar(wxOrientation orientation);
 238
 239     // get either hor or vert scrollbar widget
 240     WXWidget GetScrollbar(wxOrientation orient) const
 241     { return orient == wxHORIZONTAL ? m_hScrollBar : m_vScrollBar; }
 242
 243     // set the scroll pos
 244     void SetInternalScrollPos(wxOrientation orient, int pos)
 245     {
 246         if ( orient == wxHORIZONTAL )
 247             m_scrollPosX = pos;
 248         else
 249             m_scrollPosY = pos;
 250     }
 251
 252     // Motif-specific flags
 253     // --------------------
 254
 255     bool m_needsRefresh:1;          // repaint backing store?
 256
 257     // For double-click detection
 258     long                  m_lastTS;           // last timestamp
 259     unsigned              m_lastButton:2;     // last pressed button
 260
 261 protected:
 262     WXWidget              m_mainWidget;
 263     WXWidget              m_hScrollBar;
 264     WXWidget              m_vScrollBar;
 265     WXWidget              m_borderWidget;
 266     WXWidget              m_scrolledWindow;
 267     WXWidget              m_drawingArea;
 268     bool                  m_winCaptured:1;
 269     WXPixmap              m_backingPixmap;
 270     int                   m_pixmapWidth;
 271     int                   m_pixmapHeight;
 272     int                   m_pixmapOffsetX;
 273     int                   m_pixmapOffsetY;
 274
 275     // Store the last scroll pos, since in wxWin the pos isn't set
 276     // automatically by system
 277     int                   m_scrollPosX;
 278     int                   m_scrollPosY;
 279
 280     // implement the base class pure virtuals
 281     virtual void DoClientToScreen( int *x, int *y ) const;
 282     virtual void DoScreenToClient( int *x, int *y ) const;
 283     virtual void DoGetPosition( int *x, int *y ) const;
 284     virtual void DoGetSize( int *width, int *height ) const;
 285     virtual void DoGetClientSize( int *width, int *height ) const;
 286     virtual void DoSetSize(int x, int y,
 287         int width, int height,
 288         int sizeFlags = wxSIZE_AUTO);
 289     virtual void DoSetClientSize(int width, int height);
 290     virtual void DoMoveWindow(int x, int y, int width, int height);
 291     virtual bool DoPopupMenu(wxMenu *menu, int x, int y);
 292     virtual void DoCaptureMouse();
 293     virtual void DoReleaseMouse();
 294
 295 #if wxUSE_TOOLTIPS
 296     virtual void DoSetToolTip( wxToolTip *tip );
 297 #endif // wxUSE_TOOLTIPS
 298
 299 private:
 300     // common part of all ctors
 301     void Init();
 302
 303     DECLARE_DYNAMIC_CLASS(wxWindow)
 304     DECLARE_NO_COPY_CLASS(wxWindow)
 305     DECLARE_EVENT_TABLE()
 306 };
 307
 308 // ----------------------------------------------------------------------------
 309 // A little class to switch off `size optimization' while an instance of the
 310 // object exists: this may be useful to temporarily disable the optimisation
 311 // which consists to do nothing when the new size is equal to the old size -
 312 // although quite useful usually to avoid flicker, sometimes it leads to
 313 // undesired effects.
 314 //
 315 // Usage: create an instance of this class on the stack to disable the size
 316 // optimisation, it will be reenabled as soon as the object goes out
 317 // from scope.
 318 // ----------------------------------------------------------------------------
 319
 320 class WXDLLEXPORT wxNoOptimize
 321 {
 322 public:
 323     wxNoOptimize() { ms_count++; }
 324     ~wxNoOptimize() { ms_count--; }
 325
 326     static bool CanOptimize() { return ms_count == 0; }
 327
 328 protected:
 329     static int ms_count;
 330 };
 331
 332 #endif
 333 // _WX_WINDOW_H_