/////////////////////////////////////////////////////////////////////////////
-// Name: window.h
+// Name: wx/gtk/window.h
// Purpose:
// Author: Robert Roebling
// Id: $Id$
#ifndef __GTKWINDOWH__
#define __GTKWINDOWH__
-#ifdef __GNUG__
-#pragma interface
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
+ #pragma interface
#endif
-#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"
-#include "wx/accel.h"
-
-//-----------------------------------------------------------------------------
-// global data
-//-----------------------------------------------------------------------------
-
-extern const char *wxFrameNameStr;
-extern wxList wxTopLevelWindows;
-
-//-----------------------------------------------------------------------------
-// classes
-//-----------------------------------------------------------------------------
-
-class wxLayoutConstraints;
-class wxSizer;
-class wxResourceTable;
-class wxItemResource;
-
-class wxClientData;
-class wxVoidClientData;
-class wxWindow;
+// 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)
//-----------------------------------------------------------------------------
-typedef void (*wxInsertChildFunction)( wxWindow*, wxWindow* );
-
-//-----------------------------------------------------------------------------
-// global data
-//-----------------------------------------------------------------------------
-
-extern const char *wxPanelNameStr;
-extern const wxSize wxDefaultSize;
-extern const wxPoint wxDefaultPosition;
+class wxWindowGTK;
+typedef void (*wxInsertChildFunction)( wxWindowGTK*, wxWindowGTK* );
//-----------------------------------------------------------------------------
-// wxClientData
+// wxWindowGTK
//-----------------------------------------------------------------------------
-class wxClientData
+class wxWindowGTK : public wxWindowBase
{
public:
- wxClientData() { }
- virtual ~wxClientData() { }
-};
+ // 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();
+
+ // 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 IsRetained() const;
+
+ virtual void SetFocus();
+ virtual bool AcceptsFocus() const;
+
+ 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;
+ 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 );
+ 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 );
+
+#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
-//-----------------------------------------------------------------------------
-// wxStringClientData
-//-----------------------------------------------------------------------------
+ // implementation
+ // --------------
-class wxStringClientData: public wxClientData
-{
-public:
- wxStringClientData() { }
- wxStringClientData( wxString &data ) { m_data = data; }
- void SetData( wxString &data ) { m_data = data; }
- wxString GetData() const { return m_data; }
+ 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
+ virtual void OnInternalIdle();
+
+ // Internal represention of Update()
+ void GtkUpdate();
-private:
- wxString m_data;
-};
+ // 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.
+ 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 nor 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__
+ // 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
+ PangoContext *GtkGetPangoX11Context();
+ PangoContext *m_x11Context;
+#endif
-//-----------------------------------------------------------------------------
-// wxWindow
-//-----------------------------------------------------------------------------
+#if wxUSE_TOOLTIPS
+ virtual void ApplyToolTip( GtkTooltips *tips, const wxChar *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; }
+
+ // fix up the mouse event coords, used by wxListBox only so far
+ virtual void FixUpMouseEvent(GtkWidget * WXUNUSED(widget),
+ wxCoord& WXUNUSED(x),
+ wxCoord& WXUNUSED(y)) { }
+
+ // 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; }
+
+ // 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
+
+ // this widget will be queried for GTK's focus events
+ GtkWidget *m_focusWidget;
+
+#ifdef __WXGTK20__
+ wxGtkIMData *m_imData;
+#else
+#if HAVE_XIM && !defined(__WXGTK20__)
+ // XIM support for wxWidgets
+ GdkIC *m_ic;
+ GdkICAttr *m_icattr;
+#endif
+#endif
-class wxWindow: public wxEvtHandler
-{
- DECLARE_DYNAMIC_CLASS(wxWindow)
-
-public:
- wxWindow();
- 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();
-
- virtual bool LoadFromResource( wxWindow *parent, const wxString& resourceName,
- const wxResourceTable *table = (const wxResourceTable *) NULL);
- virtual wxControl *CreateItem(const wxItemResource* childResource, const wxItemResource* parentResource,
- const wxResourceTable *table = (const wxResourceTable *) NULL);
-
- bool Close( bool force = FALSE );
- virtual bool Destroy();
- virtual bool DestroyChildren();
-
- 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 );
- inline void Center(int direction = wxHORIZONTAL) { Centre(direction); }
- virtual void Fit();
-
- virtual void SetSizeHints( int minW, int minH, int maxW = -1, int maxH = -1, int incW = -1, int incH = -1 );
-
- // Dialog units translations. Implemented in wincmn.cpp.
- wxPoint ConvertPixelsToDialog(const wxPoint& pt) ;
- wxPoint ConvertDialogToPixels(const wxPoint& pt) ;
- inline wxSize ConvertPixelsToDialog(const wxSize& sz)
- { wxPoint pt(ConvertPixelsToDialog(wxPoint(sz.x, sz.y))); return wxSize(pt.x, pt.y); }
- inline wxSize ConvertDialogToPixels(const wxSize& sz)
- { wxPoint pt(ConvertDialogToPixels(wxPoint(sz.x, sz.y))); return wxSize(pt.x, pt.y); }
-
- void OnSize( wxSizeEvent &event );
- void OnIdle( wxIdleEvent& event );
-
- virtual bool Show( bool show );
- virtual void Enable( bool enable );
- virtual void MakeModal( bool modal );
- virtual bool IsEnabled() const { return m_isEnabled; }
- inline bool Enabled() const { return IsEnabled(); }
- virtual void SetFocus();
- virtual bool OnClose();
-
- virtual void AddChild( wxWindow *child );
- wxList *GetChildren();
- virtual void RemoveChild( wxWindow *child );
- void SetReturnCode( int retCode );
- int GetReturnCode();
- wxWindow *GetParent() const
- { return m_parent; }
- wxWindow *GetGrandParent() const
- { return (m_parent ? m_parent->m_parent : (wxWindow*)NULL); }
- void SetParent( wxWindow *p )
- { m_parent = p; }
-
- wxEvtHandler *GetEventHandler();
- void SetEventHandler( wxEvtHandler *handler );
- void PushEventHandler( wxEvtHandler *handler );
- wxEvtHandler *PopEventHandler( bool deleteHandler = FALSE );
-
- virtual wxValidator *GetValidator();
- virtual void SetValidator( const wxValidator &validator );
-
- virtual void SetClientObject( wxClientData *data );
- virtual wxClientData *GetClientObject();
+#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;
+
+ // 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_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
+
+ // 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;
+
+ // implement the base class pure virtuals
+ 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 DoCaptureMouse();
+ virtual void DoReleaseMouse();
- virtual void SetClientData( void *data );
- virtual void *GetClientData();
-
- virtual void SetAcceleratorTable( const wxAcceleratorTable& accel );
- virtual wxAcceleratorTable *GetAcceleratorTable() { return &m_acceleratorTable; }
-
- bool IsBeingDeleted();
-
- void SetId( wxWindowID id );
- wxWindowID GetId();
-
- void SetCursor( const wxCursor &cursor );
-
- virtual void Refresh( bool eraseBackground = TRUE, const wxRect *rect = (const wxRect *) NULL );
- virtual void Clear();
-
- virtual wxRegion GetUpdateRegion() const;
- virtual bool IsExposed(int x, int y) const;
- virtual bool IsExposed(int x, int y, int w, int h) const;
- virtual bool IsExposed(const wxPoint& pt) const;
- virtual bool IsExposed(const wxRect& rect) const;
-
- virtual wxColour GetBackgroundColour() const;
- virtual void SetBackgroundColour( const wxColour &colour );
- virtual wxColour GetForegroundColour() const;
- virtual void SetForegroundColour( const wxColour &colour );
-
- 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, bool use16 = FALSE) const;
-
- virtual void SetFont( const wxFont &font );
- virtual wxFont *GetFont();
-
- // 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() { return GetFont(); };
- inline virtual wxFont *GetButtonFont() { return GetFont(); };
-
- virtual void SetWindowStyleFlag( long flag );
- virtual long GetWindowStyleFlag() const;
-
- virtual void CaptureMouse();
- virtual void ReleaseMouse();
-
- virtual void SetTitle( const wxString &title );
- virtual wxString GetTitle() const;
- virtual void SetName( const wxString &name );
- virtual wxString GetName() const;
- virtual wxString GetLabel() const;
-
- void OnSysColourChanged( wxSysColourChangedEvent &WXUNUSED(event) ) {};
-
- virtual bool IsShown() const;
-
- virtual void Raise();
- virtual void Lower();
-
- virtual bool IsRetained();
- 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();
- virtual bool TransferDataToWindow();
- virtual bool TransferDataFromWindow();
- void OnInitDialog( wxInitDialogEvent &event );
- virtual void InitDialog();
-
- virtual bool PopupMenu( wxMenu *menu, int x, int y );
-
- 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 );
- 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 );
-
- virtual bool AcceptsFocus() const;
-
- void UpdateWindowUI();
-
- // implementation
-
- void PreCreation( wxWindow *parent, wxWindowID id, const wxPoint &pos,
- const wxSize &size, long style, const wxString &name );
- void PostCreation();
- virtual GtkWidget *GetConnectWidget();
- virtual bool IsOwnGtkWindow( GdkWindow *window );
- void ConnectWidget( GtkWidget *widget );
- void ConnectDnDWidget( GtkWidget *widget );
- void DisconnectDnDWidget( GtkWidget *widget );
-
- bool HasVMT();
-
- virtual void ImplementSetSize();
- virtual void ImplementSetPosition();
-
- virtual wxPoint GetClientAreaOrigin() const;
- virtual void AdjustForParentClientOrigin( int& x, int& y, int sizeFlags );
-
- GtkStyle *GetWidgetStyle();
- void SetWidgetStyle();
- virtual void ApplyWidgetStyle();
-
-
- wxWindow *m_parent;
- wxList m_children;
- int m_x,m_y;
- int m_width,m_height;
- int m_minWidth,m_minHeight;
- int m_maxWidth,m_maxHeight;
- int m_retCode;
- wxEvtHandler *m_eventHandler;
- wxValidator *m_windowValidator;
- wxDropTarget *m_dropTarget;
- wxWindowID m_windowId;
- wxCursor *m_cursor;
- wxFont m_font;
- wxColour m_backgroundColour;
- wxColour m_foregroundColour ;
- wxRegion m_updateRegion;
- long m_windowStyle;
- bool m_isShown;
- bool m_isEnabled;
- wxString m_windowName;
- wxAcceleratorTable m_acceleratorTable;
- wxClientData *m_clientObject;
- void *m_clientData;
-
- 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_isScrolling;
- bool m_hasVMT;
- bool m_sizeSet;
- bool m_resizing;
- GdkGC *m_scrollGC;
- GtkStyle *m_widgetStyle;
-
- wxInsertChildFunction m_insertCallback;
+#if wxUSE_TOOLTIPS
+ virtual void DoSetToolTip( wxToolTip *tip );
+#endif // wxUSE_TOOLTIPS
-public:
+protected:
+ // common part of all ctors (not virtual because called from ctor)
+ void Init();
+
+#ifdef __WXGTK20__
+ virtual void DoMoveInTabOrder(wxWindow *win, MoveKind move);
- wxLayoutConstraints *m_constraints;
- wxList *m_constraintsInvolvedIn;
- wxSizer *m_windowSizer;
- wxWindow *m_sizerParent;
- bool m_autoLayout;
-
- wxLayoutConstraints *GetConstraints() const;
- void SetConstraints( wxLayoutConstraints *constraints );
- void SetAutoLayout( bool autoLayout );
- bool GetAutoLayout() const;
- bool Layout();
- void SetSizer( wxSizer *sizer );
- wxSizer *GetSizer() const;
- void SetSizerParent( wxWindow *win );
- wxWindow *GetSizerParent() const;
- void UnsetConstraints(wxLayoutConstraints *c);
- inline wxList *GetConstraintsInvolvedIn() const ;
- void AddConstraintReference(wxWindow *otherWin);
- void RemoveConstraintReference(wxWindow *otherWin);
- void DeleteRelatedConstraints();
- virtual void ResetConstraints();
- 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 ;
+ // Copies m_children tab order to GTK focus chain:
+ void RealizeTabOrder();
+#endif
+
+ // 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);
+
+ // Overridden in many GTK widgets who have to handle subwidgets
+ virtual void ApplyWidgetStyle(bool forceStyle = false);
+
+ // helper function to ease native widgets wrapping, called by
+ // ApplyWidgetStyle -- override this, not ApplyWidgetStyle
+ virtual void DoApplyWidgetStyle(GtkRcStyle *style);
private:
- DECLARE_EVENT_TABLE()
+ DECLARE_DYNAMIC_CLASS(wxWindowGTK)
+ DECLARE_NO_COPY_CLASS(wxWindowGTK)
};
+extern wxWindow *wxFindFocusedChild(wxWindowGTK *win);
+
#endif // __GTKWINDOWH__