/////////////////////////////////////////////////////////////////////////////
-// Name: window.h
+// Name: wx/gtk/window.h
// Purpose:
// Author: Robert Roebling
-// Created: 01/02/97
-// Id:
-// Copyright: (c) 1998 Robert Roebling, Julian Smart and Markus Holzem
-// Licence: wxWindows licence
+// Id: $Id$
+// 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
-#endif
+// helper structure that holds class that holds GtkIMContext object and
+// some additional data needed for key events processing
+struct wxGtkIMData;
-#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/dc.h"
-#include "wx/region.h"
-#include "wx/dnd.h"
+WX_DEFINE_EXPORTED_ARRAY_PTR(GdkWindow *, wxArrayGdkWindows);
//-----------------------------------------------------------------------------
-// global data
+// wxWindowGTK
//-----------------------------------------------------------------------------
-extern const char *wxFrameNameStr;
-extern wxList wxTopLevelWindows;
+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();
-//-----------------------------------------------------------------------------
-// classes
-//-----------------------------------------------------------------------------
+ // implement base class (pure) virtual methods
+ // -------------------------------------------
-class wxLayoutConstraints;
-class wxSizer;
+ virtual void SetLabel(const wxString& WXUNUSED(label)) { }
+ virtual wxString GetLabel() const { return wxEmptyString; }
-class wxWindow;
-class wxCanvas;
+ virtual bool Destroy();
-//-----------------------------------------------------------------------------
-// global data
-//-----------------------------------------------------------------------------
+ virtual void Raise();
+ virtual void Lower();
-extern const char *wxPanelNameStr;
-extern const wxSize wxDefaultSize;
-extern const wxPoint wxDefaultPosition;
+ virtual bool Show( bool show = true );
-//-----------------------------------------------------------------------------
-// wxWindow
-//-----------------------------------------------------------------------------
+ virtual void SetWindowStyleFlag( long style );
+
+ virtual bool IsRetained() const;
+
+ virtual void SetFocus();
+
+ // 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,
+ const wxRect *rect = (const wxRect *) NULL );
+ virtual void Update();
+ virtual void ClearBackground();
+
+ virtual bool SetBackgroundColour( const wxColour &colour );
+ virtual bool SetForegroundColour( const wxColour &colour );
+ virtual bool SetCursor( const wxCursor &cursor );
+ virtual bool SetFont( const wxFont &font );
+
+ virtual bool SetBackgroundStyle(wxBackgroundStyle style) ;
+
+ virtual int GetCharHeight() const;
+ virtual int GetCharWidth() const;
-class wxWindow: public wxEvtHandler
-{
- DECLARE_DYNAMIC_CLASS(wxWindow)
-
- public:
-
- wxWindow(void);
- 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(void);
- bool Close( bool force = FALSE );
- virtual bool Destroy(void);
- virtual bool DestroyChildren(void);
-
- virtual void PrepareDC( wxDC &dc );
-
- virtual void SetSize( int x, int y, int width, int height,
- int sizeFlags = wxSIZE_AUTO );
- virtual void SetSize( int width, int height );
- virtual void Move( int x, int y );
- virtual void GetSize( int *width, int *height ) const;
- virtual void SetClientSize( int const width, int const height );
- virtual void GetClientSize( int *width, int *height ) const;
- virtual void GetPosition( int *x, int *y ) const;
- virtual void Centre( int direction = wxHORIZONTAL );
- virtual void Fit(void);
-
- void OnSize( wxSizeEvent &event );
-
- virtual bool Show( bool show );
- virtual void Enable( bool enable );
- virtual void MakeModal( bool modal );
- virtual bool IsEnabled(void) const { return m_isEnabled; };
- virtual void SetFocus(void);
- virtual bool OnClose(void);
-
- virtual void AddChild( wxWindow *child );
- wxList *GetChildren(void);
- virtual void RemoveChild( wxWindow *child );
- void SetReturnCode( int retCode );
- int GetReturnCode(void);
- wxWindow *GetParent(void);
-
- wxEvtHandler *GetEventHandler(void);
- void SetEventhandler( wxEvtHandler *handler );
-
- virtual wxValidator *GetValidator(void);
- virtual void SetValidator( wxValidator *validator );
-
- bool IsBeingDeleted(void);
-
- void SetId( wxWindowID id );
- wxWindowID GetId(void);
-
- void SetCursor( const wxCursor &cursor );
-
- virtual void Refresh( bool eraseBackground = TRUE, const wxRect *rect = NULL );
- virtual void Clear(void);
- virtual bool IsExposed( long x, long y );
- virtual bool IsExposed( long x, long y, long width, long height );
-
- virtual wxColour GetBackgroundColour(void) const;
- virtual void SetBackgroundColour( const wxColour &colour );
-
- virtual void SetDefaultBackgroundColour( const wxColour& col )
- { m_defaultBackgroundColour = col; };
- virtual wxColour GetDefaultBackgroundColour(void) const
- { return m_defaultBackgroundColour; };
- virtual void SetDefaultForegroundColour( const wxColour& col )
- { m_defaultForegroundColour = col; };
- virtual wxColour GetDefaultForegroundColour(void) const
- { return m_defaultForegroundColour; };
-
- virtual void SetFont( const wxFont &font );
- virtual wxFont *GetFont(void);
- // For backward compatibility
- inline virtual void SetButtonFont(const wxFont& font) { SetFont(font); }
- inline virtual void SetLabelFont(const wxFont& font) { SetFont(font); }
- inline virtual wxFont *GetLabelFont(void) { return GetFont(); };
- inline virtual wxFont *GetButtonFont(void) { return GetFont(); };
- virtual void SetWindowStyleFlag( long flag );
- virtual long GetWindowStyleFlag(void) const;
- virtual void CaptureMouse(void);
- virtual void ReleaseMouse(void);
- virtual void SetTitle( const wxString &title );
- virtual wxString GetTitle(void) const;
- virtual void SetName( const wxString &name );
- virtual wxString GetName(void) const;
- virtual wxString GetLabel(void) const;
-
- void OnSysColourChanged( wxSysColourChangedEvent &WXUNUSED(event) ) {};
-
- virtual bool IsShown(void);
- virtual bool IsRetained(void);
- virtual wxWindow *FindWindow( long id );
- virtual wxWindow *FindWindow( const wxString& name );
- void AllowDoubleClick( bool WXUNUSED(allow) ) {};
- void SetDoubleClick( bool WXUNUSED(allow) ) {};
- virtual void ClientToScreen( int *x, int *y );
- virtual void ScreenToClient( int *x, int *y );
-
- virtual bool Validate(void);
- virtual bool TransferDataToWindow(void);
- virtual bool TransferDataFromWindow(void);
- void OnInitDialog( wxInitDialogEvent &event );
- virtual void InitDialog(void);
-
- virtual void SetDropTarget( wxDropTarget *dropTarget );
- virtual wxDropTarget *GetDropTarget() const;
-
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 = NULL );
-
- public: // cannot get private going yet
-
- void PreCreation( wxWindow *parent, wxWindowID id, const wxPoint &pos,
- const wxSize &size, long style, const wxString &name );
- void PostCreation(void);
- bool HasVMT(void);
- virtual void ImplementSetSize(void);
- virtual void ImplementSetPosition(void);
- void GetDrawingOffset( long *x, long *y );
-
- wxWindow *m_parent;
- wxList m_children;
- int m_x,m_y;
- int m_width,m_height;
- int m_retCode;
- wxEvtHandler *m_eventHandler;
- wxValidator *m_windowValidator;
- wxDropTarget *m_pDropTarget;
- wxWindowID m_windowId;
- wxCursor *m_cursor;
- wxFont m_font;
- wxColour m_backgroundColour;
- wxColour m_defaultBackgroundColour;
- wxColour m_foregroundColour ;
- wxColour m_defaultForegroundColour;
- wxRegion m_updateRegion;
- long m_windowStyle;
- bool m_isShown;
- bool m_isEnabled;
- wxString m_windowName;
- long m_drawingOffsetX,m_drawingOffsetY;
-
- 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_hasVMT;
- bool m_sizeSet;
-
- public: // Layout section
-
- wxLayoutConstraints * m_constraints;
- wxList * m_constraintsInvolvedIn;
- wxSizer * m_windowSizer;
- wxWindow * m_sizerParent;
- bool m_autoLayout;
-
- wxLayoutConstraints *GetConstraints(void) const;
- void SetConstraints( wxLayoutConstraints *constraints );
- void SetAutoLayout( bool autoLayout );
- bool GetAutoLayout(void) const;
- bool Layout(void);
- void SetSizer( wxSizer *sizer );
- wxSizer *GetSizer(void) const;
- void SetSizerParent( wxWindow *win );
- wxWindow *GetSizerParent(void) const;
- void UnsetConstraints(wxLayoutConstraints *c);
- inline wxList *GetConstraintsInvolvedIn(void) const ;
- void AddConstraintReference(wxWindow *otherWin);
- void RemoveConstraintReference(wxWindow *otherWin);
- void DeleteRelatedConstraints(void);
- virtual void ResetConstraints(void);
- 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 ;
-
- DECLARE_EVENT_TABLE()
+ virtual void ScrollWindow( int dx, int dy,
+ 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
+
+ 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; }
+
+ // many important things are done here, this function must be called
+ // regularly
+ virtual void OnInternalIdle();
+
+ // For compatibility across platforms (not in event table)
+ void OnIdle(wxIdleEvent& WXUNUSED(event)) {}
+
+ // 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
+ 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();
+
+ // 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 );
+
+ // 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:
+ // 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();
+
+#if wxUSE_TOOLTIPS
+ // applies tooltip to the widget (tip must be UTF-8 encoded)
+ virtual void GTKApplyToolTip( GtkTooltips *tips, const gchar *tip );
+#endif // wxUSE_TOOLTIPS
+
+ // Called when a window should delay showing itself
+ // until idle time used in Reparent().
+ void GTKShowOnIdle() { m_showOnIdle = true; }
+
+ // This is called from the various OnInternalIdle methods
+ bool GTKShowFromOnIdle();
+
+ // is this window transparent for the mouse events (as wxStaticBox is)?
+ virtual bool GTKIsTransparentForMouse() 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;
+
+ // 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
+
+ // 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;
+
+ void GTKDisableFocusOutEvent();
+ void GTKEnableFocusOutEvent();
+
+ wxGtkIMData *m_imData;
+
+
+ // 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;
+
+ // 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_hasVMT:1; // set after PostCreation() is called
+ 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_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;
+ 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 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();
+
+ static void GTKFreezeWidget(GtkWidget *w);
+ static void GTKThawWidget(GtkWidget *w);
+
+#if wxUSE_TOOLTIPS
+ virtual void DoSetToolTip( wxToolTip *tip );
+#endif // wxUSE_TOOLTIPS
+
+ // common part of all ctors (not virtual because called from ctor)
+ void Init();
+
+ virtual void DoMoveInTabOrder(wxWindow *win, WindowOrder move);
+ virtual bool DoNavigateIn(int flags);
+
+
+ // Copies m_children tab order to GTK focus chain:
+ void RealizeTabOrder();
+
+ // 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 *GTKCreateWidgetStyle(bool forceStyle = false);
+
+ // Overridden in many GTK widgets who have to handle subwidgets
+ 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
+ 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 };
+
+ // 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)
+ wxDECLARE_NO_COPY_CLASS(wxWindowGTK);
};
-#endif // __GTKWINDOWH__
+#endif // _WX_GTK_WINDOW_H_
projects / wxWidgets.git / blobdiff