include/wx/gtk/window.h

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