renamed port to session for Carbon printing

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

diff --git a/include/wx/gtk/window.h b/include/wx/gtk/window.h
index 2fc9d044553891df4a57aa4a986c4ecc11acfc7d..ec83a9856726d92f01f5c813cb94b44ed1f4513e 100644 (file)
--- a/include/wx/gtk/window.h
+++ b/include/wx/gtk/window.h
@@ -1,11 +1,10 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        window.h
+// Name:        wx/gtk/window.h

 // Purpose:
 // Author:      Robert Roebling
 // 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

 /////////////////////////////////////////////////////////////////////////////
 
 
 /////////////////////////////////////////////////////////////////////////////
 
 


@@ -13,253 +12,228 @@
 #define __GTKWINDOWH__
 
 #ifdef __GNUG__
 #define __GTKWINDOWH__
 
 #ifdef __GNUG__

-#pragma interface
+    #pragma interface

 #endif
 
 #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"
-
-//-----------------------------------------------------------------------------
-// global data
-//-----------------------------------------------------------------------------
-
-extern const char *wxFrameNameStr;
-extern wxList wxTopLevelWindows;
-
-//-----------------------------------------------------------------------------
-// classes
-//-----------------------------------------------------------------------------
-
-class wxLayoutConstraints;
-class wxSizer;
-
-class wxWindow;
-class wxCanvas;
-

 //-----------------------------------------------------------------------------
 //-----------------------------------------------------------------------------

-// global data
+// callback definition for inserting a window (internal)

 //-----------------------------------------------------------------------------
 
 //-----------------------------------------------------------------------------
 

-extern const char *wxPanelNameStr;
-extern const wxSize wxDefaultSize;
-extern const wxPoint wxDefaultPosition;
+class wxWindowGTK;
+typedef void (*wxInsertChildFunction)( wxWindowGTK*, wxWindowGTK* );

 
 //-----------------------------------------------------------------------------
 
 //-----------------------------------------------------------------------------

-// wxWindow
+// wxWindowGTK

 //-----------------------------------------------------------------------------
 
 //-----------------------------------------------------------------------------
 

-class wxWindow: public wxEvtHandler
+class wxWindowGTK : public wxWindowBase

 {
 {

-  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 );
+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();
+
+    // 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 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 bool Reparent( wxWindowBase *newParent );
+
+    virtual void WarpPointer(int x, int y);
+    virtual void CaptureMouse();
+    virtual void ReleaseMouse();
+
+    virtual void Refresh( bool eraseBackground = TRUE,
+                          const wxRect *rect = (const wxRect *) NULL );
+    virtual void Clear();
+
+    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 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
+    virtual bool DoPopupMenu( wxMenu *menu, int x, int y );
+#endif // wxUSE_MENUS
+
+    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 );
     virtual void SetDropTarget( wxDropTarget *dropTarget );

-    virtual wxDropTarget *GetDropTarget() const;
-    
-    virtual void SetScrollbar( const int orient, const int pos, const int thumbVisible,
-      const int range, const bool refresh = TRUE );
-    virtual void SetScrollPos( const int orient, const int pos, const bool refresh = TRUE );
-    virtual int GetScrollPos( const int orient ) const;
-    virtual int GetScrollThumb( const int orient ) const;
-    virtual int GetScrollRange( const int orient ) const;
-    virtual void ScrollWindow( const int dx, const int dy, const wxRect* rect = NULL );
-    
-    // return FALSE from here if the window doesn't want the focus
-    virtual bool AcceptsFocus() const;
-    
-  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;
+#endif // wxUSE_DRAG_AND_DROP
+
+    // 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 */
+    virtual void OnInternalIdle();
+
+    /* 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);
+
+    /* 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 );
+
+    /* creates a new widget style if none is there
+       and sets m_widgetStyle to this value. */
+    GtkStyle *GetWidgetStyle();
+
+    /* called by SetFont() and SetXXXColour etc */
+    void SetWidgetStyle();
+
+    /* overridden in many GTK widgets */
+    virtual void ApplyWidgetStyle();
+
+#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; }
+
+    // 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;
+    GtkWidget           *m_wxwindow;
+
+#if HAVE_XIM
+    /* XIM support for wxWindows */
+    GdkIC               *m_ic;
+    GdkICAttr           *m_icattr;
+#endif

     
     

-  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()
+    /* 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_isStaticBox:1;    /* faster than IS_KIND_OF */
+    bool                 m_isRadioButton:1;  /* faster than IS_KIND_OF */
+    bool                 m_isFrame:1;        /* faster than IS_KIND_OF */
+    bool                 m_acceptsFocus:1;   /* not wxStaticBox, not wxStaticBitmap etc.  */
+    bool                 m_isScrolling;
+    bool                 m_clipPaintRegion;  /* TRUE after ScrollWindow() */
+    bool                 m_queuedFullRedraw; /* TRUE after DoMoveWindow */
+
+    // these are true if the style were set before the widget was realized
+    // (typcally in the constructor) but the actual GTK style must not be set
+    // before the widget has been "realized"
+    bool                 m_delayedForegroundColour:1;
+    bool                 m_delayedBackgroundColour:1;
+    
+    // contains GTK's widgets internal information about non-default widget
+    // font and colours. we create one for each widget that gets any
+    // non-default attribute set via SetFont() or SetForegroundColour() /
+    // SetBackgroundColour().
+    GtkStyle            *m_widgetStyle;
+
+    // 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);
+
+#if wxUSE_TOOLTIPS
+    virtual void DoSetToolTip( wxToolTip *tip );
+#endif // wxUSE_TOOLTIPS
+
+    // common part of all ctors (can't be virtual because called from ctor)
+    void Init();
+
+private:
+    DECLARE_DYNAMIC_CLASS(wxWindowGTK)
+    DECLARE_NO_COPY_CLASS(wxWindowGTK);

 };
 
 #endif // __GTKWINDOWH__
 };
 
 #endif // __GTKWINDOWH__