X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/60e4975cb874a245d7cddae20c6b3f3db9668021..51623cc53f350935337e57930eaaf1afe9a48c3b:/include/wx/gtk/window.h diff --git a/include/wx/gtk/window.h b/include/wx/gtk/window.h index 9118c6b3b9..4e4185787b 100644 --- a/include/wx/gtk/window.h +++ b/include/wx/gtk/window.h @@ -7,24 +7,31 @@ // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// +#ifndef _WX_GTK_WINDOW_H_ +#define _WX_GTK_WINDOW_H_ -#ifndef __GTKWINDOWH__ -#define __GTKWINDOWH__ +#include "wx/dynarray.h" -#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) - #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 // 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) -//----------------------------------------------------------------------------- +WX_DEFINE_EXPORTED_ARRAY_PTR(GdkWindow *, wxArrayGdkWindows); + +extern "C" +{ + +typedef void (*wxGTKCallback)(); -class WXDLLIMPEXP_CORE wxWindowGTK; -typedef void (*wxInsertChildFunction)( wxWindowGTK*, wxWindowGTK* ); +} //----------------------------------------------------------------------------- // wxWindowGTK @@ -53,24 +60,23 @@ public: // implement base class (pure) virtual methods // ------------------------------------------- - virtual bool Destroy(); - virtual void Raise(); virtual void Lower(); - virtual bool Show( bool show = TRUE ); - virtual bool Enable( bool enable = TRUE ); + virtual bool Show( bool show = true ); 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 void WarpPointer(int x, int y); - virtual void Refresh( bool eraseBackground = TRUE, + virtual void Refresh( bool eraseBackground = true, const wxRect *rect = (const wxRect *) NULL ); virtual void Update(); virtual void ClearBackground(); @@ -81,177 +87,248 @@ public: 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 void GetTextExtent(const wxString& string, - int *x, int *y, - int *descent = (int *) NULL, - int *externalLeading = (int *) NULL, - const wxFont *theFont = (const wxFont *) NULL) - const; - -#if wxUSE_MENUS_NATIVE - virtual bool DoPopupMenu( wxMenu *menu, int x, int y ); -#endif // wxUSE_MENUS_NATIVE virtual void SetScrollbar( int orient, int pos, int thumbVisible, - int range, bool refresh = TRUE ); - virtual void SetScrollPos( int orient, int pos, bool refresh = TRUE ); + 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 ); + const wxRect* rect = NULL ); + virtual bool ScrollLines(int lines); + virtual bool ScrollPages(int pages); #if wxUSE_DRAG_AND_DROP virtual void SetDropTarget( wxDropTarget *dropTarget ); #endif // wxUSE_DRAG_AND_DROP -#ifdef __WXGTK20__ virtual void AddChild( wxWindowBase *child ); virtual void RemoveChild( wxWindowBase *child ); -#endif + + 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; + + // SetLabel(), which does nothing in wxWindow + virtual void SetLabel(const wxString& label) { m_gtkLabel = label; } + virtual wxString GetLabel() const { return m_gtkLabel; } // 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(); - // Internal represention of Update() - void GtkUpdate(); - // For compatibility across platforms (not in event table) void OnIdle(wxIdleEvent& WXUNUSED(event)) {} - // wxGTK-specific: called recursively by Enable, - // to give widgets an oppprtunity 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(); - // 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 - // 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 widget means setting it for all subwidgets as well. - // also, it is nor clear, which native widget is the top + // 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(); - virtual bool IsOwnGtkWindow( GdkWindow *window ); void ConnectWidget( GtkWidget *widget ); -#ifdef __WXGTK20__ + // 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(); + + // Called when m_widget becomes realized. Derived classes must call the + // base class method if they override it. + virtual void GTKHandleRealized(); + void GTKHandleUnrealize(); + +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; + +public: // Returns the default context which usually is anti-aliased - PangoContext *GtkGetPangoDefaultContext(); - - // Returns the X11 context which renders on the X11 client - // side (which can be remote) and which usually is not - // anti-aliased and is thus faster - // MR: Now returns the default pango_context for the widget as GtkGetPangoDefaultContext to - // not depend on libpangox - which is completely deprecated. - //BCI: Remove GtkGetPangoX11Context and m_x11Context completely when symbols may be removed - PangoContext *GtkGetPangoX11Context(); - PangoContext *m_x11Context; // MR: Now unused -#endif + 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 GTKApplyToolTip(const char* tip); #endif // wxUSE_TOOLTIPS - // Called from GTK signales 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)? - virtual bool IsTransparentForMouse() const { return FALSE; } + virtual bool GTKIsTransparentForMouse() const { return false; } - // is this a radiobutton (used by radiobutton code itself only)? - virtual bool IsRadioButton() const { return FALSE; } + // Common scroll event handling code for wxWindow and wxScrollBar + wxEventType GTKGetScrollEventType(GtkRange* range); // 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 + // 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; -#ifdef __WXGTK20__ + void GTKDisableFocusOutEvent(); + void GTKEnableFocusOutEvent(); + wxGtkIMData *m_imData; -#else // GTK 1 -#ifdef HAVE_XIM - // XIM support for wxWidgets - GdkIC *m_ic; - GdkICAttr *m_icattr; -#endif // HAVE_XIM -#endif // GTK 2/1 - -#ifndef __WXGTK20__ - // The area to be cleared (and not just refreshed) - // We cannot make this distinction under GTK 2.0. - wxRegion m_clearRegion; -#endif - // scrolling stuff - GtkAdjustment *m_hAdjust,*m_vAdjust; - float m_oldHorizontalPos; - float m_oldVerticalPos; + // indices for the arrays below + enum ScrollDir { ScrollDir_Horz, ScrollDir_Vert, ScrollDir_Max }; + + // horizontal/vertical scroll bar + GtkRange* m_scrollBar[ScrollDir_Max]; + + // horizontal/vertical scroll position + 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; + + // 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_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_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() -#ifdef __WXGTK20__ + 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 -#endif bool m_needsStyleChange:1; // May not be able to change // background style until OnIdle + bool m_mouseButtonDown: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 + 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; @@ -261,45 +338,97 @@ public: 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); + +#if wxUSE_MENUS_NATIVE + virtual bool DoPopupMenu( wxMenu *menu, int x, int y ); +#endif // wxUSE_MENUS_NATIVE 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 -protected: - // 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); -#ifdef __WXGTK20__ - virtual void DoMoveInTabOrder(wxWindow *win, MoveKind move); // Copies m_children tab order to GTK focus chain: void RealizeTabOrder(); -#endif +#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. 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 + // 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 + static void GTKScrolledWindowSetBorder(GtkWidget* w, int style); + + // 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); + + 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 + // 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); + +#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_NO_COPY_CLASS(wxWindowGTK) + wxDECLARE_NO_COPY_CLASS(wxWindowGTK); }; -extern WXDLLIMPEXP_CORE wxWindow *wxFindFocusedChild(wxWindowGTK *win); - -#endif // __GTKWINDOWH__ +#endif // _WX_GTK_WINDOW_H_