-
Notifications
You must be signed in to change notification settings - Fork 2.9k
/
wxScrollWinEvent.erl
113 lines (99 loc) · 3.84 KB
/
wxScrollWinEvent.erl
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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
%%
%% %CopyrightBegin%
%%
%% Copyright Ericsson AB 2008-2024. All Rights Reserved.
%%
%% Licensed under the Apache License, Version 2.0 (the "License");
%% you may not use this file except in compliance with the License.
%% You may obtain a copy of the License at
%%
%% http://www.apache.org/licenses/LICENSE-2.0
%%
%% Unless required by applicable law or agreed to in writing, software
%% distributed under the License is distributed on an "AS IS" BASIS,
%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
%% See the License for the specific language governing permissions and
%% limitations under the License.
%%
%% %CopyrightEnd%
%% This file is generated DO NOT EDIT
-module(wxScrollWinEvent).
-moduledoc """
Functions for wxScrollWinEvent class
A scroll event holds information about events sent from scrolling windows.
Note that you can use the EVT_SCROLLWIN\* macros for intercepting scroll window
events from the receiving window.
See: `m:wxScrollEvent`,
[Overview events](https://docs.wxwidgets.org/3.1/overview_events.html#overview_events)
This class is derived (and can use functions) from: `m:wxEvent`
wxWidgets docs:
[wxScrollWinEvent](https://docs.wxwidgets.org/3.1/classwx_scroll_win_event.html)
## Events
Use `wxEvtHandler:connect/3` with
[`wxScrollWinEventType`](`t:wxScrollWinEventType/0`) to subscribe to events of
this type.
""".
-include("wxe.hrl").
-export([getOrientation/1,getPosition/1]).
%% inherited exports
-export([getId/1,getSkipped/1,getTimestamp/1,isCommandEvent/1,parent_class/1,
resumePropagation/2,shouldPropagate/1,skip/1,skip/2,stopPropagation/1]).
-type wxScrollWinEvent() :: wx:wx_object().
-include("wx.hrl").
-type wxScrollWinEventType() :: 'scrollwin_top' | 'scrollwin_bottom' | 'scrollwin_lineup' | 'scrollwin_linedown' | 'scrollwin_pageup' | 'scrollwin_pagedown' | 'scrollwin_thumbtrack' | 'scrollwin_thumbrelease'.
-export_type([wxScrollWinEvent/0, wxScrollWin/0, wxScrollWinEventType/0]).
%% @hidden
-doc false.
parent_class(wxEvent) -> true;
parent_class(_Class) -> erlang:error({badtype, ?MODULE}).
%% @doc See <a href="http://www.wxwidgets.org/manuals/2.8.12/wx_wxscrollwinevent.html#wxscrollwineventgetorientation">external documentation</a>.
-doc """
Returns wxHORIZONTAL or wxVERTICAL, depending on the orientation of the
scrollbar.
""".
-spec getOrientation(This) -> integer() when
This::wxScrollWinEvent().
getOrientation(#wx_ref{type=ThisT}=This) ->
?CLASS(ThisT,wxScrollWinEvent),
wxe_util:queue_cmd(This,?get_env(),?wxScrollWinEvent_GetOrientation),
wxe_util:rec(?wxScrollWinEvent_GetOrientation).
%% @doc See <a href="http://www.wxwidgets.org/manuals/2.8.12/wx_wxscrollwinevent.html#wxscrollwineventgetposition">external documentation</a>.
-doc """
Returns the position of the scrollbar for the thumb track and release events.
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.
""".
-spec getPosition(This) -> integer() when
This::wxScrollWinEvent().
getPosition(#wx_ref{type=ThisT}=This) ->
?CLASS(ThisT,wxScrollWinEvent),
wxe_util:queue_cmd(This,?get_env(),?wxScrollWinEvent_GetPosition),
wxe_util:rec(?wxScrollWinEvent_GetPosition).
%% From wxEvent
%% @hidden
-doc false.
stopPropagation(This) -> wxEvent:stopPropagation(This).
%% @hidden
-doc false.
skip(This, Options) -> wxEvent:skip(This, Options).
%% @hidden
-doc false.
skip(This) -> wxEvent:skip(This).
%% @hidden
-doc false.
shouldPropagate(This) -> wxEvent:shouldPropagate(This).
%% @hidden
-doc false.
resumePropagation(This,PropagationLevel) -> wxEvent:resumePropagation(This,PropagationLevel).
%% @hidden
-doc false.
isCommandEvent(This) -> wxEvent:isCommandEvent(This).
%% @hidden
-doc false.
getTimestamp(This) -> wxEvent:getTimestamp(This).
%% @hidden
-doc false.
getSkipped(This) -> wxEvent:getSkipped(This).
%% @hidden
-doc false.
getId(This) -> wxEvent:getId(This).