blob: a4c382ae369d7d0cbe628b0431aad7ff80ebd23f (
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
49
50
51
52
53
54
55
56
57
|
<?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>wxDropFilesEvent</title>
</header>
<module>wxDropFilesEvent</module>
<modulesummary>Functions for wxDropFilesEvent class</modulesummary>
<description><p>This class is used for drop files events, that is, when files have been dropped onto the window.
</p><p>The window must have previously been enabled for dropping by calling <seemfa marker="wxWindow#dragAcceptFiles/2"><c>wxWindow:dragAcceptFiles/2</c></seemfa>.
</p><p>Important note: this is a separate implementation to the more general drag and drop implementation documented in the overview_dnd. It uses the older, Windows message-based approach of dropping files.
</p><p>Remark: Windows only until version 2.8.9, available on all platforms since 2.8.10.
</p><p>See: <url href="https://docs.wxwidgets.org/3.1/overview_events.html#overview_events">Overview events</url>, <seemfa marker="wxWindow#dragAcceptFiles/2"><c>wxWindow:dragAcceptFiles/2</c></seemfa>
</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_drop_files_event.html">wxDropFilesEvent</url></p>
</description><section><title>Events</title><p>Use <seemfa marker="wxEvtHandler#connect/3"><c>wxEvtHandler:connect/3</c></seemfa> with <seetype marker="#wxDropFilesEventType"><c>wxDropFilesEventType</c></seetype> to subscribe to events of this type.</p></section>
<datatypes>
<datatype><name name="wxDropFilesEvent"/></datatype>
<datatype><name name="wxDropFiles"/></datatype>
<datatype><name name="wxDropFilesEventType"/></datatype></datatypes>
<funcs>
<func>
<name name="getPosition" arity="1" clause_i="1" since=""/>
<fsummary>Returns the position at which the files were dropped. </fsummary>
<desc><p>Returns the position at which the files were dropped.
</p><p>Returns an array of filenames.
</p></desc>
</func>
<func>
<name name="getNumberOfFiles" arity="1" clause_i="1" since=""/>
<fsummary>Returns the number of files dropped. </fsummary>
<desc><p>Returns the number of files dropped.
</p></desc>
</func>
<func>
<name name="getFiles" arity="1" clause_i="1" since=""/>
<fsummary>Returns an array of filenames. </fsummary>
<desc><p>Returns an array of filenames.
</p></desc>
</func>
</funcs>
</erlref>
|
