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