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