wxHTML classes description is now in alphabetical order

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

diff --git a/include/wx/motif/window.h b/include/wx/motif/window.h
index 10e64022599064d9f277aa1f0d6746a86a23adf4..77b8625430978162e10b1b57cd3f3b16e8a3fffd 100644 (file)
--- a/include/wx/motif/window.h
+++ b/include/wx/motif/window.h
@@ -16,6 +16,12 @@
     #pragma interface "window.h"
 #endif
 
     #pragma interface "window.h"
 #endif
 

+// ----------------------------------------------------------------------------
+// A list of rectangles type used by wxWindow
+// ----------------------------------------------------------------------------
+
+WX_DECLARE_LIST(wxRect, wxRectList);
+

 // ----------------------------------------------------------------------------
 // wxWindow class for Motif - see also wxWindowBase
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // wxWindow class for Motif - see also wxWindowBase
 // ----------------------------------------------------------------------------


@@ -70,6 +76,9 @@ public:
                           const wxRect *rect = (const wxRect *) NULL );
     virtual void Clear();
 
                           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 bool SetCursor( const wxCursor &cursor );
     virtual bool SetFont( const wxFont &font );
 


@@ -82,8 +91,6 @@ public:
                                const wxFont *theFont = (const wxFont *) NULL)
                                const;
 
                                const wxFont *theFont = (const wxFont *) NULL)
                                const;
 

-    virtual bool PopupMenu( wxMenu *menu, int x, int y );
-

     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 void SetScrollbar( int orient, int pos, int thumbVisible,
                                int range, bool refresh = TRUE );
     virtual void SetScrollPos( int orient, int pos, bool refresh = TRUE );


@@ -93,6 +100,9 @@ public:
     virtual void ScrollWindow( int dx, int dy,
                                const wxRect* rect = (wxRect *) NULL );
 
     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


@@ -100,6 +110,71 @@ public:
     // 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(); }
+
+    // implementation from now on
+    // --------------------------
+
+    // accessors
+    // ---------
+
+    // 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.)
+    virtual WXWidget GetLabelWidget() const;
+    // Get the client widget for this window (something we can create other
+    // windows on)
+    virtual WXWidget GetClientWidget() const;
+    // Get the top widget for this window, e.g. the scrolled widget parent of a
+    // 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
+    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; }
+
+    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.
+    virtual bool PreResize();
+
+    // Generates a paint event
+    virtual void DoPaint();
+
+    // 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
+    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 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);
+

 protected:
     // event handlers (not virtual by design)
     void OnIdle(wxIdleEvent& event);
 protected:
     // event handlers (not virtual by design)
     void OnIdle(wxIdleEvent& event);


@@ -112,10 +187,6 @@ protected:
     // a toolbar that it manages itself).
     virtual void AdjustForParentClientOrigin(int& x, int& y, int sizeFlags);
 
     // a toolbar that it manages itself).
     virtual void AdjustForParentClientOrigin(int& x, int& y, int sizeFlags);
 

-    virtual void AddChild(wxWindow *child);         // Adds reference to the child object
-    virtual void RemoveChild(wxWindow *child);   // Removes reference to child
-    virtual void DestroyChildren();  // Removes and destroys all children
-

     wxWindow *GetChild(int number) const
         { return GetChildren().Item(number)->GetData(); }
 
     wxWindow *GetChild(int number) const
         { return GetChildren().Item(number)->GetData(); }
 


@@ -124,9 +195,6 @@ protected:
 
     // Motif-specific
 
 
     // Motif-specific
 

-        // empties the m_updateRects list
-    void ClearUpdateRects();
-

         // CanvasXXXSiize functions
     void CanvasGetSize(int* width, int* height) const; // If have drawing area
     void CanvasGetClientSize(int *width, int *height) const;
         // CanvasXXXSiize functions
     void CanvasGetSize(int* width, int* height) const; // If have drawing area
     void CanvasGetClientSize(int *width, int *height) const;


@@ -134,45 +202,18 @@ protected:
     void CanvasSetClientSize(int width, int size);
     void CanvasSetSize(int x, int y, int width, int height, int sizeFlags = wxSIZE_AUTO);
 
     void CanvasSetClientSize(int width, int size);
     void CanvasSetSize(int x, int y, int width, int height, int sizeFlags = wxSIZE_AUTO);
 

-    // Gives window a chance to do something in response to a size message, e.g.
-    // arrange status bar, toolbar etc.
-    virtual bool PreResize() { return TRUE; }
-
-    // accessors
-    // ---------
-
-    // 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.)
-    virtual WXWidget GetLabelWidget() const;
-    // Get the client widget for this window (something we can create other
-    // windows on)
-    virtual WXWidget GetClientWidget() const;
-    // Get the top widget for this window, e.g. the scrolled widget parent of a
-    // multi-line text widget. Top means, top in the window hierarchy that
-    // implements this window.
-    virtual WXWidget GetTopWidget() const;
-
-    // base class pure virtual
-    virtual WXWidget GetHandle() const { return GetMainWidget(); }
-

     void SetMainWidget(WXWidget w) { m_mainWidget = w; }
 
     bool CanAddEventHandler() const { return m_canAddEventHandler; }
     void SetCanAddEventHandler(bool flag) { m_canAddEventHandler = flag; }
 
     void SetMainWidget(WXWidget w) { m_mainWidget = w; }
 
     bool CanAddEventHandler() const { return m_canAddEventHandler; }
     void SetCanAddEventHandler(bool flag) { m_canAddEventHandler = flag; }
 

-    // Get the underlying X window and display
-    WXWindow GetXWindow() const;
-    WXDisplay *GetXDisplay() const;
-

     WXPixmap GetBackingPixmap() const { return m_backingPixmap; }
     int GetPixmapWidth() const { return m_pixmapWidth; }
     int GetPixmapHeight() const { return m_pixmapHeight; }
 
     WXPixmap GetBackingPixmap() const { return m_backingPixmap; }
     int GetPixmapWidth() const { return m_pixmapWidth; }
     int GetPixmapHeight() const { return m_pixmapHeight; }
 

+public:

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

-    virtual void DoChangeForegroundColour(WXWidget widget, wxColour& foregroundColour);
-    virtual void DoChangeBackgroundColour(WXWidget widget, wxColour& backgroundColour, bool changeArmColour = FALSE);

 
     // Change background and foreground colour using current background colour
     // setting (Motif generates foreground based on background)
 
     // Change background and foreground colour using current background colour
     // setting (Motif generates foreground based on background)


@@ -180,14 +221,12 @@ protected:
     // Change foreground colour using current foreground colour setting
     virtual void ChangeForegroundColour();
 
     // 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);
 
     // 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);
 

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

     // How to implement accelerators. If we find a key event, translate to
     // wxWindows 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
     // How to implement accelerators. If we find a key event, translate to
     // wxWindows 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


@@ -200,8 +239,9 @@ protected:
     // accelerator table, and try to find what menu id or window (beneath it)
     // has this ID. Then construct an appropriate command
     // event and send it.
     // accelerator table, and try to find what menu id or window (beneath it)
     // has this ID. Then construct an appropriate command
     // event and send it.

+public:

     virtual bool ProcessAccelerator(wxKeyEvent& event);
     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);


@@ -210,6 +250,13 @@ protected:
     // mapped/unmapped
     bool MapOrUnmap(WXWidget widget, bool map);
 
     // mapped/unmapped
     bool MapOrUnmap(WXWidget widget, bool map);
 

+    // scrolling stuff
+    // ---------------
+
+    // 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; }


@@ -224,6 +271,8 @@ protected:
     }
 
     // Motif-specific flags
     }
 
     // Motif-specific flags

+    // --------------------
+

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


@@ -233,7 +282,9 @@ protected:
     // For double-click detection
     long   m_lastTS;         // last timestamp
     int    m_lastButton;     // last pressed button
     // For double-click detection
     long   m_lastTS;         // last timestamp
     int    m_lastButton;     // last pressed button

-    wxList m_updateRects;    // List of wxRects representing damaged region
+
+    // List of wxRects representing damaged region
+    wxRectList m_updateRects;

 
 protected:
     WXWidget              m_mainWidget;
 
 protected:
     WXWidget              m_mainWidget;


@@ -266,6 +317,7 @@ protected:
                            int width, int height,
                            int sizeFlags = wxSIZE_AUTO);
     virtual void DoSetClientSize(int width, int height);
                            int width, int height,
                            int sizeFlags = wxSIZE_AUTO);
     virtual void DoSetClientSize(int width, int height);

+    virtual bool DoPopupMenu(wxMenu *menu, int x, int y);

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


@@ -280,21 +332,26 @@ private:
 };
 
 // ----------------------------------------------------------------------------
 };
 
 // ----------------------------------------------------------------------------

-// A little class to switch off size optimization while an instance of the object
-// exists
+// A little class to switch off `size optimization' while an instance of the
+// object exists: this may be useful to temporarily disable the optimisation
+// which consists to do nothing when the new size is equal to the old size -
+// although quite useful usually to avoid flicker, sometimes it leads to
+// undesired effects.

 //
 //

-// TODO what is it for??
+// 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.

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

-class WXDLLEXPORT wxNoOptimize: public wxObject
+
+class WXDLLEXPORT wxNoOptimize

 {
 public:
 {
 public:

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

 
 

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

 
 protected:
 
 protected:

-  static int m_count;
+  static int ms_count;

 };
 
 #endif
 };
 
 #endif