X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f8f31de610489618dd00d1cc0a3b2ef5f797c2f5..b02dd12239c8a59b9a545d9fcb04974f8ad02c6b:/interface/wx/scrolwin.h?ds=sidebyside diff --git a/interface/wx/scrolwin.h b/interface/wx/scrolwin.h index 8f8287d224..5c027861ab 100644 --- a/interface/wx/scrolwin.h +++ b/interface/wx/scrolwin.h @@ -3,7 +3,7 @@ // Purpose: interface of wxScrolled template // Author: wxWidgets team // RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// /** @@ -32,7 +32,7 @@ enum wxScrollbarVisibility - ::wxScrolledCanvas, aka wxScrolled, 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 @@ -103,6 +103,34 @@ enum wxScrollbarVisibility 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 @@ -135,10 +163,10 @@ public: @param id Window identifier. The value @c wxID_ANY indicates a default value. @param pos - Window position. If a position of @c wxDefaultPosition is specified + Window position. If a position of ::wxDefaultPosition is specified then a default position is chosen. @param size - Window size. If a size of @c wxDefaultSize is specified then the + Window size. If a size of ::wxDefaultSize is specified then the window is sized appropriately. @param style Window style. See wxScrolled. @@ -163,6 +191,11 @@ public: 10) and so the call to CalcScrolledPosition(0, 10, xx, yy) will return 0 in yy. + @beginWxPerlOnly + In wxPerl this method takes two parameters and returns a + 2-element list (xx, yy). + @endWxPerlOnly + @see CalcUnscrolledPosition() */ void CalcScrolledPosition(int x, int y, int* xx, int* yy) const; @@ -174,6 +207,11 @@ public: 10) and so the call to CalcUnscrolledPosition(0, 0, xx, yy) will return 10 in yy. + @beginWxPerlOnly + In wxPerl this method takes two parameters and returns a + 2-element list (xx, yy). + @endWxPerlOnly + @see CalcScrolledPosition() */ void CalcUnscrolledPosition(int x, int y, int* xx, int* yy) const; @@ -189,6 +227,22 @@ public: long style = wxHSCROLL | wxVSCROLL, const wxString& name = "scrolledWindow"); + /** + Disable use of keyboard keys for scrolling. + + By default cursor movement keys (including Home, End, Page Up and Down) + are used to scroll the window appropriately. If the derived class uses + these keys for something else, e.g. changing the currently selected + item, this function can be used to disable this behaviour as it's not + only not necessary then but can actually be actively harmful if another + object forwards a keyboard event corresponding to one of the above keys + to us using ProcessWindowEvent() because the event will always be + processed which can be undesirable. + + @since 2.9.1 + */ + void DisableKeyboardScrolling(); + /** Call this function to prepare the device context for drawing a scrolled image. @@ -283,6 +337,11 @@ public: @param yUnit Receives the number of pixels per vertical unit. + @beginWxPerlOnly + In wxPerl this method takes no parameters and returns a + 2-element list (xUnit, yUnit). + @endWxPerlOnly + @see SetScrollbars(), GetVirtualSize() */ void GetScrollPixelsPerUnit(int* xUnit, int* yUnit) const; @@ -304,6 +363,11 @@ public: to pixels you will have to multiply by the number of pixels per scroll increment. + @beginWxPerlOnly + In wxPerl this method takes no parameters and returns a + 2-element list (x, y). + @endWxPerlOnly + @see SetScrollbars(), Scroll() */ void GetViewStart(int* x, int* y) const; @@ -327,6 +391,11 @@ public: @remarks Use wxDC::DeviceToLogicalX() and wxDC::DeviceToLogicalY() to translate these units to logical units. + @beginWxPerlOnly + In wxPerl this method takes no parameters and returns a + 2-element list (xUnit, yUnit). + @endWxPerlOnly + @see SetScrollbars(), GetScrollPixelsPerUnit() */ void GetVirtualSize(int* x, int* y) const; @@ -452,6 +521,22 @@ public: 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(); + bool IsAutoScrolling() const; + void StopAutoScrolling(); protected: /** @@ -476,7 +561,7 @@ protected: See wxScrolled for detailed description. @note Note that because this class derives from wxPanel, it shares its - behavior with regard to TAB traversal and focus handling (in + behaviour with regard to TAB traversal and focus handling (in particular, it forwards focus to its children). If you don't want this behaviour, use ::wxScrolledCanvas instead.