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 __GTKWINDOWH__
  11 #define __GTKWINDOWH__
  12
  13 // helper structure that holds class that holds GtkIMContext object and
  14 // some additional data needed for key events processing
  15 struct wxGtkIMData;
  16
  17 //-----------------------------------------------------------------------------
  18 // callback definition for inserting a window (internal)
  19 //-----------------------------------------------------------------------------
  20
  21 class WXDLLIMPEXP_CORE wxWindowGTK;
  22 typedef void (*wxInsertChildFunction)( wxWindowGTK*, wxWindowGTK* );
  23
  24 //-----------------------------------------------------------------------------
  25 // wxWindowGTK
  26 //-----------------------------------------------------------------------------
  27
  28 class WXDLLIMPEXP_CORE wxWindowGTK : public wxWindowBase
  29 {
  30 public:
  31     // creating the window
  32     // -------------------
  33     wxWindowGTK();
  34     wxWindowGTK(wxWindow *parent,
  35                 wxWindowID id,
  36                 const wxPoint& pos = wxDefaultPosition,
  37                 const wxSize& size = wxDefaultSize,
  38                 long style = 0,
  39                 const wxString& name = wxPanelNameStr);
  40     bool Create(wxWindow *parent,
  41                 wxWindowID id,
  42                 const wxPoint& pos = wxDefaultPosition,
  43                 const wxSize& size = wxDefaultSize,
  44                 long style = 0,
  45                 const wxString& name = wxPanelNameStr);
  46     virtual ~wxWindowGTK();
  47
  48     // implement base class (pure) virtual methods
  49     // -------------------------------------------
  50
  51     virtual void SetLabel( const wxString &label ) {}
  52     virtual wxString GetLabel() const {}
  53
  54     virtual bool Destroy();
  55
  56     virtual void Raise();
  57     virtual void Lower();
  58
  59     virtual bool Show( bool show = TRUE );
  60     virtual bool Enable( bool enable = TRUE );
  61
  62     virtual bool IsRetained() const;
  63
  64     virtual void SetFocus();
  65     virtual bool AcceptsFocus() const;
  66
  67     virtual bool Reparent( wxWindowBase *newParent );
  68
  69     virtual void WarpPointer(int x, int y);
  70
  71     virtual void Refresh( bool eraseBackground = TRUE,
  72                           const wxRect *rect = (const wxRect *) NULL );
  73     virtual void Update();
  74     virtual void ClearBackground();
  75
  76     virtual bool SetBackgroundColour( const wxColour &colour );
  77     virtual bool SetForegroundColour( const wxColour &colour );
  78     virtual bool SetCursor( const wxCursor &cursor );
  79     virtual bool SetFont( const wxFont &font );
  80
  81     virtual bool SetBackgroundStyle(wxBackgroundStyle style) ;
  82
  83     virtual int GetCharHeight() const;
  84     virtual int GetCharWidth() const;
  85     virtual void GetTextExtent(const wxString& string,
  86                                int *x, int *y,
  87                                int *descent = (int *) NULL,
  88                                int *externalLeading = (int *) NULL,
  89                                const wxFont *theFont = (const wxFont *) NULL)
  90                                const;
  91
  92 #if wxUSE_MENUS_NATIVE
  93     virtual bool DoPopupMenu( wxMenu *menu, int x, int y );
  94 #endif // wxUSE_MENUS_NATIVE
  95
  96     virtual void SetScrollbar( int orient, int pos, int thumbVisible,
  97                                int range, bool refresh = TRUE );
  98     virtual void SetScrollPos( int orient, int pos, bool refresh = TRUE );
  99     virtual int GetScrollPos( int orient ) const;
 100     virtual int GetScrollThumb( int orient ) const;
 101     virtual int GetScrollRange( int orient ) const;
 102     virtual void ScrollWindow( int dx, int dy,
 103                                const wxRect* rect = (wxRect *) NULL );
 104
 105 #if wxUSE_DRAG_AND_DROP
 106     virtual void SetDropTarget( wxDropTarget *dropTarget );
 107 #endif // wxUSE_DRAG_AND_DROP
 108
 109 #ifdef __WXGTK20__
 110     virtual void AddChild( wxWindowBase *child );
 111     virtual void RemoveChild( wxWindowBase *child );
 112 #endif
 113
 114     // implementation
 115     // --------------
 116
 117     virtual WXWidget GetHandle() const { return m_widget; }
 118
 119     // I don't want users to override what's done in idle so everything that
 120     // has to be done in idle time in order for wxGTK to work is done in
 121     // OnInternalIdle
 122     virtual void OnInternalIdle();
 123
 124     // Internal represention of Update()
 125     void GtkUpdate();
 126
 127     // For compatibility across platforms (not in event table)
 128     void OnIdle(wxIdleEvent& WXUNUSED(event)) {}
 129
 130     // wxGTK-specific: called recursively by Enable,
 131     // to give widgets an oppprtunity to correct their colours after they
 132     // have been changed by Enable
 133     virtual void OnParentEnable( bool WXUNUSED(enable) ) {}
 134
 135     // Used by all window classes in the widget creation process.
 136     bool PreCreation( wxWindowGTK *parent, const wxPoint &pos, const wxSize &size );
 137     void PostCreation();
 138
 139     // Internal addition of child windows. differs from class
 140     // to class not by using virtual functions but by using
 141     // the m_insertCallback.
 142     void DoAddChild(wxWindowGTK *child);
 143
 144     // This methods sends wxPaintEvents to the window. It reads the
 145     // update region, breaks it up into rects and sends an event
 146     // for each rect. It is also responsible for background erase
 147     // events and NC paint events. It is called from "draw" and
 148     // "expose" handlers as well as from ::Update()
 149     void GtkSendPaintEvents();
 150
 151     // The methods below are required because many native widgets
 152     // are composed of several subwidgets and setting a style for
 153     // the widget means setting it for all subwidgets as well.
 154     // also, it is nor clear, which native widget is the top
 155     // widget where (most of) the input goes. even tooltips have
 156     // to be applied to all subwidgets.
 157     virtual GtkWidget* GetConnectWidget();
 158     virtual bool IsOwnGtkWindow( GdkWindow *window );
 159     void ConnectWidget( GtkWidget *widget );
 160
 161 #ifdef __WXGTK20__
 162     // Returns the default context which usually is anti-aliased
 163     PangoContext   *GtkGetPangoDefaultContext();
 164
 165     // Returns the X11 context which renders on the X11 client
 166     // side (which can be remote) and which usually is not
 167     // anti-aliased and is thus faster
 168     // MR: Now returns the default pango_context for the widget as GtkGetPangoDefaultContext to
 169     // not depend on libpangox - which is completely deprecated.
 170     //BCI: Remove GtkGetPangoX11Context and m_x11Context completely when symbols may be removed
 171     PangoContext   *GtkGetPangoX11Context();
 172     PangoContext   *m_x11Context; // MR: Now unused
 173 #endif
 174
 175 #if wxUSE_TOOLTIPS
 176     virtual void ApplyToolTip( GtkTooltips *tips, const wxChar *tip );
 177 #endif // wxUSE_TOOLTIPS
 178
 179     // Call after modifing the value of m_hAdjust or m_vAdjust to bring the
 180     // scrolbar in sync (this does not generate any wx events)
 181     void GtkUpdateScrollbar(int orient);
 182
 183     // Called from GTK signales handlers. it indicates that
 184     // the layouting functions have to be called later on
 185     // (i.e. in idle time, implemented in OnInternalIdle() ).
 186     void GtkUpdateSize() { m_sizeSet = FALSE; }
 187
 188     // fix up the mouse event coords, used by wxListBox only so far
 189     virtual void FixUpMouseEvent(GtkWidget * WXUNUSED(widget),
 190                                  wxCoord& WXUNUSED(x),
 191                                  wxCoord& WXUNUSED(y)) { }
 192
 193     // is this window transparent for the mouse events (as wxStaticBox is)?
 194     virtual bool IsTransparentForMouse() const { return FALSE; }
 195
 196     // is this a radiobutton (used by radiobutton code itself only)?
 197     virtual bool IsRadioButton() const { return FALSE; }
 198
 199     // position and size of the window
 200     int                  m_x, m_y;
 201     int                  m_width, m_height;
 202     int                  m_oldClientWidth,m_oldClientHeight;
 203
 204     // see the docs in src/gtk/window.cpp
 205     GtkWidget           *m_widget;          // mostly the widget seen by the rest of GTK
 206     GtkWidget           *m_wxwindow;        // mostly the client area as per wxWidgets
 207
 208     // this widget will be queried for GTK's focus events
 209     GtkWidget           *m_focusWidget;
 210
 211 #ifdef __WXGTK20__
 212     wxGtkIMData         *m_imData;
 213 #else // GTK 1
 214 #ifdef HAVE_XIM
 215     // XIM support for wxWidgets
 216     GdkIC               *m_ic;
 217     GdkICAttr           *m_icattr;
 218 #endif // HAVE_XIM
 219 #endif // GTK 2/1
 220
 221 #ifndef __WXGTK20__
 222     // The area to be cleared (and not just refreshed)
 223     // We cannot make this distinction under GTK 2.0.
 224     wxRegion             m_clearRegion;
 225 #endif
 226
 227     // scrolling stuff
 228     GtkAdjustment       *m_hAdjust,*m_vAdjust;
 229     float                m_oldHorizontalPos;
 230     float                m_oldVerticalPos;
 231
 232     // extra (wxGTK-specific) flags
 233     bool                 m_needParent:1;        // ! wxFrame, wxDialog, wxNotebookPage ?
 234     bool                 m_noExpose:1;          // wxGLCanvas has its own redrawing
 235     bool                 m_nativeSizeEvent:1;   // wxGLCanvas sends wxSizeEvent upon "alloc_size"
 236     bool                 m_hasScrolling:1;
 237     bool                 m_hasVMT:1;
 238     bool                 m_sizeSet:1;
 239     bool                 m_resizing:1;
 240     bool                 m_acceptsFocus:1;      // true if not static
 241     bool                 m_hasFocus:1;          // true if == FindFocus()
 242     bool                 m_isScrolling:1;       // dragging scrollbar thumb?
 243     bool                 m_clipPaintRegion:1;   // TRUE after ScrollWindow()
 244 #ifdef __WXGTK20__
 245     bool                 m_dirtyTabOrder:1;     // tab order changed, GTK focus
 246                                                 // chain needs update
 247 #endif
 248     bool                 m_needsStyleChange:1;  // May not be able to change
 249                                                 // background style until OnIdle
 250
 251     // C++ has no virtual methods in the constrcutor of any class but we need
 252     // different methods of inserting a child window into a wxFrame,
 253     // wxMDIFrame, wxNotebook etc. this is the callback that will get used.
 254     wxInsertChildFunction  m_insertCallback;
 255
 256     // implement the base class pure virtuals
 257     virtual void DoClientToScreen( int *x, int *y ) const;
 258     virtual void DoScreenToClient( int *x, int *y ) const;
 259     virtual void DoGetPosition( int *x, int *y ) const;
 260     virtual void DoGetSize( int *width, int *height ) const;
 261     virtual void DoGetClientSize( int *width, int *height ) const;
 262     virtual void DoSetSize(int x, int y,
 263                            int width, int height,
 264                            int sizeFlags = wxSIZE_AUTO);
 265     virtual void DoSetClientSize(int width, int height);
 266     virtual void DoMoveWindow(int x, int y, int width, int height);
 267
 268     virtual void DoCaptureMouse();
 269     virtual void DoReleaseMouse();
 270
 271 #if wxUSE_TOOLTIPS
 272     virtual void DoSetToolTip( wxToolTip *tip );
 273 #endif // wxUSE_TOOLTIPS
 274
 275 protected:
 276     // common part of all ctors (not virtual because called from ctor)
 277     void Init();
 278
 279 #ifdef __WXGTK20__
 280     virtual void DoMoveInTabOrder(wxWindow *win, MoveKind move);
 281
 282     // Copies m_children tab order to GTK focus chain:
 283     void RealizeTabOrder();
 284 #endif
 285
 286     // Called by ApplyWidgetStyle (which is called by SetFont() and
 287     // SetXXXColour etc to apply style changed to native widgets) to create
 288     // modified GTK style with non-standard attributes. If forceStyle=true,
 289     // creates empty GtkRcStyle if there are no modifications, otherwise
 290     // returns NULL in such case.
 291     GtkRcStyle *CreateWidgetStyle(bool forceStyle = false);
 292
 293     // Overridden in many GTK widgets who have to handle subwidgets
 294     virtual void ApplyWidgetStyle(bool forceStyle = false);
 295
 296     // helper function to ease native widgets wrapping, called by
 297     // ApplyWidgetStyle -- override this, not ApplyWidgetStyle
 298     virtual void DoApplyWidgetStyle(GtkRcStyle *style);
 299
 300 private:
 301     DECLARE_DYNAMIC_CLASS(wxWindowGTK)
 302     DECLARE_NO_COPY_CLASS(wxWindowGTK)
 303 };
 304
 305 extern WXDLLIMPEXP_CORE wxWindow *wxFindFocusedChild(wxWindowGTK *win);
 306
 307 #endif // __GTKWINDOWH__