- ::wxScrolledCanvas, aka wxScrolled<wxWindow>, derives from wxWindow and
so doesn't handle children specially. This is suitable e.g. for
- implementating scrollable controls such as tree or list controls.
+ implementing scrollable controls such as tree or list controls.
Starting from version 2.4 of wxWidgets, there are several ways to use a
::wxScrolledWindow (and now wxScrolled). In particular, there are
of (10,-90).
@beginStyleTable
+ @style{wxHSCROLL}
+ If this style is specified and ::wxVSCROLL isn't, the window will be
+ scrollable only in horizontal direction (by default, i.e. if neither
+ this style nor ::wxVSCROLL is specified, it scrolls in both
+ directions).
+ @style{wxVSCROLL}
+ If this style is specified and ::wxHSCROLL isn't, the window will be
+ scrollable only in vertical direction (by default, i.e. if neither
+ this style nor ::wxHSCROLL is specified, it scrolls in both
+ directions).
+ @style{wxALWAYS_SHOW_SB}
+ Since wxWidgets 2.9.5, specifying this style makes the window always
+ show its scrollbars, even if they are not used. See ShowScrollbars().
@style{wxRETAINED}
Uses a backing pixmap to speed refreshes. Motif only.
@endStyleTable
+
+ @beginEventEmissionTable{wxScrollWinEvent}
+ @event{EVT_SCROLLWIN(func)}
+ Process all scroll events.
+ @event{EVT_SCROLLWIN_TOP(func)}
+ Process @c wxEVT_SCROLLWIN_TOP scroll-to-top events.
+ @event{EVT_SCROLLWIN_BOTTOM(func)}
+ Process @c wxEVT_SCROLLWIN_BOTTOM scroll-to-bottom events.
+ @event{EVT_SCROLLWIN_LINEUP(func)}
+ Process @c wxEVT_SCROLLWIN_LINEUP line up events.
+ @event{EVT_SCROLLWIN_LINEDOWN(func)}
+ Process @c wxEVT_SCROLLWIN_LINEDOWN line down events.
+ @event{EVT_SCROLLWIN_PAGEUP(func)}
+ Process @c wxEVT_SCROLLWIN_PAGEUP page up events.
+ @event{EVT_SCROLLWIN_PAGEDOWN(func)}
+ Process @c wxEVT_SCROLLWIN_PAGEDOWN page down events.
+ @event{EVT_SCROLLWIN_THUMBTRACK(func)}
+ Process @c wxEVT_SCROLLWIN_THUMBTRACK thumbtrack events
+ (frequent events sent as the user drags the thumbtrack).
+ @event{EVT_SCROLLWIN_THUMBRELEASE(func)}
+ Process @c wxEVT_SCROLLWIN_THUMBRELEASE thumb release events.
+ @endEventTable
+
+ @note
+ Don't confuse wxScrollWinEvents generated by this class with
+ wxScrollEvent objects generated by wxScrollBar and wxSlider.
+
+
@remarks
Use wxScrolled for applications where the user scrolls by a fixed amount,
and where a 'page' can be interpreted to be the current visible portion of
long style = wxHSCROLL | wxVSCROLL,
const wxString& name = "scrolledWindow");
-
/**
Translates the logical coordinates to the device ones. For example, if
a window is scrolled 10 pixels to the bottom, the device coordinates of
@see CalcUnscrolledPosition()
*/
void CalcScrolledPosition(int x, int y, int* xx, int* yy) const;
+ wxPoint CalcScrolledPosition(const wxPoint& pt) const;
/**
Translates the device coordinates to the logical ones. For example, if
@see CalcScrolledPosition()
*/
void CalcUnscrolledPosition(int x, int y, int* xx, int* yy) const;
+ wxPoint CalcUnscrolledPosition(const wxPoint& pt) const;
/**
Creates the window for two-step construction. Derived classes
void DoPrepareDC(wxDC& dc);
/**
- Enable or disable physical scrolling in the given direction. Physical
- scrolling is the physical transfer of bits up or down the
- screen when a scroll event occurs. If the application scrolls by a
- variable amount (e.g. if there are different font sizes) then physical
- scrolling will not work, and you should switch it off. Note that you
- will have to reposition child windows yourself, if physical scrolling
- is disabled.
+ Enable or disable use of wxWindow::ScrollWindow() for scrolling.
+
+ By default, when a scrolled window is logically scrolled,
+ wxWindow::ScrollWindow() is called on the underlying window which
+ scrolls the window contents and only invalidates the part of the window
+ newly brought into view. If @false is passed as an argument, then this
+ "physical scrolling" is disabled and the window is entirely invalidated
+ whenever it is scrolled by calling wxWindow::Refresh().
+
+ It should be rarely necessary to disable physical scrolling, so this
+ method shouldn't be called in normal circumstances.
@param xScrolling
If @true, enables physical scrolling in the x direction.
@param yScrolling
If @true, enables physical scrolling in the y direction.
-
- @remarks Physical scrolling may not be available on all platforms. Where
- it is available, it is enabled by default.
*/
void EnableScrolling(bool xScrolling, bool yScrolling);
method must be overridden.
*/
void SetTargetWindow(wxWindow *window);
+ wxWindow *GetTargetWindow() const;
+
+
+ void SetTargetRect(const wxRect& rect);
+ wxRect GetTargetRect() const;
+
+ int GetScrollPageSize(int orient) const;
+ void SetScrollPageSize(int orient, int pageSize);
+ int GetScrollLines( int orient ) const;
+ void SetScale(double xs, double ys);
+ double GetScaleX() const;
+ double GetScaleY() const;
+
+ virtual void AdjustScrollbars();
+
+ /**
+ Are we generating the autoscroll events?
+ */
+ bool IsAutoScrolling() const;
+
+ /**
+ Stop generating the scroll events when mouse is held outside the
+ window.
+ */
+ void StopAutoScrolling();
+
+ /**
+ This method can be overridden in a derived class to forbid sending the
+ auto scroll events - note that unlike StopAutoScrolling() it doesn't
+ stop the timer, so it will be called repeatedly and will typically
+ return different values depending on the current mouse position
+
+ The base class version just returns true.
+ */
+ virtual bool SendAutoScrollEvents(wxScrollWinEvent& event) const;
+
protected:
/**
/**
Scrolled window derived from wxPanel.
- See wxScrolled for detailed description.
+ See wxScrolled for a detailed description.
@note Note that because this class derives from wxPanel, it shares its
behaviour with regard to TAB traversal and focus handling (in
projects / wxWidgets.git / blobdiff