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 // ----------------------------------------------------------------------------
  20 // A list of rectangles type used by wxWindow
  21 // ----------------------------------------------------------------------------
  22
  23 WX_DECLARE_LIST(wxRect, wxRectList);
  24
  25 // ----------------------------------------------------------------------------
  26 // wxWindow class for Motif - see also wxWindowBase
  27 // ----------------------------------------------------------------------------
  28
  29 class wxWindow : public wxWindowBase
  30 {
  31 DECLARE_DYNAMIC_CLASS(wxWindow)
  32
  33 friend class WXDLLEXPORT wxDC;
  34 friend class WXDLLEXPORT wxWindowDC;
  35
  36 public:
  37     wxWindow() { Init(); }
  38
  39     wxWindow(wxWindow *parent,
  40              wxWindowID id,
  41              const wxPoint& pos = wxDefaultPosition,
  42              const wxSize& size = wxDefaultSize,
  43              long style = 0,
  44              const wxString& name = wxPanelNameStr)
  45     {
  46         Init();
  47         Create(parent, id, pos, size, style, name);
  48     }
  49
  50     virtual ~wxWindow();
  51
  52     bool Create(wxWindow *parent,
  53                 wxWindowID id,
  54                 const wxPoint& pos = wxDefaultPosition,
  55                 const wxSize& size = wxDefaultSize,
  56                 long style = 0,
  57                 const wxString& name = wxPanelNameStr);
  58
  59     // implement base class pure virtuals
  60     virtual void SetTitle( const wxString& title);
  61     virtual wxString GetTitle() const;
  62
  63     virtual void Raise();
  64     virtual void Lower();
  65
  66     virtual bool Show( bool show = TRUE );
  67     virtual bool Enable( bool enable = TRUE );
  68
  69     virtual void SetFocus();
  70
  71     virtual void WarpPointer(int x, int y);
  72     virtual void CaptureMouse();
  73     virtual void ReleaseMouse();
  74
  75     virtual void Refresh( bool eraseBackground = TRUE,
  76                           const wxRect *rect = (const wxRect *) NULL );
  77     virtual void Clear();
  78
  79     virtual bool SetBackgroundColour( const wxColour &colour );
  80     virtual bool SetForegroundColour( const wxColour &colour );
  81
  82     virtual bool SetCursor( const wxCursor &cursor );
  83     virtual bool SetFont( const wxFont &font );
  84
  85     virtual int GetCharHeight() const;
  86     virtual int GetCharWidth() const;
  87     virtual void GetTextExtent(const wxString& string,
  88                                int *x, int *y,
  89                                int *descent = (int *) NULL,
  90                                int *externalLeading = (int *) NULL,
  91                                const wxFont *theFont = (const wxFont *) NULL)
  92                                const;
  93
  94     virtual void SetScrollbar( int orient, int pos, int thumbVisible,
  95                                int range, bool refresh = TRUE );
  96     virtual void SetScrollPos( int orient, int pos, bool refresh = TRUE );
  97     virtual int GetScrollPos( int orient ) const;
  98     virtual int GetScrollThumb( int orient ) const;
  99     virtual int GetScrollRange( int orient ) const;
 100     virtual void ScrollWindow( int dx, int dy,
 101                                const wxRect* rect = (wxRect *) NULL );
 102
 103     virtual void SetSizeHints(int minW, int minH,
 104                               int maxW = -1, int maxH = -1,
 105                               int incW = -1, int incH = -1);
 106 #if wxUSE_DRAG_AND_DROP
 107     virtual void SetDropTarget( wxDropTarget *dropTarget );
 108 #endif // wxUSE_DRAG_AND_DROP
 109
 110     // Accept files for dragging
 111     virtual void DragAcceptFiles(bool accept);
 112
 113     // Get the unique identifier of a window
 114     virtual WXWidget GetHandle() const { return GetMainWidget(); }
 115
 116     // implementation from now on
 117     // --------------------------
 118
 119     // accessors
 120     // ---------
 121
 122     // Get main widget for this window, e.g. a text widget
 123     virtual WXWidget GetMainWidget() const;
 124     // Get the widget that corresponds to the label (for font setting, label setting etc.)
 125     virtual WXWidget GetLabelWidget() const;
 126     // Get the client widget for this window (something we can create other
 127     // windows on)
 128     virtual WXWidget GetClientWidget() const;
 129     // Get the top widget for this window, e.g. the scrolled widget parent of a
 130     // multi-line text widget. Top means, top in the window hierarchy that
 131     // implements this window.
 132     virtual WXWidget GetTopWidget() const;
 133
 134     // Get the underlying X window and display
 135     WXWindow GetXWindow() const;
 136     WXDisplay *GetXDisplay() const;
 137
 138     // called from Motif callbacks - and should only be called from there
 139
 140     void SetButton1(bool pressed) { m_button1Pressed = pressed; }
 141     void SetButton2(bool pressed) { m_button2Pressed = pressed; }
 142     void SetButton3(bool pressed) { m_button3Pressed = pressed; }
 143
 144     void SetLastClick(int button, long timestamp)
 145         { m_lastButton = button; m_lastTS = timestamp; }
 146
 147     int GetLastClickedButton() const { return m_lastButton; }
 148     long GetLastClickTime() const { return m_lastTS; }
 149
 150     // Gives window a chance to do something in response to a size message, e.g.
 151     // arrange status bar, toolbar etc.
 152     virtual bool PreResize();
 153
 154     // Generates a paint event
 155     virtual void DoPaint();
 156
 157     // update rectangle/region manipulation
 158     // (for wxWindowDC and Motif callbacks only)
 159     // -----------------------------------------
 160
 161     // read/write access to the update rect list
 162     const wxRectList& GetUpdateRects() const { return m_updateRects; }
 163
 164     // Adds a recangle to the updates list
 165     void AddUpdateRect(int x, int y, int w, int h)
 166         { m_updateRects.Append(new wxRect(x, y, w, h)); }
 167
 168     // Empties the m_updateRects list
 169     void ClearUpdateRects();
 170
 171     void ClearUpdateRegion() { m_updateRegion.Clear(); }
 172     void SetUpdateRegion(const wxRegion& region) { m_updateRegion = region; }
 173
 174     // sets the fore/background colour for the given widget
 175     static void DoChangeForegroundColour(WXWidget widget, wxColour& foregroundColour);
 176     static void DoChangeBackgroundColour(WXWidget widget, wxColour& backgroundColour, bool changeArmColour = FALSE);
 177
 178 protected:
 179     // event handlers (not virtual by design)
 180     void OnIdle(wxIdleEvent& event);
 181
 182     // For implementation purposes - sometimes decorations make the client area
 183     // smaller
 184     virtual wxPoint GetClientAreaOrigin() const;
 185
 186     // Makes an adjustment to the window position (for example, a frame that has
 187     // a toolbar that it manages itself).
 188     virtual void AdjustForParentClientOrigin(int& x, int& y, int sizeFlags);
 189
 190     wxWindow *GetChild(int number) const
 191         { return GetChildren().Item(number)->GetData(); }
 192
 193     // Responds to colour changes: passes event on to children.
 194     void OnSysColourChanged(wxSysColourChangedEvent& event);
 195
 196     // Motif-specific
 197
 198         // CanvasXXXSiize functions
 199     void CanvasGetSize(int* width, int* height) const; // If have drawing area
 200     void CanvasGetClientSize(int *width, int *height) const;
 201     void CanvasGetPosition(int *x, int *y) const; // If have drawing area
 202     void CanvasSetClientSize(int width, int size);
 203     void CanvasSetSize(int x, int y, int width, int height, int sizeFlags = wxSIZE_AUTO);
 204
 205     void SetMainWidget(WXWidget w) { m_mainWidget = w; }
 206
 207     bool CanAddEventHandler() const { return m_canAddEventHandler; }
 208     void SetCanAddEventHandler(bool flag) { m_canAddEventHandler = flag; }
 209
 210     WXPixmap GetBackingPixmap() const { return m_backingPixmap; }
 211     int GetPixmapWidth() const { return m_pixmapWidth; }
 212     int GetPixmapHeight() const { return m_pixmapHeight; }
 213
 214 public:
 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 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_