routing native events first to the wx class and only if skipped call native handler

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

diff --git a/include/wx/motif/window.h b/include/wx/motif/window.h
index 01236fcb7ef3498254042450798ac78ac55a312e..a5bc5383bc677b764454d0d9761440ab518b1bcb 100644 (file)
--- a/include/wx/motif/window.h
+++ b/include/wx/motif/window.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

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

 // Purpose:     wxWindow class
 // Author:      Julian Smart
 // Modified by:
 // Purpose:     wxWindow class
 // Author:      Julian Smart
 // Modified by:


@@ -12,68 +12,63 @@
 #ifndef _WX_WINDOW_H_
 #define _WX_WINDOW_H_
 
 #ifndef _WX_WINDOW_H_
 #define _WX_WINDOW_H_
 

-#ifdef __GNUG__
-#pragma interface "window.h"
-#endif
-

 #include "wx/region.h"
 
 // ----------------------------------------------------------------------------
 // wxWindow class for Motif - see also wxWindowBase
 // ----------------------------------------------------------------------------
 
 #include "wx/region.h"
 
 // ----------------------------------------------------------------------------
 // wxWindow class for Motif - see also wxWindowBase
 // ----------------------------------------------------------------------------
 

-class wxWindow : public wxWindowBase
+class WXDLLIMPEXP_CORE wxWindow : public wxWindowBase

 {
 {

-    friend class WXDLLEXPORT wxDC;
-    friend class WXDLLEXPORT wxWindowDC;
-    
+    friend class WXDLLIMPEXP_FWD_CORE wxDC;
+    friend class WXDLLIMPEXP_FWD_CORE wxWindowDC;
+

 public:
     wxWindow() { Init(); }
 public:
     wxWindow() { Init(); }

-    
+

     wxWindow(wxWindow *parent,
     wxWindow(wxWindow *parent,

-        wxWindowID id,
-        const wxPoint& pos = wxDefaultPosition,
-        const wxSize& size = wxDefaultSize,
-        long style = 0,
-        const wxString& name = wxPanelNameStr)
+             wxWindowID id,
+             const wxPoint& pos = wxDefaultPosition,
+             const wxSize& size = wxDefaultSize,
+             long style = 0,
+             const wxString& name = wxPanelNameStr)

     {
         Init();
         Create(parent, id, pos, size, style, name);
     }
     {
         Init();
         Create(parent, id, pos, size, style, name);
     }

-    
+

     virtual ~wxWindow();
     virtual ~wxWindow();

-    
+

     bool Create(wxWindow *parent,
     bool Create(wxWindow *parent,

-        wxWindowID id,
-        const wxPoint& pos = wxDefaultPosition,
-        const wxSize& size = wxDefaultSize,
-        long style = 0,
-        const wxString& name = wxPanelNameStr);
-    
+                wxWindowID id,
+                const wxPoint& pos = wxDefaultPosition,
+                const wxSize& size = wxDefaultSize,
+                long style = 0,
+                const wxString& name = wxPanelNameStr);
+

     // implement base class pure virtuals
     // implement base class pure virtuals

-    virtual void SetTitle( const wxString& title);
-    virtual wxString GetTitle() const;
-    
+    virtual void SetLabel(const wxString& label);
+    virtual wxString GetLabel() const;
+

     virtual void Raise();
     virtual void Lower();
     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 Enable( bool enable = true );
+

     virtual void SetFocus();
     virtual void SetFocus();

-    
+

     virtual void WarpPointer(int x, int y);
     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 );
         const wxRect *rect = (const wxRect *) NULL );

-    virtual void Clear();
-    
+

     virtual bool SetBackgroundColour( const wxColour &colour );
     virtual bool SetForegroundColour( const wxColour &colour );
     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 SetCursor( const wxCursor &cursor );
     virtual bool SetFont( const wxFont &font );

-    
+

     virtual int GetCharHeight() const;
     virtual int GetCharWidth() const;
     virtual void GetTextExtent(const wxString& string,
     virtual int GetCharHeight() const;
     virtual int GetCharWidth() const;
     virtual void GetTextExtent(const wxString& string,


@@ -82,38 +77,36 @@ public:
         int *externalLeading = (int *) NULL,
         const wxFont *theFont = (const wxFont *) NULL)
         const;
         int *externalLeading = (int *) NULL,
         const wxFont *theFont = (const wxFont *) NULL)
         const;

-    
+

     virtual void SetScrollbar( int orient, int pos, int thumbVisible,
     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 );
     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 void SetSizeHints(int minW, int minH,
-        int maxW = -1, int maxH = -1,
-        int incW = -1, int incH = -1);
+

 #if wxUSE_DRAG_AND_DROP
     virtual void SetDropTarget( wxDropTarget *dropTarget );
 #endif // wxUSE_DRAG_AND_DROP
 #if wxUSE_DRAG_AND_DROP
     virtual void SetDropTarget( wxDropTarget *dropTarget );
 #endif // wxUSE_DRAG_AND_DROP

-    
+

     // Accept files for dragging
     virtual void DragAcceptFiles(bool accept);
     // Accept files for dragging
     virtual void DragAcceptFiles(bool accept);

-    
+

     // Get the unique identifier of a window
     virtual WXWidget GetHandle() const { return GetMainWidget(); }
     // Get the unique identifier of a window
     virtual WXWidget GetHandle() const { return GetMainWidget(); }

-    
+

     // implementation from now on
     // --------------------------
     // implementation from now on
     // --------------------------

-    
+

     // accessors
     // ---------
     // accessors
     // ---------

-    
+

     // Get main widget for this window, e.g. a text widget
     virtual WXWidget GetMainWidget() const;
     // Get main widget for this window, e.g. a text widget
     virtual WXWidget GetMainWidget() const;

-    // Get the widget that corresponds to the label (for font setting, label setting etc.)
+    // Get the widget that corresponds to the label (for font setting,
+    // label setting etc.)

     virtual WXWidget GetLabelWidget() const;
     // Get the client widget for this window (something we can create other
     // windows on)
     virtual WXWidget GetLabelWidget() const;
     // Get the client widget for this window (something we can create other
     // windows on)


@@ -122,78 +115,51 @@ public:
     // multi-line text widget. Top means, top in the window hierarchy that
     // implements this window.
     virtual WXWidget GetTopWidget() const;
     // multi-line text widget. Top means, top in the window hierarchy that
     // implements this window.
     virtual WXWidget GetTopWidget() const;

-    
+

     // Get the underlying X window and display
     // Get the underlying X window and display

+    WXWindow GetClientXWindow() const;

     WXWindow GetXWindow() const;
     WXDisplay *GetXDisplay() const;
     WXWindow GetXWindow() const;
     WXDisplay *GetXDisplay() const;

-    
-    // called from Motif callbacks - and should only be called from there
-    
-    void SetButton1(bool pressed) { m_button1Pressed = pressed; }
-    void SetButton2(bool pressed) { m_button2Pressed = pressed; }
-    void SetButton3(bool pressed) { m_button3Pressed = pressed; }
-    
+

     void SetLastClick(int button, long timestamp)
     { m_lastButton = button; m_lastTS = timestamp; }
     void SetLastClick(int button, long timestamp)
     { m_lastButton = button; m_lastTS = timestamp; }

-    
+

     int GetLastClickedButton() const { return m_lastButton; }
     long GetLastClickTime() const { return m_lastTS; }
     int GetLastClickedButton() const { return m_lastButton; }
     long GetLastClickTime() const { return m_lastTS; }

-    
-    // Gives window a chance to do something in response to a size message, e.g.
-    // arrange status bar, toolbar etc.
+
+    // Gives window a chance to do something in response to a size message,
+    // e.g. arrange status bar, toolbar etc.

     virtual bool PreResize();
     virtual bool PreResize();

-    
+

     // Generates a paint event
     virtual void DoPaint();
     // Generates a paint event
     virtual void DoPaint();

-    
+

     // update rectangle/region manipulation
     // (for wxWindowDC and Motif callbacks only)
     // -----------------------------------------
     // update rectangle/region manipulation
     // (for wxWindowDC and Motif callbacks only)
     // -----------------------------------------

-    
-    // read/write access to the update rect list
-    const wxRectList& GetUpdateRects() const { return m_updateRects; }
-    
+

     // Adds a recangle to the updates list
     // Adds a recangle to the updates list

-    void AddUpdateRect(int x, int y, int w, int h)
-    { m_updateRects.Append(new wxRect(x, y, w, h)); }
-    
-    // Empties the m_updateRects list
-    void ClearUpdateRects();
-    
+    void AddUpdateRect(int x, int y, int w, int h);
+

     void ClearUpdateRegion() { m_updateRegion.Clear(); }
     void SetUpdateRegion(const wxRegion& region) { m_updateRegion = region; }
     void ClearUpdateRegion() { m_updateRegion.Clear(); }
     void SetUpdateRegion(const wxRegion& region) { m_updateRegion = region; }

-    
-    // sets the fore/background colour for the given widget
-    static void DoChangeForegroundColour(WXWidget widget, wxColour& foregroundColour);
-    static void DoChangeBackgroundColour(WXWidget widget, wxColour& backgroundColour, bool changeArmColour = FALSE);
-    
-    // For implementation purposes - sometimes decorations make the client area
-    // smaller
-    virtual wxPoint GetClientAreaOrigin() const;
-    
+
+    // Process idle (send update events)
+    void OnInternalIdle();
+
+    // post-creation activities
+    void PostCreation();
+
+    // pre-creation activities
+    void PreCreation();
+

 protected:
 protected:

-    // event handlers (not virtual by design)
-    void OnIdle(wxIdleEvent& event);
-    
-    wxWindow *GetChild(int number) const
-    { return GetChildren().Item(number)->GetData(); }
-    

     // Responds to colour changes: passes event on to children.
     void OnSysColourChanged(wxSysColourChangedEvent& event);
     // Responds to colour changes: passes event on to children.
     void OnSysColourChanged(wxSysColourChangedEvent& event);

-    
+

     // Motif-specific
     // Motif-specific

-    
-    // CanvasXXXSiize functions
-    void CanvasGetSize(int* width, int* height) const; // If have drawing area
-    void CanvasGetClientSize(int *width, int *height) const;
-    void CanvasGetPosition(int *x, int *y) const; // If have drawing area
-    void CanvasSetClientSize(int width, int size);
-    void CanvasSetSize(int x, int y, int width, int height, int sizeFlags = wxSIZE_AUTO);
-    
+

     void SetMainWidget(WXWidget w) { m_mainWidget = w; }
     void SetMainWidget(WXWidget w) { m_mainWidget = w; }

-    
-    bool CanAddEventHandler() const { return m_canAddEventHandler; }
-    void SetCanAddEventHandler(bool flag) { m_canAddEventHandler = flag; }

 
     // See src/motif/window.cpp, near the top, for an explanation
     // why this is necessary
 
     // See src/motif/window.cpp, near the top, for an explanation
     // why this is necessary


@@ -202,6 +168,22 @@ protected:
     void DoSetSizeIntr(int x, int y,
                        int width, int height,
                        int sizeFlags, bool fromCtor);
     void DoSetSizeIntr(int x, int y,
                        int width, int height,
                        int sizeFlags, bool fromCtor);

+
+    // for DoMoveWindowIntr flags
+    enum
+    {
+        wxMOVE_X = 1,
+        wxMOVE_Y = 2,
+        wxMOVE_WIDTH = 4,
+        wxMOVE_HEIGHT = 8
+    };
+
+    void DoMoveWindowIntr(int x, int y, int width, int height,
+                          int flags);
+
+    // helper function, to remove duplicate code, used in wxScrollBar
+    WXWidget DoCreateScrollBar(WXWidget parent, wxOrientation orientation,
+                               void (*callback)());

 public:
     WXPixmap GetBackingPixmap() const { return m_backingPixmap; }
     void SetBackingPixmap(WXPixmap pixmap) { m_backingPixmap = pixmap; }
 public:
     WXPixmap GetBackingPixmap() const { return m_backingPixmap; }
     void SetBackingPixmap(WXPixmap pixmap) { m_backingPixmap = pixmap; }


@@ -209,29 +191,30 @@ public:
     int GetPixmapHeight() const { return m_pixmapHeight; }
     void SetPixmapWidth(int w) { m_pixmapWidth = w; }
     void SetPixmapHeight(int h) { m_pixmapHeight = h; }
     int GetPixmapHeight() const { return m_pixmapHeight; }
     void SetPixmapWidth(int w) { m_pixmapWidth = w; }
     void SetPixmapHeight(int h) { m_pixmapHeight = h; }

-    
+

     // Change properties
     // Change properties

-    virtual void ChangeFont(bool keepOriginalSize = TRUE);             // Change to the current font (often overridden)
-    
+    // Change to the current font (often overridden)
+    virtual void ChangeFont(bool keepOriginalSize = true);
+

     // Change background and foreground colour using current background colour
     // setting (Motif generates foreground based on background)
     virtual void ChangeBackgroundColour();
     // Change foreground colour using current foreground colour setting
     virtual void ChangeForegroundColour();
     // Change background and foreground colour using current background colour
     // setting (Motif generates foreground based on background)
     virtual void ChangeBackgroundColour();
     // Change foreground colour using current foreground colour setting
     virtual void ChangeForegroundColour();

-    
+

 protected:
     // Adds the widget to the hash table and adds event handlers.
     bool AttachWidget(wxWindow* parent, WXWidget mainWidget,
         WXWidget formWidget, int x, int y, int width, int height);
     bool DetachWidget(WXWidget widget);
 protected:
     // Adds the widget to the hash table and adds event handlers.
     bool AttachWidget(wxWindow* parent, WXWidget mainWidget,
         WXWidget formWidget, int x, int y, int width, int height);
     bool DetachWidget(WXWidget widget);

-    
+

     // How to implement accelerators. If we find a key event, translate to
     // How to implement accelerators. If we find a key event, translate to

-    // wxWindows wxKeyEvent form. Find a widget for the window. Now find a
+    // wxWidgets wxKeyEvent form. Find a widget for the window. Now find a

     // wxWindow for the widget. If there isn't one, go up the widget hierarchy
     // trying to find one. Once one is found, call ProcessAccelerator for the
     // wxWindow for the widget. If there isn't one, go up the widget hierarchy
     // trying to find one. Once one is found, call ProcessAccelerator for the

-    // window. If it returns TRUE (processed the event), skip the X event,
-    // otherwise carry on up the wxWindows window hierarchy calling
-    // ProcessAccelerator. If all return FALSE, process the X event as normal.
+    // window. If it returns true (processed the event), skip the X event,
+    // otherwise carry on up the wxWidgets window hierarchy calling
+    // ProcessAccelerator. If all return false, process the X event as normal.

     // Eventually we can implement OnCharHook the same way, but concentrate on
     // accelerators for now. ProcessAccelerator must look at the current
     // accelerator table, and try to find what menu id or window (beneath it)
     // Eventually we can implement OnCharHook the same way, but concentrate on
     // accelerators for now. ProcessAccelerator must look at the current
     // accelerator table, and try to find what menu id or window (beneath it)


@@ -239,26 +222,26 @@ protected:
     // event and send it.
 public:
     virtual bool ProcessAccelerator(wxKeyEvent& event);
     // event and send it.
 public:
     virtual bool ProcessAccelerator(wxKeyEvent& event);

-    
+

 protected:
     // unmanage and destroy an X widget f it's !NULL (passing NULL is ok)
     void UnmanageAndDestroy(WXWidget widget);
 protected:
     // unmanage and destroy an X widget f it's !NULL (passing NULL is ok)
     void UnmanageAndDestroy(WXWidget widget);

-    
-    // map or unmap an X widget (passing NULL is ok), returns TRUE if widget was
-    // mapped/unmapped
+
+    // map or unmap an X widget (passing NULL is ok),
+    // returns true if widget was mapped/unmapped

     bool MapOrUnmap(WXWidget widget, bool map);
     bool MapOrUnmap(WXWidget widget, bool map);

-    
+

     // scrolling stuff
     // ---------------
     // scrolling stuff
     // ---------------

-    
+

     // create/destroy window scrollbars
     void CreateScrollbar(wxOrientation orientation);
     void DestroyScrollbar(wxOrientation orientation);
     // create/destroy window scrollbars
     void CreateScrollbar(wxOrientation orientation);
     void DestroyScrollbar(wxOrientation orientation);

-    
+

     // get either hor or vert scrollbar widget
     WXWidget GetScrollbar(wxOrientation orient) const
     { return orient == wxHORIZONTAL ? m_hScrollBar : m_vScrollBar; }
     // get either hor or vert scrollbar widget
     WXWidget GetScrollbar(wxOrientation orient) const
     { return orient == wxHORIZONTAL ? m_hScrollBar : m_vScrollBar; }

-    
+

     // set the scroll pos
     void SetInternalScrollPos(wxOrientation orient, int pos)
     {
     // set the scroll pos
     void SetInternalScrollPos(wxOrientation orient, int pos)
     {


@@ -267,23 +250,16 @@ protected:
         else
             m_scrollPosY = pos;
     }
         else
             m_scrollPosY = pos;
     }

-    
+

     // Motif-specific flags
     // --------------------
     // Motif-specific flags
     // --------------------

-    
+

     bool m_needsRefresh:1;          // repaint backing store?
     bool m_needsRefresh:1;          // repaint backing store?

-    bool m_canAddEventHandler:1;    // ???
-    bool m_button1Pressed:1;
-    bool m_button2Pressed:1;
-    bool m_button3Pressed:1;
-    
+

     // For double-click detection
     // For double-click detection

-    long   m_lastTS;         // last timestamp
-    int    m_lastButton;     // last pressed button
-    
-    // List of wxRects representing damaged region
-    wxRectList m_updateRects;
-    
+    long                  m_lastTS;           // last timestamp
+    unsigned              m_lastButton:2;     // last pressed button
+

 protected:
     WXWidget              m_mainWidget;
     WXWidget              m_hScrollBar;
 protected:
     WXWidget              m_mainWidget;
     WXWidget              m_hScrollBar;


@@ -291,20 +267,18 @@ protected:
     WXWidget              m_borderWidget;
     WXWidget              m_scrolledWindow;
     WXWidget              m_drawingArea;
     WXWidget              m_borderWidget;
     WXWidget              m_scrolledWindow;
     WXWidget              m_drawingArea;

-    bool                  m_winCaptured;
-    bool                  m_hScroll;
-    bool                  m_vScroll;
+    bool                  m_winCaptured:1;

     WXPixmap              m_backingPixmap;
     int                   m_pixmapWidth;
     int                   m_pixmapHeight;
     int                   m_pixmapOffsetX;
     int                   m_pixmapOffsetY;
     WXPixmap              m_backingPixmap;
     int                   m_pixmapWidth;
     int                   m_pixmapHeight;
     int                   m_pixmapOffsetX;
     int                   m_pixmapOffsetY;

-    
-    // Store the last scroll pos, since in wxWin the pos isn't set automatically
-    // by system
+
+    // Store the last scroll pos, since in wxWin the pos isn't set
+    // automatically by system

     int                   m_scrollPosX;
     int                   m_scrollPosY;
     int                   m_scrollPosX;
     int                   m_scrollPosY;

-    
+

     // implement the base class pure virtuals
     virtual void DoClientToScreen( int *x, int *y ) const;
     virtual void DoScreenToClient( int *x, int *y ) const;
     // implement the base class pure virtuals
     virtual void DoClientToScreen( int *x, int *y ) const;
     virtual void DoScreenToClient( int *x, int *y ) const;


@@ -319,15 +293,15 @@ protected:
     virtual bool DoPopupMenu(wxMenu *menu, int x, int y);
     virtual void DoCaptureMouse();
     virtual void DoReleaseMouse();
     virtual bool DoPopupMenu(wxMenu *menu, int x, int y);
     virtual void DoCaptureMouse();
     virtual void DoReleaseMouse();

-    
+

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

-    
+

 private:
     // common part of all ctors
     void Init();
 private:
     // common part of all ctors
     void Init();

-    
+

     DECLARE_DYNAMIC_CLASS(wxWindow)
     DECLARE_NO_COPY_CLASS(wxWindow)
     DECLARE_EVENT_TABLE()
     DECLARE_DYNAMIC_CLASS(wxWindow)
     DECLARE_NO_COPY_CLASS(wxWindow)
     DECLARE_EVENT_TABLE()


@@ -341,20 +315,20 @@ private:
 // undesired effects.
 //
 // Usage: create an instance of this class on the stack to disable the size
 // undesired effects.
 //
 // Usage: create an instance of this class on the stack to disable the size

-// optimisation, it will be reenabled as soon as the object goes out from scope.
+// optimisation, it will be reenabled as soon as the object goes out
+// from scope.

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

-class WXDLLEXPORT wxNoOptimize
+class WXDLLIMPEXP_CORE wxNoOptimize

 {
 public:
     wxNoOptimize() { ms_count++; }
     ~wxNoOptimize() { ms_count--; }
 {
 public:
     wxNoOptimize() { ms_count++; }
     ~wxNoOptimize() { ms_count--; }

-    
+

     static bool CanOptimize() { return ms_count == 0; }
     static bool CanOptimize() { return ms_count == 0; }

-    
+

 protected:
     static int ms_count;
 };
 
 protected:
     static int ms_count;
 };
 

-#endif
-// _WX_WINDOW_H_
+#endif // _WX_WINDOW_H_