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 bool Enable( bool enable = true );
  65
  66     virtual void SetWindowStyleFlag( long style );
  67
  68     virtual bool IsRetained() const;
  69
  70     virtual void SetFocus();
  71     virtual bool AcceptsFocus() const;
  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     // currently wxGTK2-only
 123     void SetDoubleBuffered(bool on);
 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     // Internal represention of Update()
 135     void GtkUpdate();
 136
 137     // For compatibility across platforms (not in event table)
 138     void OnIdle(wxIdleEvent& WXUNUSED(event)) {}
 139
 140     // wxGTK-specific: called recursively by Enable,
 141     // to give widgets an opportunity to correct their colours after they
 142     // have been changed by Enable
 143     virtual void OnParentEnable( bool WXUNUSED(enable) ) {}
 144
 145     // Used by all window classes in the widget creation process.
 146     bool PreCreation( wxWindowGTK *parent, const wxPoint &pos, const wxSize &size );
 147     void PostCreation();
 148
 149     // Internal addition of child windows. differs from class
 150     // to class not by using virtual functions but by using
 151     // the m_insertCallback.
 152     void DoAddChild(wxWindowGTK *child);
 153
 154     // This methods sends wxPaintEvents to the window. It reads the
 155     // update region, breaks it up into rects and sends an event
 156     // for each rect. It is also responsible for background erase
 157     // events and NC paint events. It is called from "draw" and
 158     // "expose" handlers as well as from ::Update()
 159     void GtkSendPaintEvents();
 160
 161     // The methods below are required because many native widgets
 162     // are composed of several subwidgets and setting a style for
 163     // the widget means setting it for all subwidgets as well.
 164     // also, it is not clear which native widget is the top
 165     // widget where (most of) the input goes. even tooltips have
 166     // to be applied to all subwidgets.
 167     virtual GtkWidget* GetConnectWidget();
 168     void ConnectWidget( GtkWidget *widget );
 169
 170     // Called from several event handlers, if it returns true or false, the
 171     // same value should be immediately returned by the handler without doing
 172     // anything else. If it returns -1, the handler should continue as usual
 173     int GTKCallbackCommonPrologue(struct _GdkEventAny *event) const;
 174
 175     // override this if some events should never be consumed by wxWidgets but
 176     // but have to be left for the native control
 177     //
 178     // base version just does GetEventHandler()->ProcessEvent()
 179     virtual bool GTKProcessEvent(wxEvent& event) const;
 180
 181     // Map GTK widget direction of the given widget to/from wxLayoutDirection
 182     static wxLayoutDirection GTKGetLayout(GtkWidget *widget);
 183     static void GTKSetLayout(GtkWidget *widget, wxLayoutDirection dir);
 184
 185 protected:
 186     // Override GTKWidgetNeedsMnemonic and return true if your
 187     // needs to set its mnemonic widget, such as for a
 188     // GtkLabel for wxStaticText, then do the actual
 189     // setting of the widget inside GTKWidgetDoSetMnemonic
 190     virtual bool GTKWidgetNeedsMnemonic() const;
 191     virtual void GTKWidgetDoSetMnemonic(GtkWidget* w);
 192
 193     // Get the GdkWindows making part of this window: usually there will be
 194     // only one of them in which case it should be returned directly by this
 195     // function. If there is more than one GdkWindow (can be the case for
 196     // composite widgets), return NULL and fill in the provided array
 197     //
 198     // This is not pure virtual for backwards compatibility but almost
 199     // certainly must be overridden in any wxControl-derived class!
 200     virtual GdkWindow *GTKGetWindow(wxArrayGdkWindows& windows) const;
 201
 202     // Check if the given window makes part of this widget
 203     bool GTKIsOwnWindow(GdkWindow *window) const;
 204
 205     // Set the focus to this window if its setting was delayed because the
 206     // widget hadn't been realized when SetFocus() was called
 207     //
 208     // Return true if focus was set to us, false if nothing was done
 209     bool GTKSetDelayedFocusIfNeeded();
 210
 211 public:
 212     // Returns the default context which usually is anti-aliased
 213     PangoContext   *GtkGetPangoDefaultContext();
 214
 215 #if wxUSE_TOOLTIPS
 216     virtual void ApplyToolTip( GtkTooltips *tips, const wxChar *tip );
 217 #endif // wxUSE_TOOLTIPS
 218
 219     // Called from GTK signal handlers. it indicates that
 220     // the layouting functions have to be called later on
 221     // (i.e. in idle time, implemented in OnInternalIdle() ).
 222     void GtkUpdateSize() { m_sizeSet = false; }
 223
 224
 225     // Called when a window should delay showing itself
 226     // until idle time. This partly mimmicks defered
 227     // sizing under MSW.
 228     void GtkShowOnIdle() { m_showOnIdle = true; }
 229
 230     // This is called from the various OnInternalIdle methods
 231     bool GtkShowFromOnIdle();
 232
 233     // fix up the mouse event coords, used by wxListBox only so far
 234     virtual void FixUpMouseEvent(GtkWidget * WXUNUSED(widget),
 235                                  wxCoord& WXUNUSED(x),
 236                                  wxCoord& WXUNUSED(y)) { }
 237
 238     // is this window transparent for the mouse events (as wxStaticBox is)?
 239     virtual bool IsTransparentForMouse() const { return false; }
 240
 241     // is this a radiobutton (used by radiobutton code itself only)?
 242     virtual bool IsRadioButton() const { return false; }
 243
 244     // Common scroll event handling code for wxWindow and wxScrollBar
 245     wxEventType GetScrollEventType(GtkRange* range);
 246
 247     void BlockScrollEvent();
 248     void UnblockScrollEvent();
 249
 250     // position and size of the window
 251     int                  m_x, m_y;
 252     int                  m_width, m_height;
 253     int                  m_oldClientWidth,m_oldClientHeight;
 254
 255     // see the docs in src/gtk/window.cpp
 256     GtkWidget           *m_widget;          // mostly the widget seen by the rest of GTK
 257     GtkWidget           *m_wxwindow;        // mostly the client area as per wxWidgets
 258
 259     // this widget will be queried for GTK's focus events
 260     GtkWidget           *m_focusWidget;
 261
 262     wxGtkIMData         *m_imData;
 263
 264
 265     // indices for the arrays below
 266     enum ScrollDir { ScrollDir_Horz, ScrollDir_Vert, ScrollDir_Max };
 267
 268     // horizontal/vertical scroll bar
 269     GtkRange* m_scrollBar[ScrollDir_Max];
 270
 271     // horizontal/vertical scroll position
 272     double m_scrollPos[ScrollDir_Max];
 273
 274     // if true, don't notify about adjustment change (without resetting the
 275     // flag, so this has to be done manually)
 276     bool m_blockValueChanged[ScrollDir_Max];
 277
 278     // return the scroll direction index corresponding to the given orientation
 279     // (which is wxVERTICAL or wxHORIZONTAL)
 280     static ScrollDir ScrollDirFromOrient(int orient)
 281     {
 282         return orient == wxVERTICAL ? ScrollDir_Vert : ScrollDir_Horz;
 283     }
 284
 285     // return the orientation for the given scrolling direction
 286     static int OrientFromScrollDir(ScrollDir dir)
 287     {
 288         return dir == ScrollDir_Horz ? wxHORIZONTAL : wxVERTICAL;
 289     }
 290
 291     // find the direction of the given scrollbar (must be one of ours)
 292     ScrollDir ScrollDirFromRange(GtkRange *range) const;
 293
 294
 295     // extra (wxGTK-specific) flags
 296     bool                 m_needParent:1;        // ! wxFrame, wxDialog, wxNotebookPage ?
 297     bool                 m_noExpose:1;          // wxGLCanvas has its own redrawing
 298     bool                 m_nativeSizeEvent:1;   // wxGLCanvas sends wxSizeEvent upon "alloc_size"
 299     bool                 m_hasScrolling:1;
 300     bool                 m_hasVMT:1;
 301     bool                 m_sizeSet:1;
 302     bool                 m_resizing:1;
 303     bool                 m_acceptsFocus:1;      // true if not static
 304     bool                 m_hasFocus:1;          // true if == FindFocus()
 305     bool                 m_isScrolling:1;       // dragging scrollbar thumb?
 306     bool                 m_clipPaintRegion:1;   // true after ScrollWindow()
 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     bool                 m_blockScrollEvent:1;
 313
 314     bool                 m_showOnIdle:1;        // postpone showing the window until idle
 315
 316     // C++ has no virtual methods in the constrcutor of any class but we need
 317     // different methods of inserting a child window into a wxFrame,
 318     // wxMDIFrame, wxNotebook etc. this is the callback that will get used.
 319     wxInsertChildFunction  m_insertCallback;
 320
 321 protected:
 322     // implement the base class pure virtuals
 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 void DoMoveWindow(int x, int y, int width, int height);
 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 #if wxUSE_TOOLTIPS
 342     virtual void DoSetToolTip( wxToolTip *tip );
 343 #endif // wxUSE_TOOLTIPS
 344
 345     // common part of all ctors (not virtual because called from ctor)
 346     void Init();
 347
 348     virtual void DoMoveInTabOrder(wxWindow *win, MoveKind move);
 349
 350     // Copies m_children tab order to GTK focus chain:
 351     void RealizeTabOrder();
 352
 353     // Called by ApplyWidgetStyle (which is called by SetFont() and
 354     // SetXXXColour etc to apply style changed to native widgets) to create
 355     // modified GTK style with non-standard attributes. If forceStyle=true,
 356     // creates empty GtkRcStyle if there are no modifications, otherwise
 357     // returns NULL in such case.
 358     GtkRcStyle *CreateWidgetStyle(bool forceStyle = false);
 359
 360     // Overridden in many GTK widgets who have to handle subwidgets
 361     virtual void ApplyWidgetStyle(bool forceStyle = false);
 362
 363     // helper function to ease native widgets wrapping, called by
 364     // ApplyWidgetStyle -- override this, not ApplyWidgetStyle
 365     virtual void DoApplyWidgetStyle(GtkRcStyle *style);
 366
 367     // sets the border of a given GtkScrolledWindow from a wx style
 368     static void GtkScrolledWindowSetBorder(GtkWidget* w, int style);
 369
 370     // set the current cursor for all GdkWindows making part of this widget
 371     // (see GTKGetWindow)
 372     //
 373     // should be called from OnInternalIdle() if it's overridden
 374     void GTKUpdateCursor();
 375
 376 private:
 377     enum ScrollUnit { ScrollUnit_Line, ScrollUnit_Page, ScrollUnit_Max };
 378
 379     // common part of ScrollLines() and ScrollPages() and could be used, in the
 380     // future, for horizontal scrolling as well
 381     //
 382     // return true if we scrolled, false otherwise (on error or simply if we
 383     // are already at the end)
 384     bool DoScrollByUnits(ScrollDir dir, ScrollUnit unit, int units);
 385
 386
 387     DECLARE_DYNAMIC_CLASS(wxWindowGTK)
 388     DECLARE_NO_COPY_CLASS(wxWindowGTK)
 389 };
 390
 391 extern WXDLLIMPEXP_CORE wxWindow *wxFindFocusedChild(wxWindowGTK *win);
 392
 393 #endif // _WX_GTK_WINDOW_H_