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 void SetWindowStyleFlag( long style );
  63
  64     virtual bool IsRetained() const;
  65
  66     virtual void SetFocus();
  67
  68     // hint from wx to native GTK+ tab traversal code
  69     virtual void SetCanFocus(bool canFocus);
  70
  71     virtual bool Reparent( wxWindowBase *newParent );
  72
  73     virtual void WarpPointer(int x, int y);
  74
  75     virtual void Refresh( bool eraseBackground = true,
  76                           const wxRect *rect = (const wxRect *) NULL );
  77     virtual void Update();
  78     virtual void ClearBackground();
  79
  80     virtual bool SetBackgroundColour( const wxColour &colour );
  81     virtual bool SetForegroundColour( const wxColour &colour );
  82     virtual bool SetCursor( const wxCursor &cursor );
  83     virtual bool SetFont( const wxFont &font );
  84
  85     virtual bool SetBackgroundStyle(wxBackgroundStyle style) ;
  86
  87     virtual int GetCharHeight() const;
  88     virtual int GetCharWidth() const;
  89
  90     virtual void SetScrollbar( int orient, int pos, int thumbVisible,
  91                                int range, bool refresh = true );
  92     virtual void SetScrollPos( int orient, int pos, bool refresh = true );
  93     virtual int GetScrollPos( int orient ) const;
  94     virtual int GetScrollThumb( int orient ) const;
  95     virtual int GetScrollRange( int orient ) const;
  96     virtual void ScrollWindow( int dx, int dy,
  97                                const wxRect* rect = NULL );
  98     virtual bool ScrollLines(int lines);
  99     virtual bool ScrollPages(int pages);
 100
 101 #if wxUSE_DRAG_AND_DROP
 102     virtual void SetDropTarget( wxDropTarget *dropTarget );
 103 #endif // wxUSE_DRAG_AND_DROP
 104
 105     virtual void AddChild( wxWindowBase *child );
 106     virtual void RemoveChild( wxWindowBase *child );
 107
 108     virtual void SetLayoutDirection(wxLayoutDirection dir);
 109     virtual wxLayoutDirection GetLayoutDirection() const;
 110     virtual wxCoord AdjustForLayoutDirection(wxCoord x,
 111                                              wxCoord width,
 112                                              wxCoord widthTotal) const;
 113
 114     virtual bool DoIsExposed( int x, int y ) const;
 115     virtual bool DoIsExposed( int x, int y, int w, int h ) const;
 116
 117     // currently wxGTK2-only
 118     void SetDoubleBuffered(bool on);
 119     virtual bool IsDoubleBuffered() const;
 120
 121     // SetLabel(), which does nothing in wxWindow
 122     virtual void SetLabel(const wxString& label) { m_gtkLabel = label; }
 123     virtual wxString GetLabel() const            { return m_gtkLabel; }
 124
 125     // implementation
 126     // --------------
 127
 128     virtual WXWidget GetHandle() const { return m_widget; }
 129
 130     // many important things are done here, this function must be called
 131     // regularly
 132     virtual void OnInternalIdle();
 133
 134     // For compatibility across platforms (not in event table)
 135     void OnIdle(wxIdleEvent& WXUNUSED(event)) {}
 136
 137     // Used by all window classes in the widget creation process.
 138     bool PreCreation( wxWindowGTK *parent, const wxPoint &pos, const wxSize &size );
 139     void PostCreation();
 140
 141     // Internal addition of child windows
 142     void DoAddChild(wxWindowGTK *child);
 143
 144     // This methods sends wxPaintEvents to the window. It reads the
 145     // update region, breaks it up into rects and sends an event
 146     // for each rect. It is also responsible for background erase
 147     // events and NC paint events. It is called from "draw" and
 148     // "expose" handlers as well as from ::Update()
 149     void GtkSendPaintEvents();
 150
 151     // The methods below are required because many native widgets
 152     // are composed of several subwidgets and setting a style for
 153     // the widget means setting it for all subwidgets as well.
 154     // also, it is not clear which native widget is the top
 155     // widget where (most of) the input goes. even tooltips have
 156     // to be applied to all subwidgets.
 157     virtual GtkWidget* GetConnectWidget();
 158     void ConnectWidget( GtkWidget *widget );
 159
 160     // Called from several event handlers, if it returns true or false, the
 161     // same value should be immediately returned by the handler without doing
 162     // anything else. If it returns -1, the handler should continue as usual
 163     int GTKCallbackCommonPrologue(struct _GdkEventAny *event) const;
 164
 165     // Simplified form of GTKCallbackCommonPrologue() which can be used from
 166     // GTK callbacks without return value to check if the event should be
 167     // ignored: if this returns true, the event shouldn't be handled
 168     bool GTKShouldIgnoreEvent() const;
 169
 170
 171     // override this if some events should never be consumed by wxWidgets but
 172     // but have to be left for the native control
 173     //
 174     // base version just calls HandleWindowEvent()
 175     virtual bool GTKProcessEvent(wxEvent& event) const;
 176
 177     // Map GTK widget direction of the given widget to/from wxLayoutDirection
 178     static wxLayoutDirection GTKGetLayout(GtkWidget *widget);
 179     static void GTKSetLayout(GtkWidget *widget, wxLayoutDirection dir);
 180
 181     // return true if this window must have a non-NULL parent, false if it can
 182     // be created without parent (normally only top level windows but in wxGTK
 183     // there is also the exception of wxMenuBar)
 184     virtual bool GTKNeedsParent() const { return !IsTopLevel(); }
 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
 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_oldClientWidth,m_oldClientHeight;
 252
 253     // see the docs in src/gtk/window.cpp
 254     GtkWidget           *m_widget;          // mostly the widget seen by the rest of GTK
 255     GtkWidget           *m_wxwindow;        // mostly the client area as per wxWidgets
 256
 257     // label for use with GetLabelSetLabel
 258     wxString             m_gtkLabel;
 259
 260     // return true if the window is of a standard (i.e. not wxWidgets') class
 261     bool IsOfStandardClass() const { return m_wxwindow == NULL; }
 262
 263     // this widget will be queried for GTK's focus events
 264     GtkWidget           *m_focusWidget;
 265
 266     void GTKDisableFocusOutEvent();
 267     void GTKEnableFocusOutEvent();
 268
 269     wxGtkIMData         *m_imData;
 270
 271
 272     // indices for the arrays below
 273     enum ScrollDir { ScrollDir_Horz, ScrollDir_Vert, ScrollDir_Max };
 274
 275     // horizontal/vertical scroll bar
 276     GtkRange* m_scrollBar[ScrollDir_Max];
 277
 278     // horizontal/vertical scroll position
 279     double m_scrollPos[ScrollDir_Max];
 280
 281     // return the scroll direction index corresponding to the given orientation
 282     // (which is wxVERTICAL or wxHORIZONTAL)
 283     static ScrollDir ScrollDirFromOrient(int orient)
 284     {
 285         return orient == wxVERTICAL ? ScrollDir_Vert : ScrollDir_Horz;
 286     }
 287
 288     // return the orientation for the given scrolling direction
 289     static int OrientFromScrollDir(ScrollDir dir)
 290     {
 291         return dir == ScrollDir_Horz ? wxHORIZONTAL : wxVERTICAL;
 292     }
 293
 294     // find the direction of the given scrollbar (must be one of ours)
 295     ScrollDir ScrollDirFromRange(GtkRange *range) const;
 296
 297     // set the current cursor for all GdkWindows making part of this widget
 298     // (see GTKGetWindow)
 299     void GTKUpdateCursor(bool update_self = true, bool recurse = true);
 300
 301     // extra (wxGTK-specific) flags
 302     bool                 m_noExpose:1;          // wxGLCanvas has its own redrawing
 303     bool                 m_nativeSizeEvent:1;   // wxGLCanvas sends wxSizeEvent upon "alloc_size"
 304     bool                 m_hasVMT:1;            // set after PostCreation() is called
 305     bool                 m_isScrolling:1;       // dragging scrollbar thumb?
 306     bool                 m_clipPaintRegion:1;   // true after ScrollWindow()
 307     wxRegion             m_nativeUpdateRegion;  // not transformed for RTL
 308     bool                 m_dirtyTabOrder:1;     // tab order changed, GTK focus
 309                                                 // chain needs update
 310     bool                 m_needsStyleChange:1;  // May not be able to change
 311                                                 // background style until OnIdle
 312     bool                 m_mouseButtonDown:1;
 313
 314     bool                 m_showOnIdle:1;        // postpone showing the window until idle
 315
 316 protected:
 317     // implement the base class pure virtuals
 318     virtual void DoGetTextExtent(const wxString& string,
 319                                  int *x, int *y,
 320                                  int *descent = NULL,
 321                                  int *externalLeading = NULL,
 322                                  const wxFont *font = NULL) const;
 323     virtual void DoClientToScreen( int *x, int *y ) const;
 324     virtual void DoScreenToClient( int *x, int *y ) const;
 325     virtual void DoGetPosition( int *x, int *y ) const;
 326     virtual void DoGetSize( int *width, int *height ) const;
 327     virtual void DoGetClientSize( int *width, int *height ) const;
 328     virtual void DoSetSize(int x, int y,
 329                            int width, int height,
 330                            int sizeFlags = wxSIZE_AUTO);
 331     virtual void DoSetClientSize(int width, int height);
 332     virtual wxSize DoGetBorderSize() const;
 333     virtual void DoMoveWindow(int x, int y, int width, int height);
 334     virtual void DoEnable(bool enable);
 335
 336 #if wxUSE_MENUS_NATIVE
 337     virtual bool DoPopupMenu( wxMenu *menu, int x, int y );
 338 #endif // wxUSE_MENUS_NATIVE
 339
 340     virtual void DoCaptureMouse();
 341     virtual void DoReleaseMouse();
 342
 343     virtual void DoFreeze();
 344     virtual void DoThaw();
 345
 346     void GTKFreezeWidget(GtkWidget *w);
 347     void GTKThawWidget(GtkWidget *w);
 348
 349 #if wxUSE_TOOLTIPS
 350     virtual void DoSetToolTip( wxToolTip *tip );
 351 #endif // wxUSE_TOOLTIPS
 352
 353     // common part of all ctors (not virtual because called from ctor)
 354     void Init();
 355
 356     virtual void DoMoveInTabOrder(wxWindow *win, WindowOrder move);
 357     virtual bool DoNavigateIn(int flags);
 358
 359
 360     // Copies m_children tab order to GTK focus chain:
 361     void RealizeTabOrder();
 362
 363     // Called by ApplyWidgetStyle (which is called by SetFont() and
 364     // SetXXXColour etc to apply style changed to native widgets) to create
 365     // modified GTK style with non-standard attributes. If forceStyle=true,
 366     // creates empty GtkRcStyle if there are no modifications, otherwise
 367     // returns NULL in such case.
 368     GtkRcStyle *GTKCreateWidgetStyle(bool forceStyle = false);
 369
 370     // Overridden in many GTK widgets who have to handle subwidgets
 371     virtual void GTKApplyWidgetStyle(bool forceStyle = false);
 372
 373     // helper function to ease native widgets wrapping, called by
 374     // ApplyWidgetStyle -- override this, not ApplyWidgetStyle
 375     virtual void DoApplyWidgetStyle(GtkRcStyle *style);
 376
 377     // sets the border of a given GtkScrolledWindow from a wx style
 378     static void GTKScrolledWindowSetBorder(GtkWidget* w, int style);
 379
 380     // Connect the given function to the specified signal on m_widget.
 381     //
 382     // This is just a wrapper for g_signal_connect() and returns the handler id
 383     // just as it does.
 384     unsigned long GTKConnectWidget(const char *signal, wxGTKCallback callback);
 385
 386     // Return true from here if PostCreation() should connect to size_request
 387     // signal: this is done by default but doesn't work for some native
 388     // controls which override this function to return false
 389     virtual bool GTKShouldConnectSizeRequest() const { return !IsTopLevel(); }
 390
 391     void ConstrainSize();
 392
 393 private:
 394     enum ScrollUnit { ScrollUnit_Line, ScrollUnit_Page, ScrollUnit_Max };
 395
 396     // common part of ScrollLines() and ScrollPages() and could be used, in the
 397     // future, for horizontal scrolling as well
 398     //
 399     // return true if we scrolled, false otherwise (on error or simply if we
 400     // are already at the end)
 401     bool DoScrollByUnits(ScrollDir dir, ScrollUnit unit, int units);
 402     virtual void AddChildGTK(wxWindowGTK* child);
 403
 404
 405     DECLARE_DYNAMIC_CLASS(wxWindowGTK)
 406     wxDECLARE_NO_COPY_CLASS(wxWindowGTK);
 407 };
 408
 409 #endif // _WX_GTK_WINDOW_H_