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