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 //-----------------------------------------------------------------------------
  22 // callback definition for inserting a window (internal)
  23 //-----------------------------------------------------------------------------
  24
  25 class WXDLLIMPEXP_CORE wxWindowGTK;
  26 typedef void (*wxInsertChildFunction)( wxWindowGTK*, wxWindowGTK* );
  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 void SetLabel(const wxString& WXUNUSED(label)) { }
  56     virtual wxString GetLabel() const { return wxEmptyString; }
  57
  58     virtual bool Destroy();
  59
  60     virtual void Raise();
  61     virtual void Lower();
  62
  63     virtual bool Show( bool show = true );
  64     virtual void DoEnable( bool enable );
  65
  66     virtual void SetWindowStyleFlag( long style );
  67
  68     virtual bool IsRetained() const;
  69
  70     virtual void SetFocus();
  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
  89     virtual int GetCharHeight() const;
  90     virtual int GetCharWidth() const;
  91     virtual void GetTextExtent(const wxString& string,
  92                                int *x, int *y,
  93                                int *descent = (int *) NULL,
  94                                int *externalLeading = (int *) NULL,
  95                                const wxFont *theFont = (const wxFont *) NULL)
  96                                const;
  97
  98     virtual void SetScrollbar( int orient, int pos, int thumbVisible,
  99                                int range, bool refresh = true );
 100     virtual void SetScrollPos( int orient, int pos, bool refresh = true );
 101     virtual int GetScrollPos( int orient ) const;
 102     virtual int GetScrollThumb( int orient ) const;
 103     virtual int GetScrollRange( int orient ) const;
 104     virtual void ScrollWindow( int dx, int dy,
 105                                const wxRect* rect = (wxRect *) NULL );
 106     virtual bool ScrollLines(int lines);
 107     virtual bool ScrollPages(int pages);
 108
 109 #if wxUSE_DRAG_AND_DROP
 110     virtual void SetDropTarget( wxDropTarget *dropTarget );
 111 #endif // wxUSE_DRAG_AND_DROP
 112
 113     virtual void AddChild( wxWindowBase *child );
 114     virtual void RemoveChild( wxWindowBase *child );
 115
 116     virtual void SetLayoutDirection(wxLayoutDirection dir);
 117     virtual wxLayoutDirection GetLayoutDirection() const;
 118     virtual wxCoord AdjustForLayoutDirection(wxCoord x,
 119                                              wxCoord width,
 120                                              wxCoord widthTotal) const;
 121
 122     virtual bool DoIsExposed( int x, int y ) const;
 123     virtual bool DoIsExposed( int x, int y, int w, int h ) const;
 124
 125     // currently wxGTK2-only
 126     void SetDoubleBuffered(bool on);
 127     virtual bool IsDoubleBuffered() const;
 128
 129     // implementation
 130     // --------------
 131
 132     virtual WXWidget GetHandle() const { return m_widget; }
 133
 134     // many important things are done here, this function must be called
 135     // regularly
 136     virtual void OnInternalIdle();
 137
 138     // Internal represention of Update()
 139     void GtkUpdate();
 140
 141     // For compatibility across platforms (not in event table)
 142     void OnIdle(wxIdleEvent& WXUNUSED(event)) {}
 143
 144     // Used by all window classes in the widget creation process.
 145     bool PreCreation( wxWindowGTK *parent, const wxPoint &pos, const wxSize &size );
 146     void PostCreation();
 147
 148     // Internal addition of child windows. differs from class
 149     // to class not by using virtual functions but by using
 150     // the m_insertCallback.
 151     void DoAddChild(wxWindowGTK *child);
 152
 153     // This methods sends wxPaintEvents to the window. It reads the
 154     // update region, breaks it up into rects and sends an event
 155     // for each rect. It is also responsible for background erase
 156     // events and NC paint events. It is called from "draw" and
 157     // "expose" handlers as well as from ::Update()
 158     void GtkSendPaintEvents();
 159
 160     // The methods below are required because many native widgets
 161     // are composed of several subwidgets and setting a style for
 162     // the widget means setting it for all subwidgets as well.
 163     // also, it is not clear which native widget is the top
 164     // widget where (most of) the input goes. even tooltips have
 165     // to be applied to all subwidgets.
 166     virtual GtkWidget* GetConnectWidget();
 167     void ConnectWidget( GtkWidget *widget );
 168
 169     // Called from several event handlers, if it returns true or false, the
 170     // same value should be immediately returned by the handler without doing
 171     // anything else. If it returns -1, the handler should continue as usual
 172     int GTKCallbackCommonPrologue(struct _GdkEventAny *event) const;
 173
 174     // override this if some events should never be consumed by wxWidgets but
 175     // but have to be left for the native control
 176     //
 177     // base version just does GetEventHandler()->ProcessEvent()
 178     virtual bool GTKProcessEvent(wxEvent& event) const;
 179
 180     // Map GTK widget direction of the given widget to/from wxLayoutDirection
 181     static wxLayoutDirection GTKGetLayout(GtkWidget *widget);
 182     static void GTKSetLayout(GtkWidget *widget, wxLayoutDirection dir);
 183
 184     // return true if this window must have a non-NULL parent, false if it can
 185     // be created without parent (normally only top level windows but in wxGTK
 186     // there is also the exception of wxMenuBar)
 187     virtual bool GTKNeedsParent() const { return !IsTopLevel(); }
 188
 189 protected:
 190     // Override GTKWidgetNeedsMnemonic and return true if your
 191     // needs to set its mnemonic widget, such as for a
 192     // GtkLabel for wxStaticText, then do the actual
 193     // setting of the widget inside GTKWidgetDoSetMnemonic
 194     virtual bool GTKWidgetNeedsMnemonic() const;
 195     virtual void GTKWidgetDoSetMnemonic(GtkWidget* w);
 196
 197     // Get the GdkWindows making part of this window: usually there will be
 198     // only one of them in which case it should be returned directly by this
 199     // function. If there is more than one GdkWindow (can be the case for
 200     // composite widgets), return NULL and fill in the provided array
 201     //
 202     // This is not pure virtual for backwards compatibility but almost
 203     // certainly must be overridden in any wxControl-derived class!
 204     virtual GdkWindow *GTKGetWindow(wxArrayGdkWindows& windows) const;
 205
 206     // Check if the given window makes part of this widget
 207     bool GTKIsOwnWindow(GdkWindow *window) const;
 208
 209     // Set the focus to this window if its setting was delayed because the
 210     // widget hadn't been realized when SetFocus() was called
 211     //
 212     // Return true if focus was set to us, false if nothing was done
 213     bool GTKSetDelayedFocusIfNeeded();
 214
 215 public:
 216     // Returns the default context which usually is anti-aliased
 217     PangoContext   *GtkGetPangoDefaultContext();
 218
 219 #if wxUSE_TOOLTIPS
 220     virtual void ApplyToolTip( GtkTooltips *tips, const wxChar *tip );
 221 #endif // wxUSE_TOOLTIPS
 222
 223     // Called from GTK signal handlers. it indicates that
 224     // the layouting functions have to be called later on
 225     // (i.e. in idle time, implemented in OnInternalIdle() ).
 226     void GtkUpdateSize() { m_sizeSet = false; }
 227
 228
 229     // Called when a window should delay showing itself
 230     // until idle time. This partly mimmicks defered
 231     // sizing under MSW.
 232     void GtkShowOnIdle() { m_showOnIdle = true; }
 233
 234     // This is called from the various OnInternalIdle methods
 235     bool GtkShowFromOnIdle();
 236
 237     // fix up the mouse event coords, used by wxListBox only so far
 238     virtual void FixUpMouseEvent(GtkWidget * WXUNUSED(widget),
 239                                  wxCoord& WXUNUSED(x),
 240                                  wxCoord& WXUNUSED(y)) { }
 241
 242     // is this window transparent for the mouse events (as wxStaticBox is)?
 243     virtual bool IsTransparentForMouse() const { return false; }
 244
 245     // is this a radiobutton (used by radiobutton code itself only)?
 246     virtual bool IsRadioButton() const { return false; }
 247
 248     // Common scroll event handling code for wxWindow and wxScrollBar
 249     wxEventType GetScrollEventType(GtkRange* range);
 250
 251     void BlockScrollEvent();
 252     void UnblockScrollEvent();
 253
 254     // position and size of the window
 255     int                  m_x, m_y;
 256     int                  m_width, m_height;
 257     int                  m_oldClientWidth,m_oldClientHeight;
 258
 259     // see the docs in src/gtk/window.cpp
 260     GtkWidget           *m_widget;          // mostly the widget seen by the rest of GTK
 261     GtkWidget           *m_wxwindow;        // mostly the client area as per wxWidgets
 262
 263     // return true if the window is of a standard (i.e. not wxWidgets') class
 264     bool IsOfStandardClass() const { return m_wxwindow == NULL; }
 265
 266     // this widget will be queried for GTK's focus events
 267     GtkWidget           *m_focusWidget;
 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     // if true, don't notify about adjustment change (without resetting the
 282     // flag, so this has to be done manually)
 283     bool m_blockValueChanged[ScrollDir_Max];
 284
 285     // return the scroll direction index corresponding to the given orientation
 286     // (which is wxVERTICAL or wxHORIZONTAL)
 287     static ScrollDir ScrollDirFromOrient(int orient)
 288     {
 289         return orient == wxVERTICAL ? ScrollDir_Vert : ScrollDir_Horz;
 290     }
 291
 292     // return the orientation for the given scrolling direction
 293     static int OrientFromScrollDir(ScrollDir dir)
 294     {
 295         return dir == ScrollDir_Horz ? wxHORIZONTAL : wxVERTICAL;
 296     }
 297
 298     // find the direction of the given scrollbar (must be one of ours)
 299     ScrollDir ScrollDirFromRange(GtkRange *range) const;
 300
 301
 302     // extra (wxGTK-specific) flags
 303     bool                 m_noExpose:1;          // wxGLCanvas has its own redrawing
 304     bool                 m_nativeSizeEvent:1;   // wxGLCanvas sends wxSizeEvent upon "alloc_size"
 305     bool                 m_hasScrolling:1;
 306     bool                 m_hasVMT:1;
 307     bool                 m_sizeSet:1;
 308     bool                 m_resizing:1;
 309     bool                 m_hasFocus:1;          // true if == FindFocus()
 310     bool                 m_isScrolling:1;       // dragging scrollbar thumb?
 311     bool                 m_clipPaintRegion:1;   // true after ScrollWindow()
 312     wxRegion             m_nativeUpdateRegion;  // not transformed for RTL
 313     bool                 m_dirtyTabOrder:1;     // tab order changed, GTK focus
 314                                                 // chain needs update
 315     bool                 m_needsStyleChange:1;  // May not be able to change
 316                                                 // background style until OnIdle
 317     bool                 m_mouseButtonDown:1;
 318     bool                 m_blockScrollEvent:1;
 319
 320     bool                 m_showOnIdle:1;        // postpone showing the window until idle
 321
 322     // C++ has no virtual methods in the constrcutor of any class but we need
 323     // different methods of inserting a child window into a wxFrame,
 324     // wxMDIFrame, wxNotebook etc. this is the callback that will get used.
 325     wxInsertChildFunction  m_insertCallback;
 326
 327 protected:
 328     // implement the base class pure virtuals
 329     virtual void DoClientToScreen( int *x, int *y ) const;
 330     virtual void DoScreenToClient( int *x, int *y ) const;
 331     virtual void DoGetPosition( int *x, int *y ) const;
 332     virtual void DoGetSize( int *width, int *height ) const;
 333     virtual void DoGetClientSize( int *width, int *height ) const;
 334     virtual void DoSetSize(int x, int y,
 335                            int width, int height,
 336                            int sizeFlags = wxSIZE_AUTO);
 337     virtual void DoSetClientSize(int width, int height);
 338     virtual void DoMoveWindow(int x, int y, int width, int height);
 339
 340 #if wxUSE_MENUS_NATIVE
 341     virtual bool DoPopupMenu( wxMenu *menu, int x, int y );
 342 #endif // wxUSE_MENUS_NATIVE
 343
 344     virtual void DoCaptureMouse();
 345     virtual void DoReleaseMouse();
 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, MoveKind 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 *CreateWidgetStyle(bool forceStyle = false);
 367
 368     // Overridden in many GTK widgets who have to handle subwidgets
 369     virtual void ApplyWidgetStyle(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     // set the current cursor for all GdkWindows making part of this widget
 379     // (see GTKGetWindow)
 380     //
 381     // should be called from OnInternalIdle() if it's overridden
 382     void GTKUpdateCursor();
 383
 384     void ConstrainSize();
 385
 386 private:
 387     enum ScrollUnit { ScrollUnit_Line, ScrollUnit_Page, ScrollUnit_Max };
 388
 389     // common part of ScrollLines() and ScrollPages() and could be used, in the
 390     // future, for horizontal scrolling as well
 391     //
 392     // return true if we scrolled, false otherwise (on error or simply if we
 393     // are already at the end)
 394     bool DoScrollByUnits(ScrollDir dir, ScrollUnit unit, int units);
 395
 396
 397     DECLARE_DYNAMIC_CLASS(wxWindowGTK)
 398     DECLARE_NO_COPY_CLASS(wxWindowGTK)
 399 };
 400
 401 extern WXDLLIMPEXP_CORE wxWindow *wxFindFocusedChild(wxWindowGTK *win);
 402
 403 #endif // _WX_GTK_WINDOW_H_