forward port from 2.8

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

diff --git a/include/wx/gtk/window.h b/include/wx/gtk/window.h
index fb02d8304f1993c8346a5a8afc4a166ff487ad79..3becd7bb5c01ed8b2efb05c309f55d6e63afc8c7 100644 (file)
--- a/include/wx/gtk/window.h
+++ b/include/wx/gtk/window.h
@@ -7,19 +7,16 @@
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 

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

 
 // helper structure that holds class that holds GtkIMContext object and
 // some additional data needed for key events processing
 struct wxGtkIMData;
 
 
 // helper structure that holds class that holds GtkIMContext object and
 // some additional data needed for key events processing
 struct wxGtkIMData;
 

-//-----------------------------------------------------------------------------
-// callback definition for inserting a window (internal)
-//-----------------------------------------------------------------------------
-
-class WXDLLIMPEXP_CORE wxWindowGTK;
-typedef void (*wxInsertChildFunction)( wxWindowGTK*, wxWindowGTK* );
+WX_DEFINE_EXPORTED_ARRAY_PTR(GdkWindow *, wxArrayGdkWindows);

 
 //-----------------------------------------------------------------------------
 // wxWindowGTK
 
 //-----------------------------------------------------------------------------
 // wxWindowGTK


@@ -57,14 +54,15 @@ public:
     virtual void Lower();
 
     virtual bool Show( bool show = true );
     virtual void Lower();
 
     virtual bool Show( bool show = true );

-    virtual bool Enable( bool enable = true );

 
     virtual void SetWindowStyleFlag( long style );
 
     virtual bool IsRetained() const;
 
     virtual void SetFocus();
 
     virtual void SetWindowStyleFlag( long style );
 
     virtual bool IsRetained() const;
 
     virtual void SetFocus();

-    virtual bool AcceptsFocus() const;
+
+    // hint from wx to native GTK+ tab traversal code
+    virtual void SetCanFocus(bool canFocus);

 
     virtual bool Reparent( wxWindowBase *newParent );
 
 
     virtual bool Reparent( wxWindowBase *newParent );
 


@@ -109,14 +107,26 @@ public:
     virtual void AddChild( wxWindowBase *child );
     virtual void RemoveChild( wxWindowBase *child );
 
     virtual void AddChild( wxWindowBase *child );
     virtual void RemoveChild( wxWindowBase *child );
 

+    virtual void SetLayoutDirection(wxLayoutDirection dir);
+    virtual wxLayoutDirection GetLayoutDirection() const;
+    virtual wxCoord AdjustForLayoutDirection(wxCoord x,
+                                             wxCoord width,
+                                             wxCoord widthTotal) const;
+
+    virtual bool DoIsExposed( int x, int y ) const;
+    virtual bool DoIsExposed( int x, int y, int w, int h ) const;
+

     // currently wxGTK2-only
     void SetDoubleBuffered(bool on);
     // currently wxGTK2-only
     void SetDoubleBuffered(bool on);

+    virtual bool IsDoubleBuffered() const;

 
     // implementation
     // --------------
 
     virtual WXWidget GetHandle() const { return m_widget; }
 
 
     // implementation
     // --------------
 
     virtual WXWidget GetHandle() const { return m_widget; }
 

+    // many important things are done here, this function must be called
+    // regularly

     virtual void OnInternalIdle();
 
     // Internal represention of Update()
     virtual void OnInternalIdle();
 
     // Internal represention of Update()


@@ -125,11 +135,6 @@ public:
     // For compatibility across platforms (not in event table)
     void OnIdle(wxIdleEvent& WXUNUSED(event)) {}
 
     // For compatibility across platforms (not in event table)
     void OnIdle(wxIdleEvent& WXUNUSED(event)) {}
 

-    // wxGTK-specific: called recursively by Enable,
-    // to give widgets an opportunity to correct their colours after they
-    // have been changed by Enable
-    virtual void OnParentEnable( bool WXUNUSED(enable) ) {}
-

     // Used by all window classes in the widget creation process.
     bool PreCreation( wxWindowGTK *parent, const wxPoint &pos, const wxSize &size );
     void PostCreation();
     // Used by all window classes in the widget creation process.
     bool PreCreation( wxWindowGTK *parent, const wxPoint &pos, const wxSize &size );
     void PostCreation();


@@ -153,36 +158,74 @@ public:
     // widget where (most of) the input goes. even tooltips have
     // to be applied to all subwidgets.
     virtual GtkWidget* GetConnectWidget();
     // widget where (most of) the input goes. even tooltips have
     // to be applied to all subwidgets.
     virtual GtkWidget* GetConnectWidget();

-    virtual bool IsOwnGtkWindow( GdkWindow *window );

     void ConnectWidget( GtkWidget *widget );
 
     void ConnectWidget( GtkWidget *widget );
 

+    // 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;
+
+    // override this if some events should never be consumed by wxWidgets but
+    // but have to be left for the native control
+    //
+    // base version just does GetEventHandler()->ProcessEvent()
+    virtual bool GTKProcessEvent(wxEvent& event) const;
+
+    // Map GTK widget direction of the given widget to/from wxLayoutDirection
+    static wxLayoutDirection GTKGetLayout(GtkWidget *widget);
+    static void GTKSetLayout(GtkWidget *widget, wxLayoutDirection dir);
+
+    // 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(); }
+
+    // This is called when capture is taken from the window. It will 
+    // fire off capture lost events.
+    void GTKReleaseMouseAndNotify();
+
+    GdkWindow* GTKGetDrawingWindow() const;
+

 protected:
     // Override GTKWidgetNeedsMnemonic and return true if your
 protected:
     // Override GTKWidgetNeedsMnemonic and return true if your

-    // needs to set its mnemonic widget, such as for a 
+    // 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);
 
     // 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;
+
+    // Set the focus to this window if its setting was delayed because the
+    // widget hadn't been realized when SetFocus() was called
+    //
+    // Return true if focus was set to us, false if nothing was done
+    bool GTKSetDelayedFocusIfNeeded();
+

 public:
     // Returns the default context which usually is anti-aliased
     PangoContext   *GtkGetPangoDefaultContext();
 
 #if wxUSE_TOOLTIPS
 public:
     // Returns the default context which usually is anti-aliased
     PangoContext   *GtkGetPangoDefaultContext();
 
 #if wxUSE_TOOLTIPS

-    virtual void ApplyToolTip( GtkTooltips *tips, const wxChar *tip );
+    // applies tooltip to the widget (tip must be UTF-8 encoded)
+    virtual void ApplyToolTip( GtkTooltips *tips, const gchar *tip );

 #endif // wxUSE_TOOLTIPS
 
 #endif // wxUSE_TOOLTIPS
 

-    // Called from GTK signal handlers. it indicates that
-    // the layouting functions have to be called later on
-    // (i.e. in idle time, implemented in OnInternalIdle() ).
-    void GtkUpdateSize() { m_sizeSet = false; }
-    
-    

     // Called when a window should delay showing itself
     // until idle time. This partly mimmicks defered
     // sizing under MSW.
     void GtkShowOnIdle() { m_showOnIdle = true; }
     // Called when a window should delay showing itself
     // until idle time. This partly mimmicks defered
     // sizing under MSW.
     void GtkShowOnIdle() { m_showOnIdle = true; }

-    
+

     // This is called from the various OnInternalIdle methods
     bool GtkShowFromOnIdle();
 
     // This is called from the various OnInternalIdle methods
     bool GtkShowFromOnIdle();
 


@@ -200,9 +243,6 @@ public:
     // Common scroll event handling code for wxWindow and wxScrollBar
     wxEventType GetScrollEventType(GtkRange* range);
 
     // Common scroll event handling code for wxWindow and wxScrollBar
     wxEventType GetScrollEventType(GtkRange* range);
 

-    void BlockScrollEvent();
-    void UnblockScrollEvent();
-

     // position and size of the window
     int                  m_x, m_y;
     int                  m_width, m_height;
     // position and size of the window
     int                  m_x, m_y;
     int                  m_width, m_height;


@@ -212,6 +252,9 @@ public:
     GtkWidget           *m_widget;          // mostly the widget seen by the rest of GTK
     GtkWidget           *m_wxwindow;        // mostly the client area as per wxWidgets
 
     GtkWidget           *m_widget;          // mostly the widget seen by the rest of GTK
     GtkWidget           *m_wxwindow;        // mostly the client area as per wxWidgets
 

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

     // this widget will be queried for GTK's focus events
     GtkWidget           *m_focusWidget;
 
     // this widget will be queried for GTK's focus events
     GtkWidget           *m_focusWidget;
 


@@ -227,10 +270,6 @@ public:
     // horizontal/vertical scroll position
     double m_scrollPos[ScrollDir_Max];
 
     // horizontal/vertical scroll position
     double m_scrollPos[ScrollDir_Max];
 

-    // if true, don't notify about adjustment change (without resetting the
-    // flag, so this has to be done manually)
-    bool m_blockValueChanged[ScrollDir_Max];
-

     // return the scroll direction index corresponding to the given orientation
     // (which is wxVERTICAL or wxHORIZONTAL)
     static ScrollDir ScrollDirFromOrient(int orient)
     // return the scroll direction index corresponding to the given orientation
     // (which is wxVERTICAL or wxHORIZONTAL)
     static ScrollDir ScrollDirFromOrient(int orient)


@@ -247,34 +286,30 @@ public:
     // find the direction of the given scrollbar (must be one of ours)
     ScrollDir ScrollDirFromRange(GtkRange *range) const;
 
     // find the direction of the given scrollbar (must be one of ours)
     ScrollDir ScrollDirFromRange(GtkRange *range) const;
 

-

     // extra (wxGTK-specific) flags
     // extra (wxGTK-specific) flags

-    bool                 m_needParent:1;        // ! wxFrame, wxDialog, wxNotebookPage ?

     bool                 m_noExpose:1;          // wxGLCanvas has its own redrawing
     bool                 m_nativeSizeEvent:1;   // wxGLCanvas sends wxSizeEvent upon "alloc_size"
     bool                 m_hasScrolling:1;
     bool                 m_hasVMT:1;
     bool                 m_noExpose:1;          // wxGLCanvas has its own redrawing
     bool                 m_nativeSizeEvent:1;   // wxGLCanvas sends wxSizeEvent upon "alloc_size"
     bool                 m_hasScrolling:1;
     bool                 m_hasVMT:1;

-    bool                 m_sizeSet:1;
-    bool                 m_resizing:1;
-    bool                 m_acceptsFocus:1;      // true if not static

     bool                 m_hasFocus:1;          // true if == FindFocus()
     bool                 m_isScrolling:1;       // dragging scrollbar thumb?
     bool                 m_clipPaintRegion:1;   // true after ScrollWindow()
     bool                 m_hasFocus:1;          // true if == FindFocus()
     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_needsStyleChange:1;  // May not be able to change
                                                 // background style until OnIdle
     bool                 m_mouseButtonDown:1;
     bool                 m_dirtyTabOrder:1;     // tab order changed, GTK focus
                                                 // chain needs update
     bool                 m_needsStyleChange:1;  // May not be able to change
                                                 // background style until OnIdle
     bool                 m_mouseButtonDown:1;

-    bool                 m_blockScrollEvent:1;
-    
+

     bool                 m_showOnIdle:1;        // postpone showing the window until idle
 
     bool                 m_showOnIdle:1;        // postpone showing the window until idle
 

+protected:

     // C++ has no virtual methods in the constrcutor of any class but we need
     // different methods of inserting a child window into a wxFrame,
     // wxMDIFrame, wxNotebook etc. this is the callback that will get used.
     // C++ has no virtual methods in the constrcutor of any class but we need
     // different methods of inserting a child window into a wxFrame,
     // wxMDIFrame, wxNotebook etc. this is the callback that will get used.

-    wxInsertChildFunction  m_insertCallback;
+    typedef void (*InsertChildFunction)(wxWindowGTK*, wxWindowGTK*);
+    InsertChildFunction m_insertCallback;

 
 

-protected:

     // implement the base class pure virtuals
     virtual void DoClientToScreen( int *x, int *y ) const;
     virtual void DoScreenToClient( int *x, int *y ) const;
     // implement the base class pure virtuals
     virtual void DoClientToScreen( int *x, int *y ) const;
     virtual void DoScreenToClient( int *x, int *y ) const;


@@ -286,6 +321,7 @@ protected:
                            int sizeFlags = wxSIZE_AUTO);
     virtual void DoSetClientSize(int width, int height);
     virtual void DoMoveWindow(int x, int y, int width, int height);
                            int sizeFlags = wxSIZE_AUTO);
     virtual void DoSetClientSize(int width, int height);
     virtual void DoMoveWindow(int x, int y, int width, int height);

+    virtual void DoEnable(bool enable);

 
 #if wxUSE_MENUS_NATIVE
     virtual bool DoPopupMenu( wxMenu *menu, int x, int y );
 
 #if wxUSE_MENUS_NATIVE
     virtual bool DoPopupMenu( wxMenu *menu, int x, int y );


@@ -302,6 +338,8 @@ protected:
     void Init();
 
     virtual void DoMoveInTabOrder(wxWindow *win, MoveKind move);
     void Init();
 
     virtual void DoMoveInTabOrder(wxWindow *win, MoveKind move);

+    virtual bool DoNavigateIn(int flags);
+

 
     // Copies m_children tab order to GTK focus chain:
     void RealizeTabOrder();
 
     // Copies m_children tab order to GTK focus chain:
     void RealizeTabOrder();


@@ -323,6 +361,14 @@ protected:
     // sets the border of a given GtkScrolledWindow from a wx style
     static void GtkScrolledWindowSetBorder(GtkWidget* w, int style);
 
     // sets the border of a given GtkScrolledWindow from a wx style
     static void GtkScrolledWindowSetBorder(GtkWidget* w, int style);
 

+    // set the current cursor for all GdkWindows making part of this widget
+    // (see GTKGetWindow)
+    //
+    // should be called from OnInternalIdle() if it's overridden
+    void GTKUpdateCursor();
+
+    void ConstrainSize();
+

 private:
     enum ScrollUnit { ScrollUnit_Line, ScrollUnit_Page, ScrollUnit_Max };
 
 private:
     enum ScrollUnit { ScrollUnit_Line, ScrollUnit_Page, ScrollUnit_Max };
 


@@ -340,4 +386,4 @@ private:
 
 extern WXDLLIMPEXP_CORE wxWindow *wxFindFocusedChild(wxWindowGTK *win);
 
 
 extern WXDLLIMPEXP_CORE wxWindow *wxFindFocusedChild(wxWindowGTK *win);
 

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