include/wx/gtk/window.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/gtk/window.h
   3 // Purpose:
   4 // Author:      Robert Roebling
   5 // Id:          $Id$
   6 // Copyright:   (c) 1998 Robert Roebling
   7 // Licence:     wxWindows licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10 #ifndef _WX_GTK_WINDOW_H_
  11 #define _WX_GTK_WINDOW_H_
  12
  13 #include "wx/dynarray.h"
  14
  15 // helper structure that holds class that holds GtkIMContext object and
  16 // some additional data needed for key events processing
  17 struct wxGtkIMData;
  18
  19 WX_DEFINE_EXPORTED_ARRAY_PTR(GdkWindow *, wxArrayGdkWindows);
  20
  21 //-----------------------------------------------------------------------------
  22 // wxWindowGTK
  23 //-----------------------------------------------------------------------------
  24
  25 class WXDLLIMPEXP_CORE wxWindowGTK : public wxWindowBase
  26 {
  27 public:
  28     // creating the window
  29     // -------------------
  30     wxWindowGTK();
  31     wxWindowGTK(wxWindow *parent,
  32                 wxWindowID id,
  33                 const wxPoint& pos = wxDefaultPosition,
  34                 const wxSize& size = wxDefaultSize,
  35                 long style = 0,
  36                 const wxString& name = wxPanelNameStr);
  37     bool Create(wxWindow *parent,
  38                 wxWindowID id,
  39                 const wxPoint& pos = wxDefaultPosition,
  40                 const wxSize& size = wxDefaultSize,
  41                 long style = 0,
  42                 const wxString& name = wxPanelNameStr);
  43     virtual ~wxWindowGTK();
  44
  45     // implement base class (pure) virtual methods
  46     // -------------------------------------------
  47
  48     virtual void SetLabel(const wxString& WXUNUSED(label)) { }
  49     virtual wxString GetLabel() const { return wxEmptyString; }
  50
  51     virtual bool Destroy();
  52
  53     virtual void Raise();
  54     virtual void Lower();
  55
  56     virtual bool Show( bool show = true );
  57
  58     virtual void SetWindowStyleFlag( long style );
  59
  60     virtual bool IsRetained() const;
  61
  62     virtual void SetFocus();
  63
  64     // hint from wx to native GTK+ tab traversal code
  65     virtual void SetCanFocus(bool canFocus);
  66
  67     virtual bool Reparent( wxWindowBase *newParent );
  68
  69     virtual void WarpPointer(int x, int y);
  70
  71     virtual void Refresh( bool eraseBackground = true,
  72                           const wxRect *rect = (const wxRect *) NULL );
  73     virtual void Update();
  74     virtual void ClearBackground();
  75
  76     virtual bool SetBackgroundColour( const wxColour &colour );
  77     virtual bool SetForegroundColour( const wxColour &colour );
  78     virtual bool SetCursor( const wxCursor &cursor );
  79     virtual bool SetFont( const wxFont &font );
  80
  81     virtual bool SetBackgroundStyle(wxBackgroundStyle style) ;
  82
  83     virtual int GetCharHeight() const;
  84     virtual int GetCharWidth() const;
  85     virtual void GetTextExtent(const wxString& string,
  86                                int *x, int *y,
  87                                int *descent = (int *) NULL,
  88                                int *externalLeading = (int *) NULL,
  89                                const wxFont *theFont = (const wxFont *) NULL)
  90                                const;
  91
  92     virtual void SetScrollbar( int orient, int pos, int thumbVisible,
  93                                int range, bool refresh = true );
  94     virtual void SetScrollPos( int orient, int pos, bool refresh = true );
  95     virtual int GetScrollPos( int orient ) const;
  96     virtual int GetScrollThumb( int orient ) const;
  97     virtual int GetScrollRange( int orient ) const;
  98     virtual void ScrollWindow( int dx, int dy,
  99                                const wxRect* rect = (wxRect *) NULL );
 100     virtual bool ScrollLines(int lines);
 101     virtual bool ScrollPages(int pages);
 102
 103 #if wxUSE_DRAG_AND_DROP
 104     virtual void SetDropTarget( wxDropTarget *dropTarget );
 105 #endif // wxUSE_DRAG_AND_DROP
 106
 107     virtual void AddChild( wxWindowBase *child );
 108     virtual void RemoveChild( wxWindowBase *child );
 109
 110     virtual void SetLayoutDirection(wxLayoutDirection dir);
 111     virtual wxLayoutDirection GetLayoutDirection() const;
 112     virtual wxCoord AdjustForLayoutDirection(wxCoord x,
 113                                              wxCoord width,
 114                                              wxCoord widthTotal) const;
 115
 116     virtual bool DoIsExposed( int x, int y ) const;
 117     virtual bool DoIsExposed( int x, int y, int w, int h ) const;
 118
 119     // currently wxGTK2-only
 120     void SetDoubleBuffered(bool on);
 121     virtual bool IsDoubleBuffered() const;
 122
 123     // implementation
 124     // --------------
 125
 126     virtual WXWidget GetHandle() const { return m_widget; }
 127
 128     // many important things are done here, this function must be called
 129     // regularly
 130     virtual void OnInternalIdle();
 131
 132     // Internal represention of Update()
 133     void GtkUpdate();
 134
 135     // For compatibility across platforms (not in event table)
 136     void OnIdle(wxIdleEvent& WXUNUSED(event)) {}
 137
 138     // Used by all window classes in the widget creation process.
 139     bool PreCreation( wxWindowGTK *parent, const wxPoint &pos, const wxSize &size );
 140     void PostCreation();
 141
 142     // Internal addition of child windows. differs from class
 143     // to class not by using virtual functions but by using
 144     // the m_insertCallback.
 145     void DoAddChild(wxWindowGTK *child);
 146
 147     // This methods sends wxPaintEvents to the window. It reads the
 148     // update region, breaks it up into rects and sends an event
 149     // for each rect. It is also responsible for background erase
 150     // events and NC paint events. It is called from "draw" and
 151     // "expose" handlers as well as from ::Update()
 152     void GtkSendPaintEvents();
 153
 154     // The methods below are required because many native widgets
 155     // are composed of several subwidgets and setting a style for
 156     // the widget means setting it for all subwidgets as well.
 157     // also, it is not clear which native widget is the top
 158     // widget where (most of) the input goes. even tooltips have
 159     // to be applied to all subwidgets.
 160     virtual GtkWidget* GetConnectWidget();
 161     void ConnectWidget( GtkWidget *widget );
 162
 163     // Called from several event handlers, if it returns true or false, the
 164     // same value should be immediately returned by the handler without doing
 165     // anything else. If it returns -1, the handler should continue as usual
 166     int GTKCallbackCommonPrologue(struct _GdkEventAny *event) const;
 167
 168     // override this if some events should never be consumed by wxWidgets but
 169     // but have to be left for the native control
 170     //
 171     // base version just does GetEventHandler()->ProcessEvent()
 172     virtual bool GTKProcessEvent(wxEvent& event) const;
 173
 174     // Map GTK widget direction of the given widget to/from wxLayoutDirection
 175     static wxLayoutDirection GTKGetLayout(GtkWidget *widget);
 176     static void GTKSetLayout(GtkWidget *widget, wxLayoutDirection dir);
 177
 178     // return true if this window must have a non-NULL parent, false if it can
 179     // be created without parent (normally only top level windows but in wxGTK
 180     // there is also the exception of wxMenuBar)
 181     virtual bool GTKNeedsParent() const { return !IsTopLevel(); }
 182
 183     // This is called when capture is taken from the window. It will
 184     // fire off capture lost events.
 185     void GTKReleaseMouseAndNotify();
 186
 187     GdkWindow* GTKGetDrawingWindow() const;
 188
 189     bool GTKHandleFocusIn();
 190     bool GTKHandleFocusOut();
 191     void GTKHandleFocusOutNoDeferring();
 192     static void GTKHandleDeferredFocusOut();
 193
 194 protected:
 195     // for controls composed of multiple GTK widgets, return true to eliminate
 196     // spurious focus events if the focus changes between GTK+ children within
 197     // the same wxWindow
 198     virtual bool GTKNeedsToFilterSameWindowFocus() const { return false; }
 199
 200     // Override GTKWidgetNeedsMnemonic and return true if your
 201     // needs to set its mnemonic widget, such as for a
 202     // GtkLabel for wxStaticText, then do the actual
 203     // setting of the widget inside GTKWidgetDoSetMnemonic
 204     virtual bool GTKWidgetNeedsMnemonic() const;
 205     virtual void GTKWidgetDoSetMnemonic(GtkWidget* w);
 206
 207     // Get the GdkWindows making part of this window: usually there will be
 208     // only one of them in which case it should be returned directly by this
 209     // function. If there is more than one GdkWindow (can be the case for
 210     // composite widgets), return NULL and fill in the provided array
 211     //
 212     // This is not pure virtual for backwards compatibility but almost
 213     // certainly must be overridden in any wxControl-derived class!
 214     virtual GdkWindow *GTKGetWindow(wxArrayGdkWindows& windows) const;
 215
 216     // Check if the given window makes part of this widget
 217     bool GTKIsOwnWindow(GdkWindow *window) const;
 218
 219 public:
 220     // Returns the default context which usually is anti-aliased
 221     PangoContext   *GtkGetPangoDefaultContext();
 222
 223 #if wxUSE_TOOLTIPS
 224     // applies tooltip to the widget (tip must be UTF-8 encoded)
 225     virtual void ApplyToolTip( GtkTooltips *tips, const gchar *tip );
 226 #endif // wxUSE_TOOLTIPS
 227
 228     // Called when a window should delay showing itself
 229     // until idle time. This partly mimmicks defered
 230     // sizing under MSW.
 231     void GtkShowOnIdle() { m_showOnIdle = true; }
 232
 233     // This is called from the various OnInternalIdle methods
 234     bool GtkShowFromOnIdle();
 235
 236     // fix up the mouse event coords, used by wxListBox only so far
 237     virtual void FixUpMouseEvent(GtkWidget * WXUNUSED(widget),
 238                                  wxCoord& WXUNUSED(x),
 239                                  wxCoord& WXUNUSED(y)) { }
 240
 241     // is this window transparent for the mouse events (as wxStaticBox is)?
 242     virtual bool IsTransparentForMouse() const { return false; }
 243
 244     // Common scroll event handling code for wxWindow and wxScrollBar
 245     wxEventType GetScrollEventType(GtkRange* range);
 246
 247     // position and size of the window
 248     int                  m_x, m_y;
 249     int                  m_width, m_height;
 250     int                  m_oldClientWidth,m_oldClientHeight;
 251
 252     // see the docs in src/gtk/window.cpp
 253     GtkWidget           *m_widget;          // mostly the widget seen by the rest of GTK
 254     GtkWidget           *m_wxwindow;        // mostly the client area as per wxWidgets
 255
 256     // return true if the window is of a standard (i.e. not wxWidgets') class
 257     bool IsOfStandardClass() const { return m_wxwindow == NULL; }
 258
 259     // this widget will be queried for GTK's focus events
 260     GtkWidget           *m_focusWidget;
 261
 262     wxGtkIMData         *m_imData;
 263
 264
 265     // indices for the arrays below
 266     enum ScrollDir { ScrollDir_Horz, ScrollDir_Vert, ScrollDir_Max };
 267
 268     // horizontal/vertical scroll bar
 269     GtkRange* m_scrollBar[ScrollDir_Max];
 270
 271     // horizontal/vertical scroll position
 272     double m_scrollPos[ScrollDir_Max];
 273
 274     // return the scroll direction index corresponding to the given orientation
 275     // (which is wxVERTICAL or wxHORIZONTAL)
 276     static ScrollDir ScrollDirFromOrient(int orient)
 277     {
 278         return orient == wxVERTICAL ? ScrollDir_Vert : ScrollDir_Horz;
 279     }
 280
 281     // return the orientation for the given scrolling direction
 282     static int OrientFromScrollDir(ScrollDir dir)
 283     {
 284         return dir == ScrollDir_Horz ? wxHORIZONTAL : wxVERTICAL;
 285     }
 286
 287     // find the direction of the given scrollbar (must be one of ours)
 288     ScrollDir ScrollDirFromRange(GtkRange *range) const;
 289
 290     // extra (wxGTK-specific) flags
 291     bool                 m_noExpose:1;          // wxGLCanvas has its own redrawing
 292     bool                 m_nativeSizeEvent:1;   // wxGLCanvas sends wxSizeEvent upon "alloc_size"
 293     bool                 m_hasVMT:1;
 294     bool                 m_isScrolling:1;       // dragging scrollbar thumb?
 295     bool                 m_clipPaintRegion:1;   // true after ScrollWindow()
 296     wxRegion             m_nativeUpdateRegion;  // not transformed for RTL
 297     bool                 m_dirtyTabOrder:1;     // tab order changed, GTK focus
 298                                                 // chain needs update
 299     bool                 m_needsStyleChange:1;  // May not be able to change
 300                                                 // background style until OnIdle
 301     bool                 m_mouseButtonDown:1;
 302
 303     bool                 m_showOnIdle:1;        // postpone showing the window until idle
 304
 305 protected:
 306     // C++ has no virtual methods in the constrcutor of any class but we need
 307     // different methods of inserting a child window into a wxFrame,
 308     // wxMDIFrame, wxNotebook etc. this is the callback that will get used.
 309     typedef void (*InsertChildFunction)(wxWindowGTK*, wxWindowGTK*);
 310     InsertChildFunction m_insertCallback;
 311
 312     // implement the base class pure virtuals
 313     virtual void DoClientToScreen( int *x, int *y ) const;
 314     virtual void DoScreenToClient( int *x, int *y ) const;
 315     virtual void DoGetPosition( int *x, int *y ) const;
 316     virtual void DoGetSize( int *width, int *height ) const;
 317     virtual void DoGetClientSize( int *width, int *height ) const;
 318     virtual void DoSetSize(int x, int y,
 319                            int width, int height,
 320                            int sizeFlags = wxSIZE_AUTO);
 321     virtual void DoSetClientSize(int width, int height);
 322     virtual void DoMoveWindow(int x, int y, int width, int height);
 323     virtual void DoEnable(bool enable);
 324
 325 #if wxUSE_MENUS_NATIVE
 326     virtual bool DoPopupMenu( wxMenu *menu, int x, int y );
 327     virtual void DoPopupMenuUpdateUI(wxMenu* menu);
 328 #endif // wxUSE_MENUS_NATIVE
 329
 330     virtual void DoCaptureMouse();
 331     virtual void DoReleaseMouse();
 332
 333     virtual void DoFreeze();
 334     virtual void DoThaw();
 335
 336     static void GTKFreezeWidget(GtkWidget *w);
 337     static void GTKThawWidget(GtkWidget *w);
 338
 339 #if wxUSE_TOOLTIPS
 340     virtual void DoSetToolTip( wxToolTip *tip );
 341 #endif // wxUSE_TOOLTIPS
 342
 343     // common part of all ctors (not virtual because called from ctor)
 344     void Init();
 345
 346     virtual void DoMoveInTabOrder(wxWindow *win, WindowOrder move);
 347     virtual bool DoNavigateIn(int flags);
 348
 349
 350     // Copies m_children tab order to GTK focus chain:
 351     void RealizeTabOrder();
 352
 353     // Called by ApplyWidgetStyle (which is called by SetFont() and
 354     // SetXXXColour etc to apply style changed to native widgets) to create
 355     // modified GTK style with non-standard attributes. If forceStyle=true,
 356     // creates empty GtkRcStyle if there are no modifications, otherwise
 357     // returns NULL in such case.
 358     GtkRcStyle *CreateWidgetStyle(bool forceStyle = false);
 359
 360     // Overridden in many GTK widgets who have to handle subwidgets
 361     virtual void ApplyWidgetStyle(bool forceStyle = false);
 362
 363     // helper function to ease native widgets wrapping, called by
 364     // ApplyWidgetStyle -- override this, not ApplyWidgetStyle
 365     virtual void DoApplyWidgetStyle(GtkRcStyle *style);
 366
 367     // sets the border of a given GtkScrolledWindow from a wx style
 368     static void GtkScrolledWindowSetBorder(GtkWidget* w, int style);
 369
 370     // set the current cursor for all GdkWindows making part of this widget
 371     // (see GTKGetWindow)
 372     //
 373     // should be called from OnInternalIdle() if it's overridden
 374     void GTKUpdateCursor();
 375
 376     void ConstrainSize();
 377
 378 private:
 379     enum ScrollUnit { ScrollUnit_Line, ScrollUnit_Page, ScrollUnit_Max };
 380
 381     // common part of ScrollLines() and ScrollPages() and could be used, in the
 382     // future, for horizontal scrolling as well
 383     //
 384     // return true if we scrolled, false otherwise (on error or simply if we
 385     // are already at the end)
 386     bool DoScrollByUnits(ScrollDir dir, ScrollUnit unit, int units);
 387
 388
 389     DECLARE_DYNAMIC_CLASS(wxWindowGTK)
 390     DECLARE_NO_COPY_CLASS(wxWindowGTK)
 391 };
 392
 393 #endif // _WX_GTK_WINDOW_H_