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     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     // wxGTK-specific: called recursively by Enable,
 145     // to give widgets an opportunity to correct their colours after they
 146     // have been changed by Enable
 147     virtual void OnParentEnable( bool WXUNUSED(enable) ) {}
 148
 149     // Used by all window classes in the widget creation process.
 150     bool PreCreation( wxWindowGTK *parent, const wxPoint &pos, const wxSize &size );
 151     void PostCreation();
 152
 153     // Internal addition of child windows. differs from class
 154     // to class not by using virtual functions but by using
 155     // the m_insertCallback.
 156     void DoAddChild(wxWindowGTK *child);
 157
 158     // This methods sends wxPaintEvents to the window. It reads the
 159     // update region, breaks it up into rects and sends an event
 160     // for each rect. It is also responsible for background erase
 161     // events and NC paint events. It is called from "draw" and
 162     // "expose" handlers as well as from ::Update()
 163     void GtkSendPaintEvents();
 164
 165     // The methods below are required because many native widgets
 166     // are composed of several subwidgets and setting a style for
 167     // the widget means setting it for all subwidgets as well.
 168     // also, it is not clear which native widget is the top
 169     // widget where (most of) the input goes. even tooltips have
 170     // to be applied to all subwidgets.
 171     virtual GtkWidget* GetConnectWidget();
 172     void ConnectWidget( GtkWidget *widget );
 173
 174     // Called from several event handlers, if it returns true or false, the
 175     // same value should be immediately returned by the handler without doing
 176     // anything else. If it returns -1, the handler should continue as usual
 177     int GTKCallbackCommonPrologue(struct _GdkEventAny *event) const;
 178
 179     // override this if some events should never be consumed by wxWidgets but
 180     // but have to be left for the native control
 181     //
 182     // base version just does GetEventHandler()->ProcessEvent()
 183     virtual bool GTKProcessEvent(wxEvent& event) const;
 184
 185     // Map GTK widget direction of the given widget to/from wxLayoutDirection
 186     static wxLayoutDirection GTKGetLayout(GtkWidget *widget);
 187     static void GTKSetLayout(GtkWidget *widget, wxLayoutDirection dir);
 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     // this widget will be queried for GTK's focus events
 264     GtkWidget           *m_focusWidget;
 265
 266     wxGtkIMData         *m_imData;
 267
 268
 269     // indices for the arrays below
 270     enum ScrollDir { ScrollDir_Horz, ScrollDir_Vert, ScrollDir_Max };
 271
 272     // horizontal/vertical scroll bar
 273     GtkRange* m_scrollBar[ScrollDir_Max];
 274
 275     // horizontal/vertical scroll position
 276     double m_scrollPos[ScrollDir_Max];
 277
 278     // if true, don't notify about adjustment change (without resetting the
 279     // flag, so this has to be done manually)
 280     bool m_blockValueChanged[ScrollDir_Max];
 281
 282     // return the scroll direction index corresponding to the given orientation
 283     // (which is wxVERTICAL or wxHORIZONTAL)
 284     static ScrollDir ScrollDirFromOrient(int orient)
 285     {
 286         return orient == wxVERTICAL ? ScrollDir_Vert : ScrollDir_Horz;
 287     }
 288
 289     // return the orientation for the given scrolling direction
 290     static int OrientFromScrollDir(ScrollDir dir)
 291     {
 292         return dir == ScrollDir_Horz ? wxHORIZONTAL : wxVERTICAL;
 293     }
 294
 295     // find the direction of the given scrollbar (must be one of ours)
 296     ScrollDir ScrollDirFromRange(GtkRange *range) const;
 297
 298
 299     // extra (wxGTK-specific) flags
 300     bool                 m_needParent:1;        // ! wxFrame, wxDialog, wxNotebookPage ?
 301     bool                 m_noExpose:1;          // wxGLCanvas has its own redrawing
 302     bool                 m_nativeSizeEvent:1;   // wxGLCanvas sends wxSizeEvent upon "alloc_size"
 303     bool                 m_hasScrolling:1;
 304     bool                 m_hasVMT:1;
 305     bool                 m_sizeSet:1;
 306     bool                 m_resizing:1;
 307     bool                 m_acceptsFocus:1;      // true if not static
 308     bool                 m_hasFocus:1;          // true if == FindFocus()
 309     bool                 m_isScrolling:1;       // dragging scrollbar thumb?
 310     bool                 m_clipPaintRegion:1;   // true after ScrollWindow()
 311     wxRegion             m_nativeUpdateRegion;  // not transformed for RTL
 312     bool                 m_dirtyTabOrder:1;     // tab order changed, GTK focus
 313                                                 // chain needs update
 314     bool                 m_needsStyleChange:1;  // May not be able to change
 315                                                 // background style until OnIdle
 316     bool                 m_mouseButtonDown:1;
 317     bool                 m_blockScrollEvent:1;
 318
 319     bool                 m_showOnIdle:1;        // postpone showing the window until idle
 320
 321     // C++ has no virtual methods in the constrcutor of any class but we need
 322     // different methods of inserting a child window into a wxFrame,
 323     // wxMDIFrame, wxNotebook etc. this is the callback that will get used.
 324     wxInsertChildFunction  m_insertCallback;
 325
 326 protected:
 327     // implement the base class pure virtuals
 328     virtual void DoClientToScreen( int *x, int *y ) const;
 329     virtual void DoScreenToClient( int *x, int *y ) const;
 330     virtual void DoGetPosition( int *x, int *y ) const;
 331     virtual void DoGetSize( int *width, int *height ) const;
 332     virtual void DoGetClientSize( int *width, int *height ) const;
 333     virtual void DoSetSize(int x, int y,
 334                            int width, int height,
 335                            int sizeFlags = wxSIZE_AUTO);
 336     virtual void DoSetClientSize(int width, int height);
 337     virtual void DoMoveWindow(int x, int y, int width, int height);
 338
 339 #if wxUSE_MENUS_NATIVE
 340     virtual bool DoPopupMenu( wxMenu *menu, int x, int y );
 341 #endif // wxUSE_MENUS_NATIVE
 342
 343     virtual void DoCaptureMouse();
 344     virtual void DoReleaseMouse();
 345
 346 #if wxUSE_TOOLTIPS
 347     virtual void DoSetToolTip( wxToolTip *tip );
 348 #endif // wxUSE_TOOLTIPS
 349
 350     // common part of all ctors (not virtual because called from ctor)
 351     void Init();
 352
 353     virtual void DoMoveInTabOrder(wxWindow *win, MoveKind move);
 354
 355     // Copies m_children tab order to GTK focus chain:
 356     void RealizeTabOrder();
 357
 358     // Called by ApplyWidgetStyle (which is called by SetFont() and
 359     // SetXXXColour etc to apply style changed to native widgets) to create
 360     // modified GTK style with non-standard attributes. If forceStyle=true,
 361     // creates empty GtkRcStyle if there are no modifications, otherwise
 362     // returns NULL in such case.
 363     GtkRcStyle *CreateWidgetStyle(bool forceStyle = false);
 364
 365     // Overridden in many GTK widgets who have to handle subwidgets
 366     virtual void ApplyWidgetStyle(bool forceStyle = false);
 367
 368     // helper function to ease native widgets wrapping, called by
 369     // ApplyWidgetStyle -- override this, not ApplyWidgetStyle
 370     virtual void DoApplyWidgetStyle(GtkRcStyle *style);
 371
 372     // sets the border of a given GtkScrolledWindow from a wx style
 373     static void GtkScrolledWindowSetBorder(GtkWidget* w, int style);
 374
 375     // set the current cursor for all GdkWindows making part of this widget
 376     // (see GTKGetWindow)
 377     //
 378     // should be called from OnInternalIdle() if it's overridden
 379     void GTKUpdateCursor();
 380
 381 private:
 382     enum ScrollUnit { ScrollUnit_Line, ScrollUnit_Page, ScrollUnit_Max };
 383
 384     // common part of ScrollLines() and ScrollPages() and could be used, in the
 385     // future, for horizontal scrolling as well
 386     //
 387     // return true if we scrolled, false otherwise (on error or simply if we
 388     // are already at the end)
 389     bool DoScrollByUnits(ScrollDir dir, ScrollUnit unit, int units);
 390
 391
 392     DECLARE_DYNAMIC_CLASS(wxWindowGTK)
 393     DECLARE_NO_COPY_CLASS(wxWindowGTK)
 394 };
 395
 396 extern WXDLLIMPEXP_CORE wxWindow *wxFindFocusedChild(wxWindowGTK *win);
 397
 398 #endif // _WX_GTK_WINDOW_H_