include/wx/x11/window.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/x11/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 wxWindowX11 : public wxWindowBase
  22 {
  23     friend class WXDLLIMPEXP_FWD_CORE wxDC;
  24     friend class WXDLLIMPEXP_FWD_CORE wxWindowDC;
  25
  26 public:
  27     wxWindowX11() { Init(); }
  28
  29     wxWindowX11(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 ~wxWindowX11();
  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     virtual void Raise();
  50     virtual void Lower();
  51
  52     virtual void SetLabel(const wxString& label);
  53     virtual wxString GetLabel() const;
  54
  55     virtual bool Show( bool show = true );
  56     virtual bool Enable( bool enable = true );
  57
  58     virtual void SetFocus();
  59
  60     virtual void WarpPointer(int x, int y);
  61
  62     virtual void Refresh( bool eraseBackground = true,
  63                           const wxRect *rect = (const wxRect *) NULL );
  64     virtual void Update();
  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
  75     virtual void ScrollWindow( int dx, int dy, const wxRect* rect = NULL );
  76
  77 #if wxUSE_DRAG_AND_DROP
  78     virtual void SetDropTarget( wxDropTarget *dropTarget );
  79 #endif // wxUSE_DRAG_AND_DROP
  80
  81     // Accept files for dragging
  82     virtual void DragAcceptFiles(bool accept);
  83
  84     // Get the unique identifier of a window
  85     virtual WXWindow GetHandle() const { return GetMainWindow(); }
  86
  87     // implementation from now on
  88     // --------------------------
  89
  90     // accessors
  91     // ---------
  92
  93     // Get main X11 window
  94     virtual WXWindow GetMainWindow() const;
  95
  96     // Get X11 window representing the client area
  97     virtual WXWindow GetClientAreaWindow() const;
  98
  99     void SetLastClick(int button, long timestamp)
 100         { m_lastButton = button; m_lastTS = timestamp; }
 101
 102     int GetLastClickedButton() const { return m_lastButton; }
 103     long GetLastClickTime() const { return m_lastTS; }
 104
 105     // Gives window a chance to do something in response to a size message, e.g.
 106     // arrange status bar, toolbar etc.
 107     virtual bool PreResize();
 108
 109     // Generates paint events from m_updateRegion
 110     void SendPaintEvents();
 111
 112     // Generates paint events from flag
 113     void SendNcPaintEvents();
 114
 115     // Generates erase events from m_clearRegion
 116     void SendEraseEvents();
 117
 118     // Clip to paint region?
 119     bool GetClipPaintRegion() { return m_clipPaintRegion; }
 120
 121     // Return clear region
 122     wxRegion &GetClearRegion() { return m_clearRegion; }
 123
 124     void NeedUpdateNcAreaInIdle( bool update = true ) { m_updateNcArea = update; }
 125
 126     // Inserting into main window instead of client
 127     // window. This is mostly for a wxWindow's own
 128     // scrollbars.
 129     void SetInsertIntoMain( bool insert = true ) { m_insertIntoMain = insert; }
 130     bool GetInsertIntoMain() { return m_insertIntoMain; }
 131
 132     // sets the fore/background colour for the given widget
 133     static void DoChangeForegroundColour(WXWindow widget, wxColour& foregroundColour);
 134     static void DoChangeBackgroundColour(WXWindow widget, wxColour& backgroundColour, bool changeArmColour = false);
 135
 136     // I don't want users to override what's done in idle so everything that
 137     // has to be done in idle time in order for wxX11 to work is done in
 138     // OnInternalIdle
 139     virtual void OnInternalIdle();
 140
 141 protected:
 142     // Responds to colour changes: passes event on to children.
 143     void OnSysColourChanged(wxSysColourChangedEvent& event);
 144
 145     // For double-click detection
 146     long   m_lastTS;         // last timestamp
 147     int    m_lastButton;     // last pressed button
 148
 149 protected:
 150     WXWindow              m_mainWindow;
 151     WXWindow              m_clientWindow;
 152     bool                  m_insertIntoMain;
 153
 154     bool                  m_winCaptured;
 155     wxRegion              m_clearRegion;
 156     bool                  m_clipPaintRegion;
 157     bool                  m_updateNcArea;
 158     bool                  m_needsInputFocus; // Input focus set in OnIdle
 159
 160     // implement the base class pure virtuals
 161     virtual void DoGetTextExtent(const wxString& string,
 162                                  int *x, int *y,
 163                                  int *descent = NULL,
 164                                  int *externalLeading = NULL,
 165                                  const wxFont *font = NULL) const;
 166     virtual void DoClientToScreen( int *x, int *y ) const;
 167     virtual void DoScreenToClient( int *x, int *y ) const;
 168     virtual void DoGetPosition( int *x, int *y ) const;
 169     virtual void DoGetSize( int *width, int *height ) const;
 170     virtual void DoGetClientSize( int *width, int *height ) const;
 171     virtual void DoSetSize(int x, int y,
 172         int width, int height,
 173         int sizeFlags = wxSIZE_AUTO);
 174     virtual void DoSetClientSize(int width, int height);
 175     virtual void DoMoveWindow(int x, int y, int width, int height);
 176     virtual void DoSetSizeHints(int minW, int minH,
 177         int maxW, int maxH,
 178         int incW, int incH);
 179     virtual void DoCaptureMouse();
 180     virtual void DoReleaseMouse();
 181
 182 #if wxUSE_TOOLTIPS
 183     virtual void DoSetToolTip( wxToolTip *tip );
 184 #endif // wxUSE_TOOLTIPS
 185
 186 private:
 187     // common part of all ctors
 188     void Init();
 189
 190     DECLARE_DYNAMIC_CLASS(wxWindowX11)
 191     wxDECLARE_NO_COPY_CLASS(wxWindowX11);
 192     DECLARE_EVENT_TABLE()
 193 };
 194
 195 // ----------------------------------------------------------------------------
 196 // A little class to switch off `size optimization' while an instance of the
 197 // object exists: this may be useful to temporarily disable the optimisation
 198 // which consists to do nothing when the new size is equal to the old size -
 199 // although quite useful usually to avoid flicker, sometimes it leads to
 200 // undesired effects.
 201 //
 202 // Usage: create an instance of this class on the stack to disable the size
 203 // optimisation, it will be reenabled as soon as the object goes out from scope.
 204 // ----------------------------------------------------------------------------
 205
 206 class WXDLLIMPEXP_CORE wxNoOptimize
 207 {
 208 public:
 209     wxNoOptimize() { ms_count++; }
 210     ~wxNoOptimize() { ms_count--; }
 211
 212     static bool CanOptimize() { return ms_count == 0; }
 213
 214 protected:
 215     static int ms_count;
 216 };
 217
 218 #endif // _WX_WINDOW_H_