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 // wxWindowGTK
  23 //-----------------------------------------------------------------------------
  24
  25 class WXDLLIMPEXP_CORE wxWindowGTK : public wxWindowBase
  26 {
  27 public:
  28     // creating the window
  29     // -------------------
  30     wxWindowGTK();
  31     wxWindowGTK(wxWindow *parent,
  32                 wxWindowID id,
  33                 const wxPoint& pos = wxDefaultPosition,
  34                 const wxSize& size = wxDefaultSize,
  35                 long style = 0,
  36                 const wxString& name = wxPanelNameStr);
  37     bool Create(wxWindow *parent,
  38                 wxWindowID id,
  39                 const wxPoint& pos = wxDefaultPosition,
  40                 const wxSize& size = wxDefaultSize,
  41                 long style = 0,
  42                 const wxString& name = wxPanelNameStr);
  43     virtual ~wxWindowGTK();
  44
  45     // implement base class (pure) virtual methods
  46     // -------------------------------------------
  47
  48     virtual void SetLabel(const wxString& WXUNUSED(label)) { }
  49     virtual wxString GetLabel() const { return wxEmptyString; }
  50
  51     virtual bool Destroy();
  52
  53     virtual void Raise();
  54     virtual void Lower();
  55
  56     virtual bool Show( bool show = true );
  57
  58     virtual void SetWindowStyleFlag( long style );
  59
  60     virtual bool IsRetained() const;
  61
  62     virtual void SetFocus();
  63     virtual void SetCanFocus(bool canFocus);
  64
  65     virtual bool Reparent( wxWindowBase *newParent );
  66
  67     virtual void WarpPointer(int x, int y);
  68
  69     virtual void Refresh( bool eraseBackground = true,
  70                           const wxRect *rect = (const wxRect *) NULL );
  71     virtual void Update();
  72     virtual void ClearBackground();
  73
  74     virtual bool SetBackgroundColour( const wxColour &colour );
  75     virtual bool SetForegroundColour( const wxColour &colour );
  76     virtual bool SetCursor( const wxCursor &cursor );
  77     virtual bool SetFont( const wxFont &font );
  78
  79     virtual bool SetBackgroundStyle(wxBackgroundStyle style) ;
  80
  81     virtual int GetCharHeight() const;
  82     virtual int GetCharWidth() const;
  83     virtual void GetTextExtent(const wxString& string,
  84                                int *x, int *y,
  85                                int *descent = (int *) NULL,
  86                                int *externalLeading = (int *) NULL,
  87                                const wxFont *theFont = (const wxFont *) NULL)
  88                                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 = (wxRect *) 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     // implementation
 122     // --------------
 123
 124     virtual WXWidget GetHandle() const { return m_widget; }
 125
 126     // many important things are done here, this function must be called
 127     // regularly
 128     virtual void OnInternalIdle();
 129
 130     // Internal represention of Update()
 131     void GtkUpdate();
 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. differs from class
 141     // to class not by using virtual functions but by using
 142     // the m_insertCallback.
 143     void DoAddChild(wxWindowGTK *child);
 144
 145     // This methods sends wxPaintEvents to the window. It reads the
 146     // update region, breaks it up into rects and sends an event
 147     // for each rect. It is also responsible for background erase
 148     // events and NC paint events. It is called from "draw" and
 149     // "expose" handlers as well as from ::Update()
 150     void GtkSendPaintEvents();
 151
 152     // The methods below are required because many native widgets
 153     // are composed of several subwidgets and setting a style for
 154     // the widget means setting it for all subwidgets as well.
 155     // also, it is not clear which native widget is the top
 156     // widget where (most of) the input goes. even tooltips have
 157     // to be applied to all subwidgets.
 158     virtual GtkWidget* GetConnectWidget();
 159     void ConnectWidget( GtkWidget *widget );
 160
 161     // Called from several event handlers, if it returns true or false, the
 162     // same value should be immediately returned by the handler without doing
 163     // anything else. If it returns -1, the handler should continue as usual
 164     int GTKCallbackCommonPrologue(struct _GdkEventAny *event) const;
 165
 166     // override this if some events should never be consumed by wxWidgets but
 167     // but have to be left for the native control
 168     //
 169     // base version just does GetEventHandler()->ProcessEvent()
 170     virtual bool GTKProcessEvent(wxEvent& event) const;
 171
 172     // Map GTK widget direction of the given widget to/from wxLayoutDirection
 173     static wxLayoutDirection GTKGetLayout(GtkWidget *widget);
 174     static void GTKSetLayout(GtkWidget *widget, wxLayoutDirection dir);
 175
 176     // return true if this window must have a non-NULL parent, false if it can
 177     // be created without parent (normally only top level windows but in wxGTK
 178     // there is also the exception of wxMenuBar)
 179     virtual bool GTKNeedsParent() const { return !IsTopLevel(); }
 180
 181 protected:
 182     // Override GTKWidgetNeedsMnemonic and return true if your
 183     // needs to set its mnemonic widget, such as for a
 184     // GtkLabel for wxStaticText, then do the actual
 185     // setting of the widget inside GTKWidgetDoSetMnemonic
 186     virtual bool GTKWidgetNeedsMnemonic() const;
 187     virtual void GTKWidgetDoSetMnemonic(GtkWidget* w);
 188
 189     // Get the GdkWindows making part of this window: usually there will be
 190     // only one of them in which case it should be returned directly by this
 191     // function. If there is more than one GdkWindow (can be the case for
 192     // composite widgets), return NULL and fill in the provided array
 193     //
 194     // This is not pure virtual for backwards compatibility but almost
 195     // certainly must be overridden in any wxControl-derived class!
 196     virtual GdkWindow *GTKGetWindow(wxArrayGdkWindows& windows) const;
 197
 198     // Check if the given window makes part of this widget
 199     bool GTKIsOwnWindow(GdkWindow *window) const;
 200
 201     // Set the focus to this window if its setting was delayed because the
 202     // widget hadn't been realized when SetFocus() was called
 203     //
 204     // Return true if focus was set to us, false if nothing was done
 205     bool GTKSetDelayedFocusIfNeeded();
 206
 207 public:
 208     // Returns the default context which usually is anti-aliased
 209     PangoContext   *GtkGetPangoDefaultContext();
 210
 211 #if wxUSE_TOOLTIPS
 212     // applies tooltip to the widget (tip must be UTF-8 encoded)
 213     virtual void ApplyToolTip( GtkTooltips *tips, const gchar *tip );
 214 #endif // wxUSE_TOOLTIPS
 215
 216     // Called when a window should delay showing itself
 217     // until idle time. This partly mimmicks defered
 218     // sizing under MSW.
 219     void GtkShowOnIdle() { m_showOnIdle = true; }
 220
 221     // This is called from the various OnInternalIdle methods
 222     bool GtkShowFromOnIdle();
 223
 224     // fix up the mouse event coords, used by wxListBox only so far
 225     virtual void FixUpMouseEvent(GtkWidget * WXUNUSED(widget),
 226                                  wxCoord& WXUNUSED(x),
 227                                  wxCoord& WXUNUSED(y)) { }
 228
 229     // is this window transparent for the mouse events (as wxStaticBox is)?
 230     virtual bool IsTransparentForMouse() const { return false; }
 231
 232     // is this a radiobutton (used by radiobutton code itself only)?
 233     virtual bool IsRadioButton() const { return false; }
 234
 235     // Common scroll event handling code for wxWindow and wxScrollBar
 236     wxEventType GetScrollEventType(GtkRange* range);
 237
 238     void BlockScrollEvent();
 239     void UnblockScrollEvent();
 240
 241     // position and size of the window
 242     int                  m_x, m_y;
 243     int                  m_width, m_height;
 244     int                  m_oldClientWidth,m_oldClientHeight;
 245
 246     // see the docs in src/gtk/window.cpp
 247     GtkWidget           *m_widget;          // mostly the widget seen by the rest of GTK
 248     GtkWidget           *m_wxwindow;        // mostly the client area as per wxWidgets
 249
 250     // return true if the window is of a standard (i.e. not wxWidgets') class
 251     bool IsOfStandardClass() const { return m_wxwindow == NULL; }
 252
 253     // this widget will be queried for GTK's focus events
 254     GtkWidget           *m_focusWidget;
 255
 256     wxGtkIMData         *m_imData;
 257
 258
 259     // indices for the arrays below
 260     enum ScrollDir { ScrollDir_Horz, ScrollDir_Vert, ScrollDir_Max };
 261
 262     // horizontal/vertical scroll bar
 263     GtkRange* m_scrollBar[ScrollDir_Max];
 264
 265     // horizontal/vertical scroll position
 266     double m_scrollPos[ScrollDir_Max];
 267
 268     // return the scroll direction index corresponding to the given orientation
 269     // (which is wxVERTICAL or wxHORIZONTAL)
 270     static ScrollDir ScrollDirFromOrient(int orient)
 271     {
 272         return orient == wxVERTICAL ? ScrollDir_Vert : ScrollDir_Horz;
 273     }
 274
 275     // return the orientation for the given scrolling direction
 276     static int OrientFromScrollDir(ScrollDir dir)
 277     {
 278         return dir == ScrollDir_Horz ? wxHORIZONTAL : wxVERTICAL;
 279     }
 280
 281     // find the direction of the given scrollbar (must be one of ours)
 282     ScrollDir ScrollDirFromRange(GtkRange *range) const;
 283
 284
 285     // extra (wxGTK-specific) flags
 286     bool                 m_noExpose:1;          // wxGLCanvas has its own redrawing
 287     bool                 m_nativeSizeEvent:1;   // wxGLCanvas sends wxSizeEvent upon "alloc_size"
 288     bool                 m_hasScrolling:1;
 289     bool                 m_hasVMT:1;
 290     bool                 m_resizing:1;
 291     bool                 m_hasFocus:1;          // true if == FindFocus()
 292     bool                 m_isScrolling:1;       // dragging scrollbar thumb?
 293     bool                 m_clipPaintRegion:1;   // true after ScrollWindow()
 294     wxRegion             m_nativeUpdateRegion;  // not transformed for RTL
 295     bool                 m_dirtyTabOrder:1;     // tab order changed, GTK focus
 296                                                 // chain needs update
 297     bool                 m_needsStyleChange:1;  // May not be able to change
 298                                                 // background style until OnIdle
 299     bool                 m_mouseButtonDown:1;
 300     bool                 m_blockScrollEvent:1;
 301
 302     bool                 m_showOnIdle:1;        // postpone showing the window until idle
 303
 304 protected:
 305     // C++ has no virtual methods in the constrcutor of any class but we need
 306     // different methods of inserting a child window into a wxFrame,
 307     // wxMDIFrame, wxNotebook etc. this is the callback that will get used.
 308     typedef void (*InsertChildFunction)(wxWindowGTK*, wxWindowGTK*);
 309     InsertChildFunction m_insertCallback;
 310
 311     // implement the base class pure virtuals
 312     virtual void DoClientToScreen( int *x, int *y ) const;
 313     virtual void DoScreenToClient( int *x, int *y ) const;
 314     virtual void DoGetPosition( int *x, int *y ) const;
 315     virtual void DoGetSize( int *width, int *height ) const;
 316     virtual void DoGetClientSize( int *width, int *height ) const;
 317     virtual void DoSetSize(int x, int y,
 318                            int width, int height,
 319                            int sizeFlags = wxSIZE_AUTO);
 320     virtual void DoSetClientSize(int width, int height);
 321     virtual void DoMoveWindow(int x, int y, int width, int height);
 322     virtual void DoEnable(bool enable);
 323
 324 #if wxUSE_MENUS_NATIVE
 325     virtual bool DoPopupMenu( wxMenu *menu, int x, int y );
 326 #endif // wxUSE_MENUS_NATIVE
 327
 328     virtual void DoCaptureMouse();
 329     virtual void DoReleaseMouse();
 330
 331 #if wxUSE_TOOLTIPS
 332     virtual void DoSetToolTip( wxToolTip *tip );
 333 #endif // wxUSE_TOOLTIPS
 334
 335     // common part of all ctors (not virtual because called from ctor)
 336     void Init();
 337
 338     virtual void DoMoveInTabOrder(wxWindow *win, MoveKind move);
 339     virtual bool DoNavigateIn(int flags);
 340
 341
 342     // Copies m_children tab order to GTK focus chain:
 343     void RealizeTabOrder();
 344
 345     // Called by ApplyWidgetStyle (which is called by SetFont() and
 346     // SetXXXColour etc to apply style changed to native widgets) to create
 347     // modified GTK style with non-standard attributes. If forceStyle=true,
 348     // creates empty GtkRcStyle if there are no modifications, otherwise
 349     // returns NULL in such case.
 350     GtkRcStyle *CreateWidgetStyle(bool forceStyle = false);
 351
 352     // Overridden in many GTK widgets who have to handle subwidgets
 353     virtual void ApplyWidgetStyle(bool forceStyle = false);
 354
 355     // helper function to ease native widgets wrapping, called by
 356     // ApplyWidgetStyle -- override this, not ApplyWidgetStyle
 357     virtual void DoApplyWidgetStyle(GtkRcStyle *style);
 358
 359     // sets the border of a given GtkScrolledWindow from a wx style
 360     static void GtkScrolledWindowSetBorder(GtkWidget* w, int style);
 361
 362     // set the current cursor for all GdkWindows making part of this widget
 363     // (see GTKGetWindow)
 364     //
 365     // should be called from OnInternalIdle() if it's overridden
 366     void GTKUpdateCursor();
 367
 368     void ConstrainSize();
 369
 370 private:
 371     enum ScrollUnit { ScrollUnit_Line, ScrollUnit_Page, ScrollUnit_Max };
 372
 373     // common part of ScrollLines() and ScrollPages() and could be used, in the
 374     // future, for horizontal scrolling as well
 375     //
 376     // return true if we scrolled, false otherwise (on error or simply if we
 377     // are already at the end)
 378     bool DoScrollByUnits(ScrollDir dir, ScrollUnit unit, int units);
 379
 380
 381     DECLARE_DYNAMIC_CLASS(wxWindowGTK)
 382     DECLARE_NO_COPY_CLASS(wxWindowGTK)
 383 };
 384
 385 extern WXDLLIMPEXP_CORE wxWindow *wxFindFocusedChild(wxWindowGTK *win);
 386
 387 #endif // _WX_GTK_WINDOW_H_