remove unused variable assignment, closes #14928

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

diff --git a/include/wx/gtk/window.h b/include/wx/gtk/window.h
index 5d751165ecf24b8643141ef35c6bb9bdf45f4856..4e4185787bfdd7f92b43bf6e17386bd420f7aa36 100644 (file)
--- a/include/wx/gtk/window.h
+++ b/include/wx/gtk/window.h
@@ -12,12 +12,27 @@
 
 #include "wx/dynarray.h"
 
 
 #include "wx/dynarray.h"
 

+#ifdef __WXGTK3__
+    typedef struct _cairo cairo_t;
+    typedef struct _GtkStyleProvider GtkStyleProvider;
+    #define WXUNUSED_IN_GTK3(x)
+#else
+    #define WXUNUSED_IN_GTK3(x) x
+#endif
+

 // helper structure that holds class that holds GtkIMContext object and
 // some additional data needed for key events processing
 struct wxGtkIMData;
 
 WX_DEFINE_EXPORTED_ARRAY_PTR(GdkWindow *, wxArrayGdkWindows);
 
 // helper structure that holds class that holds GtkIMContext object and
 // some additional data needed for key events processing
 struct wxGtkIMData;
 
 WX_DEFINE_EXPORTED_ARRAY_PTR(GdkWindow *, wxArrayGdkWindows);
 

+extern "C"
+{
+
+typedef void (*wxGTKCallback)();
+
+}
+

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


@@ -45,18 +60,11 @@ public:
     // implement base class (pure) virtual methods
     // -------------------------------------------
 
     // implement base class (pure) virtual methods
     // -------------------------------------------
 

-    virtual void SetLabel(const wxString& WXUNUSED(label)) { }
-    virtual wxString GetLabel() const { return wxEmptyString; }
-
-    virtual bool Destroy();
-

     virtual void Raise();
     virtual void Lower();
 
     virtual bool Show( bool show = true );
 
     virtual void Raise();
     virtual void Lower();
 
     virtual bool Show( bool show = true );
 

-    virtual void SetWindowStyleFlag( long style );
-

     virtual bool IsRetained() const;
 
     virtual void SetFocus();
     virtual bool IsRetained() const;
 
     virtual void SetFocus();


@@ -79,15 +87,10 @@ public:
     virtual bool SetFont( const wxFont &font );
 
     virtual bool SetBackgroundStyle(wxBackgroundStyle style) ;
     virtual bool SetFont( const wxFont &font );
 
     virtual bool SetBackgroundStyle(wxBackgroundStyle style) ;

+    virtual bool IsTransparentBackgroundSupported(wxString* reason = NULL) const;

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


@@ -96,7 +99,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);
 


@@ -120,6 +123,10 @@ public:
     void SetDoubleBuffered(bool on);
     virtual bool IsDoubleBuffered() const;
 
     void SetDoubleBuffered(bool on);
     virtual bool IsDoubleBuffered() const;
 

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

     // implementation
     // --------------
 
     // implementation
     // --------------
 


@@ -129,9 +136,6 @@ public:
     // regularly
     virtual void OnInternalIdle();
 
     // regularly
     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)) {}
 


@@ -139,17 +143,16 @@ public:
     bool PreCreation( wxWindowGTK *parent, const wxPoint &pos, const wxSize &size );
     void PostCreation();
 
     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);
 
     void DoAddChild(wxWindowGTK *child);
 

-    // This methods sends wxPaintEvents to the window. It reads the
-    // update region, breaks it up into rects and sends an event
-    // for each rect. It is also responsible for background erase
-    // events and NC paint events. It is called from "draw" and
-    // "expose" handlers as well as from ::Update()
-    void GtkSendPaintEvents();
+    // 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

 
     // The methods below are required because many native widgets
     // are composed of several subwidgets and setting a style for
 
     // The methods below are required because many native widgets
     // are composed of several subwidgets and setting a style for


@@ -165,10 +168,16 @@ public:
     // anything else. If it returns -1, the handler should continue as usual
     int GTKCallbackCommonPrologue(struct _GdkEventAny *event) const;
 
     // 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
     //
     // 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()
+    // base version just calls HandleWindowEvent()

     virtual bool GTKProcessEvent(wxEvent& event) const;
 
     // Map GTK widget direction of the given widget to/from wxLayoutDirection
     virtual bool GTKProcessEvent(wxEvent& event) const;
 
     // Map GTK widget direction of the given widget to/from wxLayoutDirection


@@ -180,13 +189,28 @@ public:
     // there is also the exception of wxMenuBar)
     virtual bool GTKNeedsParent() const { return !IsTopLevel(); }
 
     // 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 
+    // This is called when capture is taken from the window. It will

     // fire off capture lost events.
     void GTKReleaseMouseAndNotify();
 
     GdkWindow* GTKGetDrawingWindow() const;
 
     // fire off capture lost events.
     void GTKReleaseMouseAndNotify();
 
     GdkWindow* GTKGetDrawingWindow() const;
 

+    bool GTKHandleFocusIn();
+    bool GTKHandleFocusOut();
+    void GTKHandleFocusOutNoDeferring();
+    static void GTKHandleDeferredFocusOut();
+
+    // Called when m_widget becomes realized. Derived classes must call the
+    // base class method if they override it.
+    virtual void GTKHandleRealized();
+    void GTKHandleUnrealize();
+

 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
     // needs to set its mnemonic widget, such as for a
     // GtkLabel for wxStaticText, then do the actual
     // Override GTKWidgetNeedsMnemonic and return true if your
     // needs to set its mnemonic widget, such as for a
     // GtkLabel for wxStaticText, then do the actual


@@ -206,60 +230,54 @@ protected:
     // Check if the given window makes part of this widget
     bool GTKIsOwnWindow(GdkWindow *window) 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
 public:
     // Returns the default context which usually is anti-aliased

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

 
 #if wxUSE_TOOLTIPS
     // applies tooltip to the widget (tip must be UTF-8 encoded)
 
 #if wxUSE_TOOLTIPS
     // applies tooltip to the widget (tip must be UTF-8 encoded)

-    virtual void ApplyToolTip( GtkTooltips *tips, const gchar *tip );
+    virtual void GTKApplyToolTip(const char* tip);

 #endif // wxUSE_TOOLTIPS
 
     // Called when a window should delay showing itself
 #endif // wxUSE_TOOLTIPS
 
     // Called when a window should delay showing itself

-    // until idle time. This partly mimmicks defered
-    // sizing under MSW.
-    void GtkShowOnIdle() { m_showOnIdle = true; }
+    // until idle time used in Reparent().
+    void GTKShowOnIdle() { m_showOnIdle = true; }

 
     // This is called from the various OnInternalIdle methods
 
     // This is called from the various OnInternalIdle methods

-    bool GtkShowFromOnIdle();
-
-    // fix up the mouse event coords, used by wxListBox only so far
-    virtual void FixUpMouseEvent(GtkWidget * WXUNUSED(widget),
-                                 wxCoord& WXUNUSED(x),
-                                 wxCoord& WXUNUSED(y)) { }
+    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);
+    wxEventType GTKGetScrollEventType(GtkRange* range);

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

-    int                  m_oldClientWidth,m_oldClientHeight;
+    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;

 
     // 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
 
 
     // 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
 

+    // label for use with GetLabelSetLabel
+    wxString             m_gtkLabel;
+

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

-    wxGtkIMData         *m_imData;
+    void GTKDisableFocusOutEvent();
+    void GTKEnableFocusOutEvent();

 
 

+    wxGtkIMData         *m_imData;

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


@@ -286,12 +304,13 @@ 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;
 

+    // set the current cursor for all GdkWindows making part of this widget
+    // (see GTKGetWindow)
+    void GTKUpdateCursor(bool update_self = true, bool recurse = true);
+

     // extra (wxGTK-specific) flags
     bool                 m_noExpose:1;          // wxGLCanvas has its own redrawing
     bool                 m_nativeSizeEvent:1;   // wxGLCanvas sends wxSizeEvent upon "alloc_size"
     // 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_hasScrolling:1;
-    bool                 m_hasVMT:1;
-    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_isScrolling:1;       // dragging scrollbar thumb?
     bool                 m_clipPaintRegion:1;   // true after ScrollWindow()
     wxRegion             m_nativeUpdateRegion;  // not transformed for RTL


@@ -304,13 +323,12 @@ public:
     bool                 m_showOnIdle:1;        // postpone showing the window until idle
 
 protected:
     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.
-    typedef void (*InsertChildFunction)(wxWindowGTK*, wxWindowGTK*);
-    InsertChildFunction m_insertCallback;
-

     // implement the base class pure virtuals
     // 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;


@@ -320,6 +338,7 @@ protected:
                            int width, int height,
                            int sizeFlags = wxSIZE_AUTO);
     virtual void DoSetClientSize(int width, int height);
                            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 void DoMoveWindow(int x, int y, int width, int height);
     virtual void DoEnable(bool enable);
 


@@ -330,12 +349,24 @@ 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);
+    void GTKDisconnect(void* instance);
+

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

-    // common part of all ctors (not virtual because called from ctor)
-    void Init();
+    // 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 void DoMoveInTabOrder(wxWindow *win, WindowOrder move);
     virtual bool DoNavigateIn(int flags);
 
     virtual void DoMoveInTabOrder(wxWindow *win, WindowOrder move);
     virtual bool DoNavigateIn(int flags);


@@ -344,32 +375,35 @@ protected:
     // Copies m_children tab order to GTK focus chain:
     void RealizeTabOrder();
 
     // Copies m_children tab order to GTK focus chain:
     void RealizeTabOrder();
 

+#ifndef __WXGTK3__

     // Called by ApplyWidgetStyle (which is called by SetFont() and
     // SetXXXColour etc to apply style changed to native widgets) to create
     // 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. If forceStyle=true,
-    // creates empty GtkRcStyle if there are no modifications, otherwise
-    // returns NULL in such case.
-    GtkRcStyle *CreateWidgetStyle(bool forceStyle = false);
+    // modified GTK style with non-standard attributes.
+    GtkRcStyle* GTKCreateWidgetStyle();
+#endif

 
 

-    // Overridden in many GTK widgets who have to handle subwidgets
-    virtual void ApplyWidgetStyle(bool forceStyle = false);
+    void GTKApplyWidgetStyle(bool forceStyle = false);

 
     // helper function to ease native widgets wrapping, called by
     // ApplyWidgetStyle -- override this, not ApplyWidgetStyle
     virtual void DoApplyWidgetStyle(GtkRcStyle *style);
 
 
     // helper function to ease native widgets wrapping, called by
     // ApplyWidgetStyle -- override this, not ApplyWidgetStyle
     virtual void DoApplyWidgetStyle(GtkRcStyle *style);
 

+    void GTKApplyStyle(GtkWidget* widget, GtkRcStyle* style);
+

     // sets the border of a given GtkScrolledWindow from a wx 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)
+    // Connect the given function to the specified signal on m_widget.

     //
     //

-    // should be called from OnInternalIdle() if it's overridden
-    void GTKUpdateCursor();
+    // 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);

 
     void ConstrainSize();
 
 private:
 
     void ConstrainSize();
 
 private:

+    void Init();
+

     enum ScrollUnit { ScrollUnit_Line, ScrollUnit_Page, ScrollUnit_Max };
 
     // common part of ScrollLines() and ScrollPages() and could be used, in the
     enum ScrollUnit { ScrollUnit_Line, ScrollUnit_Page, ScrollUnit_Max };
 
     // common part of ScrollLines() and ScrollPages() and could be used, in the


@@ -378,12 +412,23 @@ private:
     // 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);
     // 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);

 
 

+#ifdef __WXGTK3__
+    // paint context is stashed here so wxPaintDC can use it
+    cairo_t* m_paintContext;
+    // style provider for "background-image"
+    GtkStyleProvider* m_styleProvider;
+
+public:
+    cairo_t* GTKPaintContext() const
+    {
+        return m_paintContext;
+    }
+#endif

 
     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 // _WX_GTK_WINDOW_H_
 #endif // _WX_GTK_WINDOW_H_