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
  72     virtual bool Reparent( wxWindowBase *newParent );
  73
  74     virtual void WarpPointer(int x, int y);
  75
  76     virtual void Refresh( bool eraseBackground = true,
  77                           const wxRect *rect = (const wxRect *) NULL );
  78     virtual void Update();
  79     virtual void ClearBackground();
  80
  81     virtual bool SetBackgroundColour( const wxColour &colour );
  82     virtual bool SetForegroundColour( const wxColour &colour );
  83     virtual bool SetCursor( const wxCursor &cursor );
  84     virtual bool SetFont( const wxFont &font );
  85
  86     virtual bool SetBackgroundStyle(wxBackgroundStyle style) ;
  87
  88     virtual int GetCharHeight() const;
  89     virtual int GetCharWidth() const;
  90     virtual void GetTextExtent(const wxString& string,
  91                                int *x, int *y,
  92                                int *descent = (int *) NULL,
  93                                int *externalLeading = (int *) NULL,
  94                                const wxFont *theFont = (const wxFont *) NULL)
  95                                const;
  96
  97     virtual void SetScrollbar( int orient, int pos, int thumbVisible,
  98                                int range, bool refresh = true );
  99     virtual void SetScrollPos( int orient, int pos, bool refresh = true );
 100     virtual int GetScrollPos( int orient ) const;
 101     virtual int GetScrollThumb( int orient ) const;
 102     virtual int GetScrollRange( int orient ) const;
 103     virtual void ScrollWindow( int dx, int dy,
 104                                const wxRect* rect = (wxRect *) NULL );
 105     virtual bool ScrollLines(int lines);
 106     virtual bool ScrollPages(int pages);
 107
 108 #if wxUSE_DRAG_AND_DROP
 109     virtual void SetDropTarget( wxDropTarget *dropTarget );
 110 #endif // wxUSE_DRAG_AND_DROP
 111
 112     virtual void AddChild( wxWindowBase *child );
 113     virtual void RemoveChild( wxWindowBase *child );
 114
 115     virtual void SetLayoutDirection(wxLayoutDirection dir);
 116     virtual wxLayoutDirection GetLayoutDirection() const;
 117     virtual wxCoord AdjustForLayoutDirection(wxCoord x,
 118                                              wxCoord width,
 119                                              wxCoord widthTotal) const;
 120
 121     virtual bool DoIsExposed( int x, int y ) const;
 122     virtual bool DoIsExposed( int x, int y, int w, int h ) const;
 123
 124     // currently wxGTK2-only
 125     void SetDoubleBuffered(bool on);
 126     virtual bool IsDoubleBuffered() const;
 127
 128     // implementation
 129     // --------------
 130
 131     virtual WXWidget GetHandle() const { return m_widget; }
 132
 133     // many important things are done here, this function must be called
 134     // regularly
 135     virtual void OnInternalIdle();
 136
 137     // Internal represention of Update()
 138     void GtkUpdate();
 139
 140     // For compatibility across platforms (not in event table)
 141     void OnIdle(wxIdleEvent& WXUNUSED(event)) {}
 142
 143     // Used by all window classes in the widget creation process.
 144     bool PreCreation( wxWindowGTK *parent, const wxPoint &pos, const wxSize &size );
 145     void PostCreation();
 146
 147     // Internal addition of child windows. differs from class
 148     // to class not by using virtual functions but by using
 149     // the m_insertCallback.
 150     void DoAddChild(wxWindowGTK *child);
 151
 152     // This methods sends wxPaintEvents to the window. It reads the
 153     // update region, breaks it up into rects and sends an event
 154     // for each rect. It is also responsible for background erase
 155     // events and NC paint events. It is called from "draw" and
 156     // "expose" handlers as well as from ::Update()
 157     void GtkSendPaintEvents();
 158
 159     // The methods below are required because many native widgets
 160     // are composed of several subwidgets and setting a style for
 161     // the widget means setting it for all subwidgets as well.
 162     // also, it is not clear which native widget is the top
 163     // widget where (most of) the input goes. even tooltips have
 164     // to be applied to all subwidgets.
 165     virtual GtkWidget* GetConnectWidget();
 166     void ConnectWidget( GtkWidget *widget );
 167
 168     // Called from several event handlers, if it returns true or false, the
 169     // same value should be immediately returned by the handler without doing
 170     // anything else. If it returns -1, the handler should continue as usual
 171     int GTKCallbackCommonPrologue(struct _GdkEventAny *event) const;
 172
 173     // override this if some events should never be consumed by wxWidgets but
 174     // but have to be left for the native control
 175     //
 176     // base version just does GetEventHandler()->ProcessEvent()
 177     virtual bool GTKProcessEvent(wxEvent& event) const;
 178
 179     // Map GTK widget direction of the given widget to/from wxLayoutDirection
 180     static wxLayoutDirection GTKGetLayout(GtkWidget *widget);
 181     static void GTKSetLayout(GtkWidget *widget, wxLayoutDirection dir);
 182
 183 protected:
 184     // Override GTKWidgetNeedsMnemonic and return true if your
 185     // needs to set its mnemonic widget, such as for a
 186     // GtkLabel for wxStaticText, then do the actual
 187     // setting of the widget inside GTKWidgetDoSetMnemonic
 188     virtual bool GTKWidgetNeedsMnemonic() const;
 189     virtual void GTKWidgetDoSetMnemonic(GtkWidget* w);
 190
 191     // Get the GdkWindows making part of this window: usually there will be
 192     // only one of them in which case it should be returned directly by this
 193     // function. If there is more than one GdkWindow (can be the case for
 194     // composite widgets), return NULL and fill in the provided array
 195     //
 196     // This is not pure virtual for backwards compatibility but almost
 197     // certainly must be overridden in any wxControl-derived class!
 198     virtual GdkWindow *GTKGetWindow(wxArrayGdkWindows& windows) const;
 199
 200     // Check if the given window makes part of this widget
 201     bool GTKIsOwnWindow(GdkWindow *window) const;
 202
 203     // Set the focus to this window if its setting was delayed because the
 204     // widget hadn't been realized when SetFocus() was called
 205     //
 206     // Return true if focus was set to us, false if nothing was done
 207     bool GTKSetDelayedFocusIfNeeded();
 208
 209 public:
 210     // Returns the default context which usually is anti-aliased
 211     PangoContext   *GtkGetPangoDefaultContext();
 212
 213 #if wxUSE_TOOLTIPS
 214     virtual void ApplyToolTip( GtkTooltips *tips, const wxChar *tip );
 215 #endif // wxUSE_TOOLTIPS
 216
 217     // Called from GTK signal handlers. it indicates that
 218     // the layouting functions have to be called later on
 219     // (i.e. in idle time, implemented in OnInternalIdle() ).
 220     void GtkUpdateSize() { m_sizeSet = false; }
 221
 222
 223     // Called when a window should delay showing itself
 224     // until idle time. This partly mimmicks defered
 225     // sizing under MSW.
 226     void GtkShowOnIdle() { m_showOnIdle = true; }
 227
 228     // This is called from the various OnInternalIdle methods
 229     bool GtkShowFromOnIdle();
 230
 231     // fix up the mouse event coords, used by wxListBox only so far
 232     virtual void FixUpMouseEvent(GtkWidget * WXUNUSED(widget),
 233                                  wxCoord& WXUNUSED(x),
 234                                  wxCoord& WXUNUSED(y)) { }
 235
 236     // is this window transparent for the mouse events (as wxStaticBox is)?
 237     virtual bool IsTransparentForMouse() const { return false; }
 238
 239     // is this a radiobutton (used by radiobutton code itself only)?
 240     virtual bool IsRadioButton() const { return false; }
 241
 242     // Common scroll event handling code for wxWindow and wxScrollBar
 243     wxEventType GetScrollEventType(GtkRange* range);
 244
 245     void BlockScrollEvent();
 246     void UnblockScrollEvent();
 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     // this widget will be queried for GTK's focus events
 258     GtkWidget           *m_focusWidget;
 259
 260     wxGtkIMData         *m_imData;
 261
 262
 263     // indices for the arrays below
 264     enum ScrollDir { ScrollDir_Horz, ScrollDir_Vert, ScrollDir_Max };
 265
 266     // horizontal/vertical scroll bar
 267     GtkRange* m_scrollBar[ScrollDir_Max];
 268
 269     // horizontal/vertical scroll position
 270     double m_scrollPos[ScrollDir_Max];
 271
 272     // if true, don't notify about adjustment change (without resetting the
 273     // flag, so this has to be done manually)
 274     bool m_blockValueChanged[ScrollDir_Max];
 275
 276     // return the scroll direction index corresponding to the given orientation
 277     // (which is wxVERTICAL or wxHORIZONTAL)
 278     static ScrollDir ScrollDirFromOrient(int orient)
 279     {
 280         return orient == wxVERTICAL ? ScrollDir_Vert : ScrollDir_Horz;
 281     }
 282
 283     // return the orientation for the given scrolling direction
 284     static int OrientFromScrollDir(ScrollDir dir)
 285     {
 286         return dir == ScrollDir_Horz ? wxHORIZONTAL : wxVERTICAL;
 287     }
 288
 289     // find the direction of the given scrollbar (must be one of ours)
 290     ScrollDir ScrollDirFromRange(GtkRange *range) const;
 291
 292
 293     // extra (wxGTK-specific) flags
 294     bool                 m_needParent:1;        // ! wxFrame, wxDialog, wxNotebookPage ?
 295     bool                 m_noExpose:1;          // wxGLCanvas has its own redrawing
 296     bool                 m_nativeSizeEvent:1;   // wxGLCanvas sends wxSizeEvent upon "alloc_size"
 297     bool                 m_hasScrolling:1;
 298     bool                 m_hasVMT:1;
 299     bool                 m_sizeSet:1;
 300     bool                 m_resizing:1;
 301     bool                 m_hasFocus:1;          // true if == FindFocus()
 302     bool                 m_isScrolling:1;       // dragging scrollbar thumb?
 303     bool                 m_clipPaintRegion:1;   // true after ScrollWindow()
 304     wxRegion             m_nativeUpdateRegion;  // not transformed for RTL
 305     bool                 m_dirtyTabOrder:1;     // tab order changed, GTK focus
 306                                                 // chain needs update
 307     bool                 m_needsStyleChange:1;  // May not be able to change
 308                                                 // background style until OnIdle
 309     bool                 m_mouseButtonDown:1;
 310     bool                 m_blockScrollEvent:1;
 311
 312     bool                 m_showOnIdle:1;        // postpone showing the window until idle
 313
 314     // C++ has no virtual methods in the constrcutor of any class but we need
 315     // different methods of inserting a child window into a wxFrame,
 316     // wxMDIFrame, wxNotebook etc. this is the callback that will get used.
 317     wxInsertChildFunction  m_insertCallback;
 318
 319 protected:
 320     // implement the base class pure virtuals
 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 void DoMoveWindow(int x, int y, int width, int height);
 331
 332 #if wxUSE_MENUS_NATIVE
 333     virtual bool DoPopupMenu( wxMenu *menu, int x, int y );
 334 #endif // wxUSE_MENUS_NATIVE
 335
 336     virtual void DoCaptureMouse();
 337     virtual void DoReleaseMouse();
 338
 339 #if wxUSE_TOOLTIPS
 340     virtual void DoSetToolTip( wxToolTip *tip );
 341 #endif // wxUSE_TOOLTIPS
 342
 343     // common part of all ctors (not virtual because called from ctor)
 344     void Init();
 345
 346     virtual void DoMoveInTabOrder(wxWindow *win, MoveKind move);
 347
 348     // Copies m_children tab order to GTK focus chain:
 349     void RealizeTabOrder();
 350
 351     // Called by ApplyWidgetStyle (which is called by SetFont() and
 352     // SetXXXColour etc to apply style changed to native widgets) to create
 353     // modified GTK style with non-standard attributes. If forceStyle=true,
 354     // creates empty GtkRcStyle if there are no modifications, otherwise
 355     // returns NULL in such case.
 356     GtkRcStyle *CreateWidgetStyle(bool forceStyle = false);
 357
 358     // Overridden in many GTK widgets who have to handle subwidgets
 359     virtual void ApplyWidgetStyle(bool forceStyle = false);
 360
 361     // helper function to ease native widgets wrapping, called by
 362     // ApplyWidgetStyle -- override this, not ApplyWidgetStyle
 363     virtual void DoApplyWidgetStyle(GtkRcStyle *style);
 364
 365     // sets the border of a given GtkScrolledWindow from a wx style
 366     static void GtkScrolledWindowSetBorder(GtkWidget* w, int style);
 367
 368     // set the current cursor for all GdkWindows making part of this widget
 369     // (see GTKGetWindow)
 370     //
 371     // should be called from OnInternalIdle() if it's overridden
 372     void GTKUpdateCursor();
 373
 374 private:
 375     enum ScrollUnit { ScrollUnit_Line, ScrollUnit_Page, ScrollUnit_Max };
 376
 377     // common part of ScrollLines() and ScrollPages() and could be used, in the
 378     // future, for horizontal scrolling as well
 379     //
 380     // return true if we scrolled, false otherwise (on error or simply if we
 381     // are already at the end)
 382     bool DoScrollByUnits(ScrollDir dir, ScrollUnit unit, int units);
 383
 384
 385     DECLARE_DYNAMIC_CLASS(wxWindowGTK)
 386     DECLARE_NO_COPY_CLASS(wxWindowGTK)
 387 };
 388
 389 extern WXDLLIMPEXP_CORE wxWindow *wxFindFocusedChild(wxWindowGTK *win);
 390
 391 #endif // _WX_GTK_WINDOW_H_