Fix wxPropertyGrid::GetPropertyRect when the last item is collapsed.

[wxWidgets.git] / include / wx / gtk / window.h

diff --git a/include/wx/gtk/window.h b/include/wx/gtk/window.h
index 8e0eeacfe75af68b553e7e4a5cfaed19bc103096..6c36ce99c1a1707e7b7aee3973fe59b41c071290 100644 (file)
--- a/include/wx/gtk/window.h
+++ b/include/wx/gtk/window.h
@@ -1,549 +1,463 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        window.h
+// Name:        wx/gtk/window.h

 // Purpose:
 // Author:      Robert Roebling
 // Purpose:
 // Author:      Robert Roebling

-// Id:          $Id$

 // Copyright:   (c) 1998 Robert Roebling
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // Copyright:   (c) 1998 Robert Roebling
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 

+#ifndef _WX_GTK_WINDOW_H_
+#define _WX_GTK_WINDOW_H_

 
 

-#ifndef __GTKWINDOWH__
-#define __GTKWINDOWH__
+#include "wx/dynarray.h"

 
 

-#ifdef __GNUG__
-    #pragma interface
+#ifdef __WXGTK3__
+    typedef struct _cairo cairo_t;
+    typedef struct _GtkStyleProvider GtkStyleProvider;
+    #define WXUNUSED_IN_GTK3(x)
+#else
+    #define WXUNUSED_IN_GTK3(x) x

 #endif
 
 #endif
 

-#include "wx/defs.h"
-#include "wx/object.h"
-#include "wx/list.h"
-#include "wx/event.h"
-#include "wx/validate.h"
-#include "wx/cursor.h"
-#include "wx/font.h"
-#include "wx/region.h"
-#include "wx/accel.h"
+typedef struct _GdkEventKey GdkEventKey;
+typedef struct _GtkIMContext GtkIMContext;

 
 

-//-----------------------------------------------------------------------------
-// global data
-//-----------------------------------------------------------------------------
+WX_DEFINE_EXPORTED_ARRAY_PTR(GdkWindow *, wxArrayGdkWindows);

 
 

-extern const char *wxFrameNameStr;
-extern wxList wxTopLevelWindows;
+extern "C"
+{

 
 

-//-----------------------------------------------------------------------------
-// global function
-//-----------------------------------------------------------------------------
+typedef void (*wxGTKCallback)();

 
 

-extern wxWindow* wxGetActiveWindow();
+}

 
 //-----------------------------------------------------------------------------
 
 //-----------------------------------------------------------------------------

-// classes
+// wxWindowGTK

 //-----------------------------------------------------------------------------
 
 //-----------------------------------------------------------------------------
 

-class wxLayoutConstraints;
-class wxSizer;
-class wxDC;
-class wxClientData;
-class wxVoidClientData;
-class wxWindow;
-#if wxUSE_WX_RESOURCES
-    class wxResourceTable;
-    class wxItemResource;
-#endif
-#if wxUSE_DRAG_AND_DROP
-    class wxDropTarget;
-#endif
-class wxToolTip;
-
-//-----------------------------------------------------------------------------
-// callback definition for inserting a window (internal)
-//-----------------------------------------------------------------------------
+class WXDLLIMPEXP_CORE wxWindowGTK : public wxWindowBase
+{
+public:
+    // creating the window
+    // -------------------
+    wxWindowGTK();
+    wxWindowGTK(wxWindow *parent,
+                wxWindowID id,
+                const wxPoint& pos = wxDefaultPosition,
+                const wxSize& size = wxDefaultSize,
+                long style = 0,
+                const wxString& name = wxPanelNameStr);
+    bool Create(wxWindow *parent,
+                wxWindowID id,
+                const wxPoint& pos = wxDefaultPosition,
+                const wxSize& size = wxDefaultSize,
+                long style = 0,
+                const wxString& name = wxPanelNameStr);
+    virtual ~wxWindowGTK();
+
+    // implement base class (pure) virtual methods
+    // -------------------------------------------

 
 

-typedef void (*wxInsertChildFunction)( wxWindow*, wxWindow* );
+    virtual void Raise();
+    virtual void Lower();

 
 

-//-----------------------------------------------------------------------------
-// global data
-//-----------------------------------------------------------------------------
+    virtual bool Show( bool show = true );

 
 

-extern const char *wxPanelNameStr;
-extern const wxSize wxDefaultSize;
-extern const wxPoint wxDefaultPosition;
+    virtual bool IsRetained() const;

 
 

-//-----------------------------------------------------------------------------
-// wxClientData
-//-----------------------------------------------------------------------------
+    virtual void SetFocus();

 
 

-class wxClientData
-{
-public:
-    wxClientData() { }
-    virtual ~wxClientData() { }
-};
+    // hint from wx to native GTK+ tab traversal code
+    virtual void SetCanFocus(bool canFocus);

 
 

-//-----------------------------------------------------------------------------
-// wxStringClientData
-//-----------------------------------------------------------------------------
+    virtual bool Reparent( wxWindowBase *newParent );

 
 

-class wxStringClientData : public wxClientData
-{
-public:
-    wxStringClientData() { }
-    wxStringClientData( wxString &data ) { m_data = data; }
-    void SetData( wxString &data ) { m_data = data; }
-    wxString GetData() const { return m_data; }
+    virtual void WarpPointer(int x, int y);

 
 

-private:
-    wxString  m_data;
-};
+    virtual void Refresh( bool eraseBackground = true,
+                          const wxRect *rect = (const wxRect *) NULL );
+    virtual void Update();
+    virtual void ClearBackground();

 
 

-//-----------------------------------------------------------------------------
-// (debug)
-//-----------------------------------------------------------------------------
+    virtual bool SetBackgroundColour( const wxColour &colour );
+    virtual bool SetForegroundColour( const wxColour &colour );
+    virtual bool SetCursor( const wxCursor &cursor );
+    virtual bool SetFont( const wxFont &font );

 
 

-#ifdef __WXDEBUG__
+    virtual bool SetBackgroundStyle(wxBackgroundStyle style) ;
+    virtual bool IsTransparentBackgroundSupported(wxString* reason = NULL) const;

 
 

-void debug_focus_in( GtkWidget* widget, const char* name, const char* window );
+    virtual int GetCharHeight() const;
+    virtual int GetCharWidth() const;

 
 

-#endif
+    virtual void SetScrollbar( int orient, int pos, int thumbVisible,
+                               int range, bool refresh = true );
+    virtual void SetScrollPos( int orient, int pos, bool refresh = true );
+    virtual int GetScrollPos( int orient ) const;
+    virtual int GetScrollThumb( int orient ) const;
+    virtual int GetScrollRange( int orient ) const;
+    virtual void ScrollWindow( int dx, int dy,
+                               const wxRect* rect = NULL );
+    virtual bool ScrollLines(int lines);
+    virtual bool ScrollPages(int pages);

 
 

-//-----------------------------------------------------------------------------
-// wxWindow
-//-----------------------------------------------------------------------------
+#if wxUSE_DRAG_AND_DROP
+    virtual void SetDropTarget( wxDropTarget *dropTarget );
+#endif // wxUSE_DRAG_AND_DROP

 
 

-class wxWindow : public wxEvtHandler
-{
-    DECLARE_DYNAMIC_CLASS(wxWindow)
+    virtual void AddChild( wxWindowBase *child );
+    virtual void RemoveChild( wxWindowBase *child );

 
 

-public:
-    // creating the window
-    // -------------------
-    wxWindow();
-    wxWindow(wxWindow *parent, wxWindowID id,
-            const wxPoint& pos = wxDefaultPosition,
-            const wxSize& size = wxDefaultSize,
-            long style = 0,
-            const wxString& name = wxPanelNameStr);
-    bool Create(wxWindow *parent, wxWindowID id,
-            const wxPoint& pos = wxDefaultPosition,
-            const wxSize& size = wxDefaultSize,
-            long style = 0,
-            const wxString& name = wxPanelNameStr);
-    virtual ~wxWindow();
-
-#if wxUSE_WX_RESOURCES
-    virtual bool LoadFromResource(wxWindow *parent,
-                                  const wxString& resourceName,
-                                  const wxResourceTable *table = (const wxResourceTable *) NULL);
-    virtual wxControl *CreateItem(const wxItemResource* childResource,
-                                  const wxItemResource* parentResource,
-                                  const wxResourceTable *table = (const wxResourceTable *) NULL);
-#endif // wxUSE_WX_RESOURCES
-
-    // closing the window
-    // ------------------
-    bool Close( bool force = FALSE );
-    virtual bool Destroy();
-    virtual bool DestroyChildren();
-
-    bool IsBeingDeleted();
-
-    // moving/resizing
-    // ---------------
-
-        // set the window size and/or position
-    void SetSize( int x, int y, int width, int height,
-                  int sizeFlags = wxSIZE_AUTO )
-        {  DoSetSize(x, y, width, height, sizeFlags); }
-
-    void SetSize( int width, int height )
-        { DoSetSize( -1, -1, width, height, wxSIZE_USE_EXISTING ); }
-
-    void SetSize( const wxSize& size )
-        { SetSize( size.x, size.y); }
-
-    void SetSize(const wxRect& rect, int sizeFlags = wxSIZE_AUTO)
-        { DoSetSize(rect.x, rect.y, rect.width, rect.height, sizeFlags); }
-
-    void Move( int x, int y )
-        { DoSetSize( x, y, -1, -1, wxSIZE_USE_EXISTING ); }
-
-    void Move(const wxPoint& pt)
-        { Move(pt.x, pt.y); }
-
-        // client size is the size of area available for subwindows
-    void SetClientSize( int width, int height )
-        { DoSetClientSize(width, height); }
-
-    void SetClientSize( const wxSize& size )
-        { DoSetClientSize(size.x, size.y); }
-
-    void SetClientSize(const wxRect& rect)
-        { SetClientSize( rect.width, rect.height ); }
-
-        // get the window position and/or size
-    virtual void GetPosition( int *x, int *y ) const;
-    wxPoint GetPosition() const
-    {
-        int w, h;
-        GetPosition(& w, & h);
+    virtual void SetLayoutDirection(wxLayoutDirection dir);
+    virtual wxLayoutDirection GetLayoutDirection() const;
+    virtual wxCoord AdjustForLayoutDirection(wxCoord x,
+                                             wxCoord width,
+                                             wxCoord widthTotal) const;

 
 

-        return wxPoint(w, h);
-    }
+    virtual bool DoIsExposed( int x, int y ) const;
+    virtual bool DoIsExposed( int x, int y, int w, int h ) const;

 
 

-    virtual void GetSize( int *width, int *height ) const;
+    // currently wxGTK2-only
+    void SetDoubleBuffered(bool on);
+    virtual bool IsDoubleBuffered() const;

 
 

-    wxSize GetSize() const
-    {
-        int w, h;
-        GetSize(& w, & h);
-        return wxSize(w, h);
-    }
+    // SetLabel(), which does nothing in wxWindow
+    virtual void SetLabel(const wxString& label) { m_gtkLabel = label; }
+    virtual wxString GetLabel() const            { return m_gtkLabel; }

 
 

-    wxRect GetRect() const
-    {
-        int x, y, w, h;
-        GetPosition(& x, & y);
-        GetSize(& w, & h);
+    // implementation
+    // --------------

 
 

-        return wxRect(x, y, w, h);
-    }
+    virtual WXWidget GetHandle() const { return m_widget; }

 
 

-    virtual void GetClientSize( int *width, int *height ) const;
-    wxSize GetClientSize() const
-    {
-        int w, h;
-        GetClientSize(& w, & h);
-        return wxSize(w, h);
-    }
+    // many important things are done here, this function must be called
+    // regularly
+    virtual void OnInternalIdle();

 
 

-        // position with respect to the the parent window
-    virtual void Centre( int direction = wxHORIZONTAL );
-    void Center(int direction = wxHORIZONTAL) { Centre(direction); }
-    virtual void Fit();
+    // For compatibility across platforms (not in event table)
+    void OnIdle(wxIdleEvent& WXUNUSED(event)) {}

 
 

-        // set min/max size of the window
-    virtual void SetSizeHints( int minW, int minH,
-                               int maxW = -1, int maxH = -1,
-                               int incW = -1, int incH = -1 );
+    // Used by all window classes in the widget creation process.
+    bool PreCreation( wxWindowGTK *parent, const wxPoint &pos, const wxSize &size );
+    void PostCreation();

 
 

-    // Dialog units translations. Implemented in wincmn.cpp.
-    // -----------------------------------------------------
+    // Internal addition of child windows
+    void DoAddChild(wxWindowGTK *child);

 
 

-    wxPoint ConvertPixelsToDialog( const wxPoint& pt );
-    wxPoint ConvertDialogToPixels( const wxPoint& pt );
-    wxSize ConvertPixelsToDialog( const wxSize& sz )
-    {
-        wxPoint pt(ConvertPixelsToDialog(wxPoint(sz.x, sz.y)));
-        
-        return wxSize(pt.x, pt.y);
-    }
+    // This method sends wxPaintEvents to the window.
+    // It is also responsible for background erase events.
+#ifdef __WXGTK3__
+    void GTKSendPaintEvents(cairo_t* cr);
+#else
+    void GTKSendPaintEvents(const GdkRegion* region);
+#endif

 
 

-    wxSize ConvertDialogToPixels( const wxSize& sz )
-    {
-        wxPoint pt(ConvertDialogToPixels(wxPoint(sz.x, sz.y)));
+    // The methods below are required because many native widgets
+    // are composed of several subwidgets and setting a style for
+    // the widget means setting it for all subwidgets as well.
+    // also, it is not clear which native widget is the top
+    // widget where (most of) the input goes. even tooltips have
+    // to be applied to all subwidgets.
+    virtual GtkWidget* GetConnectWidget();
+    void ConnectWidget( GtkWidget *widget );

 
 

-        return wxSize(pt.x, pt.y);
-    }
+    // Called from several event handlers, if it returns true or false, the
+    // same value should be immediately returned by the handler without doing
+    // anything else. If it returns -1, the handler should continue as usual
+    int GTKCallbackCommonPrologue(struct _GdkEventAny *event) const;

 
 

-    void OnSize( wxSizeEvent &event );
+    // Simplified form of GTKCallbackCommonPrologue() which can be used from
+    // GTK callbacks without return value to check if the event should be
+    // ignored: if this returns true, the event shouldn't be handled
+    bool GTKShouldIgnoreEvent() const;

 
 

-    // window state
-    // ------------

 
 

-    virtual bool Show( bool show );
-    virtual void Enable( bool enable );
-    virtual void MakeModal( bool modal );
-    virtual bool IsEnabled() const { return m_isEnabled; }
-    inline bool Enabled() const { return IsEnabled(); }
+    // override this if some events should never be consumed by wxWidgets but
+    // but have to be left for the native control
+    //
+    // base version just calls HandleWindowEvent()
+    virtual bool GTKProcessEvent(wxEvent& event) const;

 
 

-    virtual void SetFocus();
-    static wxWindow *FindFocus();
+    // Map GTK widget direction of the given widget to/from wxLayoutDirection
+    static wxLayoutDirection GTKGetLayout(GtkWidget *widget);
+    static void GTKSetLayout(GtkWidget *widget, wxLayoutDirection dir);

 
 

-    void SetReturnCode( int retCode );
-    int GetReturnCode();
+    // This is called when capture is taken from the window. It will
+    // fire off capture lost events.
+    void GTKReleaseMouseAndNotify();

 
 

-    // parent/children relations
-    // -------------------------
+    GdkWindow* GTKGetDrawingWindow() const;

 
 

-    virtual void AddChild( wxWindow *child );
-    wxList& GetChildren() { return m_children; }
+    bool GTKHandleFocusIn();
+    bool GTKHandleFocusOut();
+    void GTKHandleFocusOutNoDeferring();
+    static void GTKHandleDeferredFocusOut();

 
 

-    virtual void RemoveChild( wxWindow *child );
+    // Called when m_widget becomes realized. Derived classes must call the
+    // base class method if they override it.
+    virtual void GTKHandleRealized();
+    void GTKHandleUnrealize();

 
 

-    wxWindow *GetParent() const
-        { return m_parent; }
-    wxWindow *GetGrandParent() const
-        { return (m_parent ? m_parent->m_parent : (wxWindow*)NULL); }
-    void SetParent( wxWindow *parent )
-        { m_parent = parent; }
-    virtual wxWindow *ReParent( wxWindow *newParent );
+protected:
+    // for controls composed of multiple GTK widgets, return true to eliminate
+    // spurious focus events if the focus changes between GTK+ children within
+    // the same wxWindow
+    virtual bool GTKNeedsToFilterSameWindowFocus() const { return false; }
+
+    // Override GTKWidgetNeedsMnemonic and return true if your
+    // needs to set its mnemonic widget, such as for a
+    // GtkLabel for wxStaticText, then do the actual
+    // setting of the widget inside GTKWidgetDoSetMnemonic
+    virtual bool GTKWidgetNeedsMnemonic() const;
+    virtual void GTKWidgetDoSetMnemonic(GtkWidget* w);
+
+    // Get the GdkWindows making part of this window: usually there will be
+    // only one of them in which case it should be returned directly by this
+    // function. If there is more than one GdkWindow (can be the case for
+    // composite widgets), return NULL and fill in the provided array
+    //
+    // This is not pure virtual for backwards compatibility but almost
+    // certainly must be overridden in any wxControl-derived class!
+    virtual GdkWindow *GTKGetWindow(wxArrayGdkWindows& windows) const;
+
+    // Check if the given window makes part of this widget
+    bool GTKIsOwnWindow(GdkWindow *window) const;

 
 

-    // event handler stuff
-    // -------------------
+public:
+    // Returns the default context which usually is anti-aliased
+    PangoContext   *GTKGetPangoDefaultContext();

 
 

-    wxEvtHandler *GetEventHandler() const;
-    void SetEventHandler( wxEvtHandler *handler );
-    void PushEventHandler( wxEvtHandler *handler );
-    wxEvtHandler *PopEventHandler( bool deleteHandler = FALSE );
+#if wxUSE_TOOLTIPS
+    // applies tooltip to the widget (tip must be UTF-8 encoded)
+    virtual void GTKApplyToolTip(const char* tip);
+#endif // wxUSE_TOOLTIPS

 
 

-    // validators and client data
-    // --------------------------
+    // Called when a window should delay showing itself
+    // until idle time used in Reparent().
+    void GTKShowOnIdle() { m_showOnIdle = true; }

 
 

-    virtual void SetValidator( const wxValidator &validator );
-    virtual wxValidator *GetValidator();
+    // This is called from the various OnInternalIdle methods
+    bool GTKShowFromOnIdle();

 
 

-    virtual void SetClientObject( wxClientData *data );
-    virtual wxClientData *GetClientObject();
+    // is this window transparent for the mouse events (as wxStaticBox is)?
+    virtual bool GTKIsTransparentForMouse() const { return false; }

 
 

-    virtual void SetClientData( void *data );
-    virtual void *GetClientData();
+    // Common scroll event handling code for wxWindow and wxScrollBar
+    wxEventType GTKGetScrollEventType(GtkRange* range);

 
 

-    // accelerators
-    // ------------
-    virtual void SetAcceleratorTable( const wxAcceleratorTable& accel );
-    virtual wxAcceleratorTable *GetAcceleratorTable() { return &m_acceleratorTable; }
+    // position and size of the window
+    int                  m_x, m_y;
+    int                  m_width, m_height;
+    int m_clientWidth, m_clientHeight;
+    // Whether the client size variables above are known to be correct
+    // (because they have been validated by a size-allocate) and should
+    // be used to report client size
+    bool m_useCachedClientSize;

 
 

-    void SetId( wxWindowID id );
-    wxWindowID GetId() const;
+    // see the docs in src/gtk/window.cpp
+    GtkWidget           *m_widget;          // mostly the widget seen by the rest of GTK
+    GtkWidget           *m_wxwindow;        // mostly the client area as per wxWidgets

 
 

-    void SetCursor( const wxCursor &cursor );
+    // label for use with GetLabelSetLabel
+    wxString             m_gtkLabel;

 
 

-    virtual void PrepareDC( wxDC &dc );
+    // return true if the window is of a standard (i.e. not wxWidgets') class
+    bool IsOfStandardClass() const { return m_wxwindow == NULL; }

 
 

-    void WarpPointer(int x, int y);
+    // this widget will be queried for GTK's focus events
+    GtkWidget           *m_focusWidget;

 
 

-#if wxUSE_TOOLTIPS
-    void SetToolTip( const wxString &tip );
-    virtual void SetToolTip( wxToolTip *tip );
-    wxToolTip* GetToolTip() const { return m_toolTip; }
-#endif // wxUSE_TOOLTIPS
+    void GTKDisableFocusOutEvent();
+    void GTKEnableFocusOutEvent();

 
 

-    virtual void Refresh( bool eraseBackground = TRUE, const wxRect *rect = (const wxRect *) NULL );
-    virtual void Clear();

 
 

-    virtual wxRegion GetUpdateRegion() const;
-    virtual bool IsExposed( int x, int y ) const;
-    virtual bool IsExposed( int x, int y, int w, int h ) const;
-    virtual bool IsExposed( const wxPoint& pt ) const;
-    virtual bool IsExposed( const wxRect& rect ) const;
+    // Input method support

 
 

-    // colours
-    // -------
+    // The IM context used for generic, i.e. non-native, windows.
+    //
+    // It might be a good idea to avoid allocating it unless key events from
+    // this window are really needed but currently we do it unconditionally.
+    //
+    // For native widgets (i.e. those for which IsOfStandardClass() returns
+    // true) it is NULL.
+    GtkIMContext* m_imContext;

 
 

-    virtual wxColour GetBackgroundColour() const;
-    virtual void SetBackgroundColour( const wxColour &colour );
-    virtual wxColour GetForegroundColour() const;
-    virtual void SetForegroundColour( const wxColour &colour );
+    // Pointer to the event being currently processed by the IME or NULL if not
+    // inside key handling.
+    GdkEventKey* m_imKeyEvent;

 
 

-    // fonts
-    // -----
+    // This method generalizes gtk_im_context_filter_keypress(): for the
+    // generic windows it does just that but it's overridden by the classes
+    // wrapping native widgets that use IM themselves and so provide specific
+    // methods for accessing it such gtk_entry_im_context_filter_keypress().
+    virtual int GTKIMFilterKeypress(GdkEventKey* event) const;

 
 

-    virtual int GetCharHeight() const;
-    virtual int GetCharWidth() const;
-    virtual void GetTextExtent( const wxString& string, int *x, int *y,
-            int *descent = (int *) NULL,
-            int *externalLeading = (int *) NULL,
-            const wxFont *theFont = (const wxFont *) NULL, bool use16 = FALSE) const;
+    // This method must be called from the derived classes "insert-text" signal
+    // handlers to check if the text is not being inserted by the IM and, if
+    // this is the case, generate appropriate wxEVT_CHAR events for it.
+    //
+    // Returns true if we did generate and process events corresponding to this
+    // text or false if we didn't handle it.
+    bool GTKOnInsertText(const char* text);

 
 

-    virtual void SetFont( const wxFont &font );
-    virtual wxFont& GetFont() { return m_font; }
+    // This is just a helper of GTKOnInsertText() which is also used by GTK+
+    // "commit" signal handler.
+    bool GTKDoInsertTextFromIM(const char* text);

 
 

-    // For backward compatibility
-    virtual void SetButtonFont(const wxFont& font) { SetFont(font); }
-    virtual void SetLabelFont(const wxFont& font) { SetFont(font); }
-    virtual wxFont& GetLabelFont() { return GetFont(); };
-    virtual wxFont& GetButtonFont() { return GetFont(); };

 
 

-    virtual void SetWindowStyleFlag( long flag );
-    virtual long GetWindowStyleFlag() const;
+    // indices for the arrays below
+    enum ScrollDir { ScrollDir_Horz, ScrollDir_Vert, ScrollDir_Max };

 
 

-    virtual void CaptureMouse();
-    virtual void ReleaseMouse();
+    // horizontal/vertical scroll bar
+    GtkRange* m_scrollBar[ScrollDir_Max];

 
 

-    virtual void SetTitle( const wxString &title );
-    virtual wxString GetTitle() const;
-    virtual void SetName( const wxString &name );
-    virtual wxString GetName() const;
-    virtual wxString GetLabel() const;
+    // horizontal/vertical scroll position
+    double m_scrollPos[ScrollDir_Max];

 
 

-    void OnSysColourChanged( wxSysColourChangedEvent &WXUNUSED(event) ) { }
-    void OnKeyDown( wxKeyEvent &event );
+    // return the scroll direction index corresponding to the given orientation
+    // (which is wxVERTICAL or wxHORIZONTAL)
+    static ScrollDir ScrollDirFromOrient(int orient)
+    {
+        return orient == wxVERTICAL ? ScrollDir_Vert : ScrollDir_Horz;
+    }

 
 

-    virtual bool IsShown() const;
+    // return the orientation for the given scrolling direction
+    static int OrientFromScrollDir(ScrollDir dir)
+    {
+        return dir == ScrollDir_Horz ? wxHORIZONTAL : wxVERTICAL;
+    }

 
 

-    virtual void Raise();
-    virtual void Lower();
+    // find the direction of the given scrollbar (must be one of ours)
+    ScrollDir ScrollDirFromRange(GtkRange *range) const;

 
 

-    virtual bool IsRetained();
-    virtual wxWindow *FindWindow( long id );
-    virtual wxWindow *FindWindow( const wxString& name );
+    // set the current cursor for all GdkWindows making part of this widget
+    // (see GTKGetWindow)
+    void GTKUpdateCursor(bool update_self = true, bool recurse = true);

 
 

-    void AllowDoubleClick( bool WXUNUSED(allow) ) { }
-    void SetDoubleClick( bool WXUNUSED(allow) ) { }
+    // extra (wxGTK-specific) flags
+    bool                 m_noExpose:1;          // wxGLCanvas has its own redrawing
+    bool                 m_nativeSizeEvent:1;   // wxGLCanvas sends wxSizeEvent upon "alloc_size"
+    bool                 m_isScrolling:1;       // dragging scrollbar thumb?
+    bool                 m_clipPaintRegion:1;   // true after ScrollWindow()
+    wxRegion             m_nativeUpdateRegion;  // not transformed for RTL
+    bool                 m_dirtyTabOrder:1;     // tab order changed, GTK focus
+                                                // chain needs update
+    bool                 m_mouseButtonDown:1;

 
 

-    virtual void ClientToScreen( int *x, int *y );
-    virtual void ScreenToClient( int *x, int *y );
+    bool                 m_showOnIdle:1;        // postpone showing the window until idle

 
 

-    virtual bool Validate();
-    virtual bool TransferDataToWindow();
-    virtual bool TransferDataFromWindow();
-    void OnInitDialog( wxInitDialogEvent &event );
-    virtual void InitDialog();
+protected:
+    // implement the base class pure virtuals
+    virtual void DoGetTextExtent(const wxString& string,
+                                 int *x, int *y,
+                                 int *descent = NULL,
+                                 int *externalLeading = NULL,
+                                 const wxFont *font = NULL) const;
+    virtual void DoClientToScreen( int *x, int *y ) const;
+    virtual void DoScreenToClient( int *x, int *y ) const;
+    virtual void DoGetPosition( int *x, int *y ) const;
+    virtual void DoGetSize( int *width, int *height ) const;
+    virtual void DoGetClientSize( int *width, int *height ) const;
+    virtual void DoSetSize(int x, int y,
+                           int width, int height,
+                           int sizeFlags = wxSIZE_AUTO);
+    virtual void DoSetClientSize(int width, int height);
+    virtual wxSize DoGetBorderSize() const;
+    virtual void DoMoveWindow(int x, int y, int width, int height);
+    virtual void DoEnable(bool enable);

 
 

-    virtual bool PopupMenu( wxMenu *menu, int x, int y );
+#if wxUSE_MENUS_NATIVE
+    virtual bool DoPopupMenu( wxMenu *menu, int x, int y );
+#endif // wxUSE_MENUS_NATIVE

 
 

-#if wxUSE_DRAG_AND_DROP
-    virtual void SetDropTarget( wxDropTarget *dropTarget );
-    virtual wxDropTarget *GetDropTarget() const;
-#endif
+    virtual void DoCaptureMouse();
+    virtual void DoReleaseMouse();

 
 

-    virtual void SetScrollbar( int orient, int pos, int thumbVisible,
-            int range, bool refresh = TRUE );
-    virtual void SetScrollPos( int orient, int pos, bool refresh = TRUE );
-    virtual int GetScrollPos( int orient ) const;
-    virtual int GetScrollThumb( int orient ) const;
-    virtual int GetScrollRange( int orient ) const;
-    virtual void ScrollWindow( int dx, int dy, const wxRect* rect = (wxRect *) NULL );
+    virtual void DoFreeze();
+    virtual void DoThaw();

 
 

-    virtual bool AcceptsFocus() const;
+    void GTKFreezeWidget(GtkWidget *w);
+    void GTKThawWidget(GtkWidget *w);
+    void GTKDisconnect(void* instance);

 
 

-    void UpdateWindowUI();
+#if wxUSE_TOOLTIPS
+    virtual void DoSetToolTip( wxToolTip *tip );
+#endif // wxUSE_TOOLTIPS

 
 

-    // implementation
+    // Create a GtkScrolledWindow containing the given widget (usually
+    // m_wxwindow but not necessarily) and assigns it to m_widget. Also shows
+    // the widget passed to it.
+    //
+    // Can be only called if we have either wxHSCROLL or wxVSCROLL in our
+    // style.
+    void GTKCreateScrolledWindowWith(GtkWidget* view);

 
 

-    virtual wxPoint GetClientAreaOrigin() const;
-    virtual void AdjustForParentClientOrigin( int& x, int& y, int sizeFlags );
+    virtual void DoMoveInTabOrder(wxWindow *win, WindowOrder move);
+    virtual bool DoNavigateIn(int flags);

 
 

-    bool HasVMT();

 
 

-    virtual void OnInternalIdle();
+    // Copies m_children tab order to GTK focus chain:
+    void RealizeTabOrder();

 
 

-    /* used by all classes in the widget creation process */
+#ifndef __WXGTK3__
+    // Called by ApplyWidgetStyle (which is called by SetFont() and
+    // SetXXXColour etc to apply style changed to native widgets) to create
+    // modified GTK style with non-standard attributes.
+    GtkRcStyle* GTKCreateWidgetStyle();
+#endif

 
 

-    void PreCreation( wxWindow *parent, wxWindowID id, const wxPoint &pos,
-            const wxSize &size, long style, const wxString &name );
-    void PostCreation();
+    void GTKApplyWidgetStyle(bool forceStyle = false);

 
 

-    /* the methods below are required because many native widgets
-       are composed of several subwidgets and setting a style for
-       the widget means setting it for all subwidgets as well.
-       also, it is nor clear, which native widget is the top
-       widget where (most of) the input goes. even tooltips have
-       to be applied to all subwidgets. */
+    // helper function to ease native widgets wrapping, called by
+    // ApplyWidgetStyle -- override this, not ApplyWidgetStyle
+    virtual void DoApplyWidgetStyle(GtkRcStyle *style);

 
 

-    virtual GtkWidget* GetConnectWidget();
-    virtual bool IsOwnGtkWindow( GdkWindow *window );
-    void ConnectWidget( GtkWidget *widget );
+    void GTKApplyStyle(GtkWidget* widget, GtkRcStyle* style);

 
 

-    GtkStyle *GetWidgetStyle();
-    void SetWidgetStyle();
-    virtual void ApplyWidgetStyle();
+    // sets the border of a given GtkScrolledWindow from a wx style
+    static void GTKScrolledWindowSetBorder(GtkWidget* w, int style);

 
 

-#if wxUSE_TOOLTIPS
-    virtual void ApplyToolTip( GtkTooltips *tips, const char *tip );
-#endif // wxUSE_TOOLTIPS
+    // Connect the given function to the specified signal on m_widget.
+    //
+    // This is just a wrapper for g_signal_connect() and returns the handler id
+    // just as it does.
+    unsigned long GTKConnectWidget(const char *signal, wxGTKCallback callback);

 
 

-    /* private member variables */
-
-    wxWindow            *m_parent;
-    wxList               m_children;
-    int                  m_x,m_y;
-    int                  m_width,m_height;
-    int                  m_minWidth,m_minHeight;
-    int                  m_maxWidth,m_maxHeight;
-    int                  m_retCode;
-    wxEvtHandler        *m_eventHandler;
-    wxValidator         *m_windowValidator;
-#if wxUSE_DRAG_AND_DROP
-    wxDropTarget        *m_dropTarget;
-#endif
-    wxWindowID           m_windowId;
-    wxCursor            *m_cursor;
-    wxFont               m_font;
-    wxColour             m_backgroundColour;
-    wxColour             m_foregroundColour;
-    wxRegion             m_updateRegion;
-    long                 m_windowStyle;
-    bool                 m_isShown;
-    bool                 m_isEnabled;
-    wxString             m_windowName;
-    wxAcceleratorTable   m_acceleratorTable;
-    wxClientData        *m_clientObject;
-    void                *m_clientData;
+    void ConstrainSize();

 
 

-#if wxUSE_TOOLTIPS
-    wxToolTip           *m_toolTip;
-#endif // wxUSE_TOOLTIPS
+private:
+    void Init();

 
 

-    GtkWidget           *m_widget;
-    GtkWidget           *m_wxwindow;
-    GtkAdjustment       *m_hAdjust,*m_vAdjust;
-    float                m_oldHorizontalPos;
-    float                m_oldVerticalPos;
-    bool                 m_needParent;
-    bool                 m_hasScrolling;
-    bool                 m_isScrolling;
-    bool                 m_hasVMT;
-    bool                 m_sizeSet;
-    bool                 m_resizing;
-    GdkGC               *m_scrollGC;
-    GtkStyle            *m_widgetStyle;
-    bool                 m_isStaticBox;
-    bool                 m_acceptsFocus;
-
-    wxInsertChildFunction  m_insertCallback;
+    // return true if this window must have a non-NULL parent, false if it can
+    // be created without parent (normally only top level windows but in wxGTK
+    // there is also the exception of wxMenuBar)
+    virtual bool GTKNeedsParent() const { return !IsTopLevel(); }

 
 

-public:
+    enum ScrollUnit { ScrollUnit_Line, ScrollUnit_Page, ScrollUnit_Max };

 
 

-    wxLayoutConstraints *m_constraints;
-    wxList              *m_constraintsInvolvedIn;
-    wxSizer             *m_windowSizer;
-    wxWindow            *m_sizerParent;
-    bool                 m_autoLayout;
-
-    wxLayoutConstraints *GetConstraints() const;
-    void SetConstraints( wxLayoutConstraints *constraints );
-    void SetAutoLayout( bool autoLayout );
-    bool GetAutoLayout() const;
-    bool Layout();
-    void SetSizer( wxSizer *sizer );
-    wxSizer *GetSizer() const;
-    void SetSizerParent( wxWindow *win );
-    wxWindow *GetSizerParent() const;
-    void UnsetConstraints(wxLayoutConstraints *c);
-    inline wxList *GetConstraintsInvolvedIn() const ;
-    void AddConstraintReference(wxWindow *otherWin);
-    void RemoveConstraintReference(wxWindow *otherWin);
-    void DeleteRelatedConstraints();
-    virtual void ResetConstraints();
-    virtual void SetConstraintSizes(bool recurse = TRUE);
-    virtual bool LayoutPhase1(int *noChanges);
-    virtual bool LayoutPhase2(int *noChanges);
-    virtual bool DoPhase(int);
-    virtual void TransformSizerToActual(int *x, int *y) const ;
-    virtual void SizerSetSize(int x, int y, int w, int h);
-    virtual void SizerMove(int x, int y);
-    virtual void SetSizeConstraint(int x, int y, int w, int h);
-    virtual void MoveConstraint(int x, int y);
-    virtual void GetSizeConstraint(int *w, int *h) const ;
-    virtual void GetClientSizeConstraint(int *w, int *h) const ;
-    virtual void GetPositionConstraint(int *x, int *y) const ;
+    // common part of ScrollLines() and ScrollPages() and could be used, in the
+    // future, for horizontal scrolling as well
+    //
+    // return true if we scrolled, false otherwise (on error or simply if we
+    // are already at the end)
+    bool DoScrollByUnits(ScrollDir dir, ScrollUnit unit, int units);
+    virtual void AddChildGTK(wxWindowGTK* child);

 
 

-protected:
-    // this is the virtual function to be overriden in any derived class which
-    // wants to change how SetSize() or Move() works - it is called by all
-    // versions of these functions in the base class
-    virtual void DoSetSize(int x, int y,
-                           int width, int height,
-                           int sizeFlags = wxSIZE_AUTO);
+#ifdef __WXGTK3__
+    // paint context is stashed here so wxPaintDC can use it
+    cairo_t* m_paintContext;
+    // style provider for "background-image"
+    GtkStyleProvider* m_styleProvider;

 
 

-    // same as DoSetSize() for the client size
-    virtual void DoSetClientSize(int width, int height);
+public:
+    cairo_t* GTKPaintContext() const
+    {
+        return m_paintContext;
+    }
+#endif

 
 

-private:
-    DECLARE_EVENT_TABLE()
+    DECLARE_DYNAMIC_CLASS(wxWindowGTK)
+    wxDECLARE_NO_COPY_CLASS(wxWindowGTK);

 };
 
 };
 

-#endif // __GTKWINDOWH__
+#endif // _WX_GTK_WINDOW_H_