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 #ifdef __WXGTK3__
  16     typedef struct _cairo cairo_t;
  17     typedef struct _GtkStyleProvider GtkStyleProvider;
  18     #define WXUNUSED_IN_GTK3(x)
  19 #else
  20     #define WXUNUSED_IN_GTK3(x) x
  21 #endif
  22
  23 typedef struct _GdkEventKey GdkEventKey;
  24 typedef struct _GtkIMContext GtkIMContext;
  25
  26 WX_DEFINE_EXPORTED_ARRAY_PTR(GdkWindow *, wxArrayGdkWindows);
  27
  28 extern "C"
  29 {
  30
  31 typedef void (*wxGTKCallback)();
  32
  33 }
  34
  35 //-----------------------------------------------------------------------------
  36 // wxWindowGTK
  37 //-----------------------------------------------------------------------------
  38
  39 class WXDLLIMPEXP_CORE wxWindowGTK : public wxWindowBase
  40 {
  41 public:
  42     // creating the window
  43     // -------------------
  44     wxWindowGTK();
  45     wxWindowGTK(wxWindow *parent,
  46                 wxWindowID id,
  47                 const wxPoint& pos = wxDefaultPosition,
  48                 const wxSize& size = wxDefaultSize,
  49                 long style = 0,
  50                 const wxString& name = wxPanelNameStr);
  51     bool Create(wxWindow *parent,
  52                 wxWindowID id,
  53                 const wxPoint& pos = wxDefaultPosition,
  54                 const wxSize& size = wxDefaultSize,
  55                 long style = 0,
  56                 const wxString& name = wxPanelNameStr);
  57     virtual ~wxWindowGTK();
  58
  59     // implement base class (pure) virtual methods
  60     // -------------------------------------------
  61
  62     virtual void Raise();
  63     virtual void Lower();
  64
  65     virtual bool Show( bool show = true );
  66
  67     virtual bool IsRetained() const;
  68
  69     virtual void SetFocus();
  70
  71     // hint from wx to native GTK+ tab traversal code
  72     virtual void SetCanFocus(bool canFocus);
  73
  74     virtual bool Reparent( wxWindowBase *newParent );
  75
  76     virtual void WarpPointer(int x, int y);
  77
  78     virtual void Refresh( bool eraseBackground = true,
  79                           const wxRect *rect = (const wxRect *) NULL );
  80     virtual void Update();
  81     virtual void ClearBackground();
  82
  83     virtual bool SetBackgroundColour( const wxColour &colour );
  84     virtual bool SetForegroundColour( const wxColour &colour );
  85     virtual bool SetCursor( const wxCursor &cursor );
  86     virtual bool SetFont( const wxFont &font );
  87
  88     virtual bool SetBackgroundStyle(wxBackgroundStyle style) ;
  89     virtual bool IsTransparentBackgroundSupported(wxString* reason = NULL) const;
  90
  91     virtual int GetCharHeight() const;
  92     virtual int GetCharWidth() 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 = NULL );
 102     virtual bool ScrollLines(int lines);
 103     virtual bool ScrollPages(int pages);
 104
 105 #if wxUSE_DRAG_AND_DROP
 106     virtual void SetDropTarget( wxDropTarget *dropTarget );
 107 #endif // wxUSE_DRAG_AND_DROP
 108
 109     virtual void AddChild( wxWindowBase *child );
 110     virtual void RemoveChild( wxWindowBase *child );
 111
 112     virtual void SetLayoutDirection(wxLayoutDirection dir);
 113     virtual wxLayoutDirection GetLayoutDirection() const;
 114     virtual wxCoord AdjustForLayoutDirection(wxCoord x,
 115                                              wxCoord width,
 116                                              wxCoord widthTotal) const;
 117
 118     virtual bool DoIsExposed( int x, int y ) const;
 119     virtual bool DoIsExposed( int x, int y, int w, int h ) const;
 120
 121     // currently wxGTK2-only
 122     void SetDoubleBuffered(bool on);
 123     virtual bool IsDoubleBuffered() const;
 124
 125     // SetLabel(), which does nothing in wxWindow
 126     virtual void SetLabel(const wxString& label) { m_gtkLabel = label; }
 127     virtual wxString GetLabel() const            { return m_gtkLabel; }
 128
 129     // implementation
 130     // --------------
 131
 132     virtual WXWidget GetHandle() const { return m_widget; }
 133
 134     // many important things are done here, this function must be called
 135     // regularly
 136     virtual void OnInternalIdle();
 137
 138     // For compatibility across platforms (not in event table)
 139     void OnIdle(wxIdleEvent& WXUNUSED(event)) {}
 140
 141     // Used by all window classes in the widget creation process.
 142     bool PreCreation( wxWindowGTK *parent, const wxPoint &pos, const wxSize &size );
 143     void PostCreation();
 144
 145     // Internal addition of child windows
 146     void DoAddChild(wxWindowGTK *child);
 147
 148     // This method sends wxPaintEvents to the window.
 149     // It is also responsible for background erase events.
 150 #ifdef __WXGTK3__
 151     void GTKSendPaintEvents(cairo_t* cr);
 152 #else
 153     void GTKSendPaintEvents(const GdkRegion* region);
 154 #endif
 155
 156     // The methods below are required because many native widgets
 157     // are composed of several subwidgets and setting a style for
 158     // the widget means setting it for all subwidgets as well.
 159     // also, it is not clear which native widget is the top
 160     // widget where (most of) the input goes. even tooltips have
 161     // to be applied to all subwidgets.
 162     virtual GtkWidget* GetConnectWidget();
 163     void ConnectWidget( GtkWidget *widget );
 164
 165     // Called from several event handlers, if it returns true or false, the
 166     // same value should be immediately returned by the handler without doing
 167     // anything else. If it returns -1, the handler should continue as usual
 168     int GTKCallbackCommonPrologue(struct _GdkEventAny *event) const;
 169
 170     // Simplified form of GTKCallbackCommonPrologue() which can be used from
 171     // GTK callbacks without return value to check if the event should be
 172     // ignored: if this returns true, the event shouldn't be handled
 173     bool GTKShouldIgnoreEvent() const;
 174
 175
 176     // override this if some events should never be consumed by wxWidgets but
 177     // but have to be left for the native control
 178     //
 179     // base version just calls HandleWindowEvent()
 180     virtual bool GTKProcessEvent(wxEvent& event) const;
 181
 182     // Map GTK widget direction of the given widget to/from wxLayoutDirection
 183     static wxLayoutDirection GTKGetLayout(GtkWidget *widget);
 184     static void GTKSetLayout(GtkWidget *widget, wxLayoutDirection dir);
 185
 186     // This is called when capture is taken from the window. It will
 187     // fire off capture lost events.
 188     void GTKReleaseMouseAndNotify();
 189
 190     GdkWindow* GTKGetDrawingWindow() const;
 191
 192     bool GTKHandleFocusIn();
 193     bool GTKHandleFocusOut();
 194     void GTKHandleFocusOutNoDeferring();
 195     static void GTKHandleDeferredFocusOut();
 196
 197     // Called when m_widget becomes realized. Derived classes must call the
 198     // base class method if they override it.
 199     virtual void GTKHandleRealized();
 200     void GTKHandleUnrealize();
 201
 202 protected:
 203     // for controls composed of multiple GTK widgets, return true to eliminate
 204     // spurious focus events if the focus changes between GTK+ children within
 205     // the same wxWindow
 206     virtual bool GTKNeedsToFilterSameWindowFocus() const { return false; }
 207
 208     // Override GTKWidgetNeedsMnemonic and return true if your
 209     // needs to set its mnemonic widget, such as for a
 210     // GtkLabel for wxStaticText, then do the actual
 211     // setting of the widget inside GTKWidgetDoSetMnemonic
 212     virtual bool GTKWidgetNeedsMnemonic() const;
 213     virtual void GTKWidgetDoSetMnemonic(GtkWidget* w);
 214
 215     // Get the GdkWindows making part of this window: usually there will be
 216     // only one of them in which case it should be returned directly by this
 217     // function. If there is more than one GdkWindow (can be the case for
 218     // composite widgets), return NULL and fill in the provided array
 219     //
 220     // This is not pure virtual for backwards compatibility but almost
 221     // certainly must be overridden in any wxControl-derived class!
 222     virtual GdkWindow *GTKGetWindow(wxArrayGdkWindows& windows) const;
 223
 224     // Check if the given window makes part of this widget
 225     bool GTKIsOwnWindow(GdkWindow *window) const;
 226
 227 public:
 228     // Returns the default context which usually is anti-aliased
 229     PangoContext   *GTKGetPangoDefaultContext();
 230
 231 #if wxUSE_TOOLTIPS
 232     // applies tooltip to the widget (tip must be UTF-8 encoded)
 233     virtual void GTKApplyToolTip(const char* tip);
 234 #endif // wxUSE_TOOLTIPS
 235
 236     // Called when a window should delay showing itself
 237     // until idle time used in Reparent().
 238     void GTKShowOnIdle() { m_showOnIdle = true; }
 239
 240     // This is called from the various OnInternalIdle methods
 241     bool GTKShowFromOnIdle();
 242
 243     // is this window transparent for the mouse events (as wxStaticBox is)?
 244     virtual bool GTKIsTransparentForMouse() const { return false; }
 245
 246     // Common scroll event handling code for wxWindow and wxScrollBar
 247     wxEventType GTKGetScrollEventType(GtkRange* range);
 248
 249     // position and size of the window
 250     int                  m_x, m_y;
 251     int                  m_width, m_height;
 252     int m_clientWidth, m_clientHeight;
 253     // Whether the client size variables above are known to be correct
 254     // (because they have been validated by a size-allocate) and should
 255     // be used to report client size
 256     bool m_useCachedClientSize;
 257
 258     // see the docs in src/gtk/window.cpp
 259     GtkWidget           *m_widget;          // mostly the widget seen by the rest of GTK
 260     GtkWidget           *m_wxwindow;        // mostly the client area as per wxWidgets
 261
 262     // label for use with GetLabelSetLabel
 263     wxString             m_gtkLabel;
 264
 265     // return true if the window is of a standard (i.e. not wxWidgets') class
 266     bool IsOfStandardClass() const { return m_wxwindow == NULL; }
 267
 268     // this widget will be queried for GTK's focus events
 269     GtkWidget           *m_focusWidget;
 270
 271     void GTKDisableFocusOutEvent();
 272     void GTKEnableFocusOutEvent();
 273
 274
 275     // Input method support
 276
 277     // The IM context used for generic, i.e. non-native, windows.
 278     //
 279     // It might be a good idea to avoid allocating it unless key events from
 280     // this window are really needed but currently we do it unconditionally.
 281     //
 282     // For native widgets (i.e. those for which IsOfStandardClass() returns
 283     // true) it is NULL.
 284     GtkIMContext* m_imContext;
 285
 286     // Pointer to the event being currently processed by the IME or NULL if not
 287     // inside key handling.
 288     GdkEventKey* m_imKeyEvent;
 289
 290     // This method generalizes gtk_im_context_filter_keypress(): for the
 291     // generic windows it does just that but it's overridden by the classes
 292     // wrapping native widgets that use IM themselves and so provide specific
 293     // methods for accessing it such gtk_entry_im_context_filter_keypress().
 294     virtual int GTKIMFilterKeypress(GdkEventKey* event) const;
 295
 296     // This method must be called from the derived classes "insert-text" signal
 297     // handlers to check if the text is not being inserted by the IM and, if
 298     // this is the case, generate appropriate wxEVT_CHAR events for it.
 299     //
 300     // Returns true if we did generate and process events corresponding to this
 301     // text or false if we didn't handle it.
 302     bool GTKOnInsertText(const char* text);
 303
 304     // This is just a helper of GTKOnInsertText() which is also used by GTK+
 305     // "commit" signal handler.
 306     bool GTKDoInsertTextFromIM(const char* text);
 307
 308
 309     // indices for the arrays below
 310     enum ScrollDir { ScrollDir_Horz, ScrollDir_Vert, ScrollDir_Max };
 311
 312     // horizontal/vertical scroll bar
 313     GtkRange* m_scrollBar[ScrollDir_Max];
 314
 315     // horizontal/vertical scroll position
 316     double m_scrollPos[ScrollDir_Max];
 317
 318     // return the scroll direction index corresponding to the given orientation
 319     // (which is wxVERTICAL or wxHORIZONTAL)
 320     static ScrollDir ScrollDirFromOrient(int orient)
 321     {
 322         return orient == wxVERTICAL ? ScrollDir_Vert : ScrollDir_Horz;
 323     }
 324
 325     // return the orientation for the given scrolling direction
 326     static int OrientFromScrollDir(ScrollDir dir)
 327     {
 328         return dir == ScrollDir_Horz ? wxHORIZONTAL : wxVERTICAL;
 329     }
 330
 331     // find the direction of the given scrollbar (must be one of ours)
 332     ScrollDir ScrollDirFromRange(GtkRange *range) const;
 333
 334     // set the current cursor for all GdkWindows making part of this widget
 335     // (see GTKGetWindow)
 336     void GTKUpdateCursor(bool update_self = true, bool recurse = true);
 337
 338     // extra (wxGTK-specific) flags
 339     bool                 m_noExpose:1;          // wxGLCanvas has its own redrawing
 340     bool                 m_nativeSizeEvent:1;   // wxGLCanvas sends wxSizeEvent upon "alloc_size"
 341     bool                 m_isScrolling:1;       // dragging scrollbar thumb?
 342     bool                 m_clipPaintRegion:1;   // true after ScrollWindow()
 343     wxRegion             m_nativeUpdateRegion;  // not transformed for RTL
 344     bool                 m_dirtyTabOrder:1;     // tab order changed, GTK focus
 345                                                 // chain needs update
 346     bool                 m_mouseButtonDown:1;
 347
 348     bool                 m_showOnIdle:1;        // postpone showing the window until idle
 349
 350 protected:
 351     // implement the base class pure virtuals
 352     virtual void DoGetTextExtent(const wxString& string,
 353                                  int *x, int *y,
 354                                  int *descent = NULL,
 355                                  int *externalLeading = NULL,
 356                                  const wxFont *font = NULL) const;
 357     virtual void DoClientToScreen( int *x, int *y ) const;
 358     virtual void DoScreenToClient( int *x, int *y ) const;
 359     virtual void DoGetPosition( int *x, int *y ) const;
 360     virtual void DoGetSize( int *width, int *height ) const;
 361     virtual void DoGetClientSize( int *width, int *height ) const;
 362     virtual void DoSetSize(int x, int y,
 363                            int width, int height,
 364                            int sizeFlags = wxSIZE_AUTO);
 365     virtual void DoSetClientSize(int width, int height);
 366     virtual wxSize DoGetBorderSize() const;
 367     virtual void DoMoveWindow(int x, int y, int width, int height);
 368     virtual void DoEnable(bool enable);
 369
 370 #if wxUSE_MENUS_NATIVE
 371     virtual bool DoPopupMenu( wxMenu *menu, int x, int y );
 372 #endif // wxUSE_MENUS_NATIVE
 373
 374     virtual void DoCaptureMouse();
 375     virtual void DoReleaseMouse();
 376
 377     virtual void DoFreeze();
 378     virtual void DoThaw();
 379
 380     void GTKFreezeWidget(GtkWidget *w);
 381     void GTKThawWidget(GtkWidget *w);
 382     void GTKDisconnect(void* instance);
 383
 384 #if wxUSE_TOOLTIPS
 385     virtual void DoSetToolTip( wxToolTip *tip );
 386 #endif // wxUSE_TOOLTIPS
 387
 388     // Create a GtkScrolledWindow containing the given widget (usually
 389     // m_wxwindow but not necessarily) and assigns it to m_widget. Also shows
 390     // the widget passed to it.
 391     //
 392     // Can be only called if we have either wxHSCROLL or wxVSCROLL in our
 393     // style.
 394     void GTKCreateScrolledWindowWith(GtkWidget* view);
 395
 396     virtual void DoMoveInTabOrder(wxWindow *win, WindowOrder move);
 397     virtual bool DoNavigateIn(int flags);
 398
 399
 400     // Copies m_children tab order to GTK focus chain:
 401     void RealizeTabOrder();
 402
 403 #ifndef __WXGTK3__
 404     // Called by ApplyWidgetStyle (which is called by SetFont() and
 405     // SetXXXColour etc to apply style changed to native widgets) to create
 406     // modified GTK style with non-standard attributes.
 407     GtkRcStyle* GTKCreateWidgetStyle();
 408 #endif
 409
 410     void GTKApplyWidgetStyle(bool forceStyle = false);
 411
 412     // helper function to ease native widgets wrapping, called by
 413     // ApplyWidgetStyle -- override this, not ApplyWidgetStyle
 414     virtual void DoApplyWidgetStyle(GtkRcStyle *style);
 415
 416     void GTKApplyStyle(GtkWidget* widget, GtkRcStyle* style);
 417
 418     // sets the border of a given GtkScrolledWindow from a wx style
 419     static void GTKScrolledWindowSetBorder(GtkWidget* w, int style);
 420
 421     // Connect the given function to the specified signal on m_widget.
 422     //
 423     // This is just a wrapper for g_signal_connect() and returns the handler id
 424     // just as it does.
 425     unsigned long GTKConnectWidget(const char *signal, wxGTKCallback callback);
 426
 427     void ConstrainSize();
 428
 429 private:
 430     void Init();
 431
 432     // return true if this window must have a non-NULL parent, false if it can
 433     // be created without parent (normally only top level windows but in wxGTK
 434     // there is also the exception of wxMenuBar)
 435     virtual bool GTKNeedsParent() const { return !IsTopLevel(); }
 436
 437     enum ScrollUnit { ScrollUnit_Line, ScrollUnit_Page, ScrollUnit_Max };
 438
 439     // common part of ScrollLines() and ScrollPages() and could be used, in the
 440     // future, for horizontal scrolling as well
 441     //
 442     // return true if we scrolled, false otherwise (on error or simply if we
 443     // are already at the end)
 444     bool DoScrollByUnits(ScrollDir dir, ScrollUnit unit, int units);
 445     virtual void AddChildGTK(wxWindowGTK* child);
 446
 447 #ifdef __WXGTK3__
 448     // paint context is stashed here so wxPaintDC can use it
 449     cairo_t* m_paintContext;
 450     // style provider for "background-image"
 451     GtkStyleProvider* m_styleProvider;
 452
 453 public:
 454     cairo_t* GTKPaintContext() const
 455     {
 456         return m_paintContext;
 457     }
 458 #endif
 459
 460     DECLARE_DYNAMIC_CLASS(wxWindowGTK)
 461     wxDECLARE_NO_COPY_CLASS(wxWindowGTK);
 462 };
 463
 464 #endif // _WX_GTK_WINDOW_H_