summaryrefslogtreecommitdiff
path: root/lib/wx/doc/src/wxScrollWinEvent.xml
blob: 83d43226d1cd6f47a1b17aa0304061c0d29931b0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE erlref SYSTEM "erlref.dtd">

<!-- THIS FILE IS GENERATED DO NOT EDIT -->


<erlref>
<header>
  <copyright>
    <year>2020</year><year>2021</year>
    <holder>wxWidgets team.</holder></copyright>
  <legalnotice>Licensed under the wxWindows Free Documentation Licence, Version 3
  </legalnotice>
  <title>wxScrollWinEvent</title>
</header>
<module>wxScrollWinEvent</module>
<modulesummary>Functions for wxScrollWinEvent class</modulesummary>
<description><p>A scroll event holds information about events sent from scrolling windows.
      </p><p>Note that you can use the EVT_SCROLLWIN* macros for intercepting scroll window events from the receiving window.
      </p><p>See: <seeerl marker="wxScrollEvent"><c>wxScrollEvent</c></seeerl>, <url href="https://docs.wxwidgets.org/3.1/overview_events.html#overview_events">Overview events</url>
      </p>
  <p>This class is derived (and can use functions) from: 
    <seeerl marker="wxEvent"><c>wxEvent</c></seeerl></p>
  
  <p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_scroll_win_event.html">wxScrollWinEvent</url></p>
  </description><section><title>Events</title><p>Use <seemfa marker="wxEvtHandler#connect/3"><c>wxEvtHandler:connect/3</c></seemfa> with <seetype marker="#wxScrollWinEventType"><c>wxScrollWinEventType</c></seetype> to subscribe to events of this type.</p></section>
<datatypes>
    <datatype><name name="wxScrollWinEvent"/></datatype>
    <datatype><name name="wxScrollWin"/></datatype>
    <datatype><name name="wxScrollWinEventType"/></datatype></datatypes>

<funcs>
  <func>
    <name name="getOrientation" arity="1" clause_i="1" since=""/>
    <fsummary>Returns wxHORIZONTAL or wxVERTICAL, depending on the orientation of the scrollbar. </fsummary>
    <desc><p>Returns wxHORIZONTAL or wxVERTICAL, depending on the orientation of the scrollbar. 
      </p></desc>
  </func>
  
  <func>
    <name name="getPosition" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the position of the scrollbar for the thumb track and release events. </fsummary>
    <desc><p>Returns the position of the scrollbar for the thumb track and release events. 
      </p><p>Note that this field can't be used for the other events, you need to query the window itself for the current position in that case. 
      </p></desc>
  </func>
  </funcs>
</erlref>