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