Add files necessary to run Expat configure.

[wxWidgets.git] / interface / wx / scrolbar.h

diff --git a/interface/wx/scrolbar.h b/interface/wx/scrolbar.h
index 03c651bf30a52efe6d451187a389fb2648b6a439..45bf9b65e5b9ef40ba26d33893080f6fbb5e978f 100644 (file)
--- a/interface/wx/scrolbar.h
+++ b/interface/wx/scrolbar.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxScrollBar
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxScrollBar
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /**
 /////////////////////////////////////////////////////////////////////////////
 
 /**


@@ -39,7 +39,7 @@
            Specifies a vertical scrollbar.
     @endStyleTable
 
            Specifies a vertical scrollbar.
     @endStyleTable
 

-    @beginEventTable{wxScrollEvent}
+    @beginEventEmissionTable{wxScrollEvent}

     You can use EVT_COMMAND_SCROLL... macros with window IDs for when intercepting
     scroll events from controls, or EVT_SCROLL... macros without window IDs for
     intercepting scroll events from the receiving window -- except for this,
     You can use EVT_COMMAND_SCROLL... macros with window IDs for when intercepting
     scroll events from controls, or EVT_SCROLL... macros without window IDs for
     intercepting scroll events from the receiving window -- except for this,


@@ -47,45 +47,45 @@
     @event{EVT_SCROLL(func)}
         Process all scroll events.
     @event{EVT_SCROLL_TOP(func)}
     @event{EVT_SCROLL(func)}
         Process all scroll events.
     @event{EVT_SCROLL_TOP(func)}

-        Process wxEVT_SCROLL_TOP scroll-to-top events (minimum position).
+        Process @c wxEVT_SCROLL_TOP scroll-to-top events (minimum position).

     @event{EVT_SCROLL_BOTTOM(func)}
     @event{EVT_SCROLL_BOTTOM(func)}

-        Process wxEVT_SCROLL_BOTTOM scroll-to-bottom events (maximum position).
+        Process @c wxEVT_SCROLL_BOTTOM scroll-to-bottom events (maximum position).

     @event{EVT_SCROLL_LINEUP(func)}
     @event{EVT_SCROLL_LINEUP(func)}

-        Process wxEVT_SCROLL_LINEUP line up events.
+        Process @c wxEVT_SCROLL_LINEUP line up events.

     @event{EVT_SCROLL_LINEDOWN(func)}
     @event{EVT_SCROLL_LINEDOWN(func)}

-        Process wxEVT_SCROLL_LINEDOWN line down events.
+        Process @c wxEVT_SCROLL_LINEDOWN line down events.

     @event{EVT_SCROLL_PAGEUP(func)}
     @event{EVT_SCROLL_PAGEUP(func)}

-        Process wxEVT_SCROLL_PAGEUP page up events.
+        Process @c wxEVT_SCROLL_PAGEUP page up events.

     @event{EVT_SCROLL_PAGEDOWN(func)}
     @event{EVT_SCROLL_PAGEDOWN(func)}

-        Process wxEVT_SCROLL_PAGEDOWN page down events.
+        Process @c wxEVT_SCROLL_PAGEDOWN page down events.

     @event{EVT_SCROLL_THUMBTRACK(func)}
     @event{EVT_SCROLL_THUMBTRACK(func)}

-        Process wxEVT_SCROLL_THUMBTRACK thumbtrack events
+        Process @c wxEVT_SCROLL_THUMBTRACK thumbtrack events

         (frequent events sent as the user drags the thumbtrack).
     @event{EVT_SCROLL_THUMBRELEASE(func)}
         (frequent events sent as the user drags the thumbtrack).
     @event{EVT_SCROLL_THUMBRELEASE(func)}

-        Process wxEVT_SCROLL_THUMBRELEASE thumb release events.
+        Process @c wxEVT_SCROLL_THUMBRELEASE thumb release events.

     @event{EVT_SCROLL_CHANGED(func)}
     @event{EVT_SCROLL_CHANGED(func)}

-        Process wxEVT_SCROLL_CHANGED end of scrolling events (MSW only).
+        Process @c wxEVT_SCROLL_CHANGED end of scrolling events (MSW only).

     @event{EVT_COMMAND_SCROLL(id, func)}
         Process all scroll events.
     @event{EVT_COMMAND_SCROLL_TOP(id, func)}
     @event{EVT_COMMAND_SCROLL(id, func)}
         Process all scroll events.
     @event{EVT_COMMAND_SCROLL_TOP(id, func)}

-        Process wxEVT_SCROLL_TOP scroll-to-top events (minimum position).
+        Process @c wxEVT_SCROLL_TOP scroll-to-top events (minimum position).

     @event{EVT_COMMAND_SCROLL_BOTTOM(id, func)}
     @event{EVT_COMMAND_SCROLL_BOTTOM(id, func)}

-        Process wxEVT_SCROLL_BOTTOM scroll-to-bottom events (maximum position).
+        Process @c wxEVT_SCROLL_BOTTOM scroll-to-bottom events (maximum position).

     @event{EVT_COMMAND_SCROLL_LINEUP(id, func)}
     @event{EVT_COMMAND_SCROLL_LINEUP(id, func)}

-        Process wxEVT_SCROLL_LINEUP line up events.
+        Process @c wxEVT_SCROLL_LINEUP line up events.

     @event{EVT_COMMAND_SCROLL_LINEDOWN(id, func)}
     @event{EVT_COMMAND_SCROLL_LINEDOWN(id, func)}

-        Process wxEVT_SCROLL_LINEDOWN line down events.
+        Process @c wxEVT_SCROLL_LINEDOWN line down events.

     @event{EVT_COMMAND_SCROLL_PAGEUP(id, func)}
     @event{EVT_COMMAND_SCROLL_PAGEUP(id, func)}

-        Process wxEVT_SCROLL_PAGEUP page up events.
+        Process @c wxEVT_SCROLL_PAGEUP page up events.

     @event{EVT_COMMAND_SCROLL_PAGEDOWN(id, func)}
     @event{EVT_COMMAND_SCROLL_PAGEDOWN(id, func)}

-        Process wxEVT_SCROLL_PAGEDOWN page down events.
+        Process @c wxEVT_SCROLL_PAGEDOWN page down events.

     @event{EVT_COMMAND_SCROLL_THUMBTRACK(id, func)}
     @event{EVT_COMMAND_SCROLL_THUMBTRACK(id, func)}

-        Process wxEVT_SCROLL_THUMBTRACK thumbtrack events
+        Process @c wxEVT_SCROLL_THUMBTRACK thumbtrack events

         (frequent events sent as the user drags the thumbtrack).
     @event{EVT_COMMAND_SCROLL_THUMBRELEASE(func)}
         (frequent events sent as the user drags the thumbtrack).
     @event{EVT_COMMAND_SCROLL_THUMBRELEASE(func)}

-        Process wxEVT_SCROLL_THUMBRELEASE thumb release events.
+        Process @c wxEVT_SCROLL_THUMBRELEASE thumb release events.

     @event{EVT_COMMAND_SCROLL_CHANGED(func)}
     @event{EVT_COMMAND_SCROLL_CHANGED(func)}

-        Process wxEVT_SCROLL_CHANGED end of scrolling events (MSW only).
+        Process @c wxEVT_SCROLL_CHANGED end of scrolling events (MSW only).

     @endEventTable
 
     @section scrollbar_diff The difference between EVT_SCROLL_THUMBRELEASE and EVT_SCROLL_CHANGED
     @endEventTable
 
     @section scrollbar_diff The difference between EVT_SCROLL_THUMBRELEASE and EVT_SCROLL_CHANGED


@@ -105,9 +105,9 @@
 
     @library{wxcore}
     @category{ctrl}
 
     @library{wxcore}
     @category{ctrl}

-    @appearance{scrollbar.png}
+    @appearance{scrollbar}

 
 

-    @see @ref overview_scrolling, @ref overview_eventhandling, wxScrolled
+    @see @ref overview_scrolling, @ref overview_events, wxScrolled

 */
 class wxScrollBar : public wxControl
 {
 */
 class wxScrollBar : public wxControl
 {


@@ -125,11 +125,11 @@ public:
         @param id
             Window identifier. The value wxID_ANY indicates a default value.
         @param pos
         @param id
             Window identifier. The value wxID_ANY indicates a default value.
         @param pos

-            Window position. If wxDefaultPosition is specified then a default
-        position is chosen.
+            Window position. 
+            If ::wxDefaultPosition is specified then a default position is chosen.

         @param size
         @param size

-            Window size. If wxDefaultSize is specified then a default size
-        is chosen.
+            Window size. 
+            If ::wxDefaultSize is specified then a default size is chosen.

         @param style
             Window style. See wxScrollBar.
         @param validator
         @param style
             Window style. See wxScrollBar.
         @param validator


@@ -144,7 +144,7 @@ public:
                 const wxSize& size = wxDefaultSize,
                 long style = wxSB_HORIZONTAL,
                 const wxValidator& validator = wxDefaultValidator,
                 const wxSize& size = wxDefaultSize,
                 long style = wxSB_HORIZONTAL,
                 const wxValidator& validator = wxDefaultValidator,

-                const wxString& name = "scrollBar");
+                const wxString& name = wxScrollBarNameStr);

 
     /**
         Destructor, destroying the scrollbar.
 
     /**
         Destructor, destroying the scrollbar.


@@ -240,5 +240,10 @@ public:
         @see GetThumbPosition()
     */
     virtual void SetThumbPosition(int viewStart);
         @see GetThumbPosition()
     */
     virtual void SetThumbPosition(int viewStart);

+
+    /**
+       Returns @true for scrollbars that have the vertical style set.
+    */
+    bool IsVertical() const;

 };
 
 };