Allow using wxGraphicsContext with MinGW if gdiplus.h is available.

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

diff --git a/include/wx/gtk/window.h b/include/wx/gtk/window.h
index 3d09ab6a20e452c9918ccf15730771f34f2cd274..61899838853c00ef6ccfdd9ee63891ca3cb1562f 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 );
 


@@ -84,12 +82,6 @@ public:
 
     virtual int GetCharHeight() const;
     virtual int GetCharWidth() 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)
-                               const;

 
     virtual void SetScrollbar( int orient, int pos, int thumbVisible,
                                int range, bool refresh = true );
 
     virtual void SetScrollbar( int orient, int pos, int thumbVisible,
                                int range, bool refresh = true );


@@ -98,7 +90,7 @@ public:
     virtual int GetScrollThumb( int orient ) const;
     virtual int GetScrollRange( int orient ) const;
     virtual void ScrollWindow( int dx, int dy,
     virtual int GetScrollThumb( int orient ) const;
     virtual int GetScrollRange( int orient ) const;
     virtual void ScrollWindow( int dx, int dy,

-                               const wxRect* rect = (wxRect *) NULL );
+                               const wxRect* rect = NULL );

     virtual bool ScrollLines(int lines);
     virtual bool ScrollPages(int pages);
 
     virtual bool ScrollLines(int lines);
     virtual bool ScrollPages(int pages);
 


@@ -109,34 +101,36 @@ 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);
+    virtual bool IsDoubleBuffered() const;
+

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

-    // I don't want users to override what's done in idle so everything that
-    // has to be done in idle time in order for wxGTK to work is done in
-    // OnInternalIdle
+    // many important things are done here, this function must be called
+    // regularly

     virtual void OnInternalIdle();
 
     virtual void OnInternalIdle();
 

-    // Internal represention of Update()
-    void GtkUpdate();
-

     // 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();
 

-    // Internal addition of child windows. differs from class
-    // to class not by using virtual functions but by using
-    // the m_insertCallback.
+    // Internal addition of child windows

     void DoAddChild(wxWindowGTK *child);
 
     // This methods sends wxPaintEvents to the window. It reads the
     void DoAddChild(wxWindowGTK *child);
 
     // This methods sends wxPaintEvents to the window. It reads the


@@ -153,46 +147,91 @@ 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;
+
+    // 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;
+
+
+    // 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;
+
+    // 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;
+
+    bool GTKHandleFocusIn();
+    bool GTKHandleFocusOut();
+    void GTKHandleFocusOutNoDeferring();
+    static void GTKHandleDeferredFocusOut();
+

 protected:
 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
     // 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;
+

 public:
     // Returns the default context which usually is anti-aliased
 public:
     // Returns the default context which usually is anti-aliased

-    PangoContext   *GtkGetPangoDefaultContext();
+    PangoContext   *GTKGetPangoDefaultContext();

 
 #if wxUSE_TOOLTIPS
 
 #if wxUSE_TOOLTIPS

-    virtual void ApplyToolTip( GtkTooltips *tips, const wxChar *tip );
+    // applies tooltip to the widget (tip must be UTF-8 encoded)
+    virtual void GTKApplyToolTip( 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 used in Reparent().
+    void GTKShowOnIdle() { m_showOnIdle = true; }

 
 

-    // fix up the mouse event coords, used by wxListBox only so far
-    virtual void FixUpMouseEvent(GtkWidget * WXUNUSED(widget),
-                                 wxCoord& WXUNUSED(x),
-                                 wxCoord& WXUNUSED(y)) { }
+    // This is called from the various OnInternalIdle methods
+    bool GTKShowFromOnIdle();

 
     // is this window transparent for the mouse events (as wxStaticBox is)?
 
     // is this window transparent for the mouse events (as wxStaticBox is)?

-    virtual bool IsTransparentForMouse() const { return false; }
-
-    // is this a radiobutton (used by radiobutton code itself only)?
-    virtual bool IsRadioButton() const { return false; }
+    virtual bool GTKIsTransparentForMouse() const { return false; }

 
     // Common scroll event handling code for wxWindow and wxScrollBar
 
     // Common scroll event handling code for wxWindow and wxScrollBar

-    wxEventType GetScrollEventType(GtkRange* range);
-
-    void BlockScrollEvent();
-    void UnblockScrollEvent();
+    wxEventType GTKGetScrollEventType(GtkRange* range);

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


@@ -203,42 +242,65 @@ 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;
 

+    void GTKDisableFocusOutEvent();
+    void GTKEnableFocusOutEvent();
+

     wxGtkIMData         *m_imData;
 
     wxGtkIMData         *m_imData;
 

+
+    // indices for the arrays below
+    enum ScrollDir { ScrollDir_Horz, ScrollDir_Vert, ScrollDir_Max };
+

     // horizontal/vertical scroll bar
     // horizontal/vertical scroll bar

-    GtkRange* m_scrollBar[2];
+    GtkRange* m_scrollBar[ScrollDir_Max];
+

     // horizontal/vertical scroll position
     // horizontal/vertical scroll position

-    double m_scrollPos[2];
+    double m_scrollPos[ScrollDir_Max];
+
+    // 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;
+    }
+
+    // return the orientation for the given scrolling direction
+    static int OrientFromScrollDir(ScrollDir dir)
+    {
+        return dir == ScrollDir_Horz ? wxHORIZONTAL : wxVERTICAL;
+    }
+
+    // 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_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_hasVMT:1;            // set after PostCreation() is called

     bool                 m_isScrolling:1;       // dragging scrollbar thumb?
     bool                 m_clipPaintRegion:1;   // true after ScrollWindow()
     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;

 
 

-    // 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;
+    bool                 m_showOnIdle:1;        // postpone showing the window until idle

 
 protected:
     // implement the base class pure virtuals
 
 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 DoClientToScreen( int *x, int *y ) const;
     virtual void DoScreenToClient( int *x, int *y ) const;
     virtual void DoGetPosition( int *x, int *y ) const;


@@ -249,6 +311,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 );


@@ -257,6 +320,12 @@ protected:
     virtual void DoCaptureMouse();
     virtual void DoReleaseMouse();
 
     virtual void DoCaptureMouse();
     virtual void DoReleaseMouse();
 

+    virtual void DoFreeze();
+    virtual void DoThaw();
+
+    void GTKFreezeWidget(GtkWidget *w);
+    void GTKThawWidget(GtkWidget *w);
+

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


@@ -264,7 +333,9 @@ protected:
     // common part of all ctors (not virtual because called from ctor)
     void Init();
 
     // common part of all ctors (not virtual because called from ctor)
     void Init();
 

-    virtual void DoMoveInTabOrder(wxWindow *win, MoveKind move);
+    virtual void DoMoveInTabOrder(wxWindow *win, WindowOrder 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();


@@ -274,23 +345,51 @@ protected:
     // modified GTK style with non-standard attributes. If forceStyle=true,
     // creates empty GtkRcStyle if there are no modifications, otherwise
     // returns NULL in such case.
     // modified GTK style with non-standard attributes. If forceStyle=true,
     // creates empty GtkRcStyle if there are no modifications, otherwise
     // returns NULL in such case.

-    GtkRcStyle *CreateWidgetStyle(bool forceStyle = false);
+    GtkRcStyle *GTKCreateWidgetStyle(bool forceStyle = false);

 
     // Overridden in many GTK widgets who have to handle subwidgets
 
     // Overridden in many GTK widgets who have to handle subwidgets

-    virtual void ApplyWidgetStyle(bool forceStyle = false);
+    virtual void GTKApplyWidgetStyle(bool forceStyle = false);

 
     // helper function to ease native widgets wrapping, called by
     // ApplyWidgetStyle -- override this, not ApplyWidgetStyle
     virtual void DoApplyWidgetStyle(GtkRcStyle *style);
 
     // sets the border of a given GtkScrolledWindow from a wx style
 
     // helper function to ease native widgets wrapping, called by
     // ApplyWidgetStyle -- override this, not ApplyWidgetStyle
     virtual void DoApplyWidgetStyle(GtkRcStyle *style);
 
     // sets the border of a given GtkScrolledWindow from a wx style

-    static void GtkScrolledWindowSetBorder(GtkWidget* w, int 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();
+
+    // 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.
+    gulong GTKConnectWidget(const char *signal, void (*callback)());
+
+    // Return true from here if PostCreation() should connect to size_request
+    // signal: this is done by default but doesn't work for some native
+    // controls which override this function to return false
+    virtual bool GTKShouldConnectSizeRequest() const { return !IsTopLevel(); }
+
+    void ConstrainSize();

 
 private:
 
 private:

+    enum ScrollUnit { ScrollUnit_Line, ScrollUnit_Page, ScrollUnit_Max };
+
+    // 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);
+
+

     DECLARE_DYNAMIC_CLASS(wxWindowGTK)
     DECLARE_DYNAMIC_CLASS(wxWindowGTK)

-    DECLARE_NO_COPY_CLASS(wxWindowGTK)
+    wxDECLARE_NO_COPY_CLASS(wxWindowGTK);

 };
 
 };
 

-extern WXDLLIMPEXP_CORE wxWindow *wxFindFocusedChild(wxWindowGTK *win);
-
-#endif // __GTKWINDOWH__
+#endif // _WX_GTK_WINDOW_H_