blob: 8af9907938035c67f4589fbaac37efb0f4e5dd94 (
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
58
59
60
61
62
63
64
65
66
|
<?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>wxBitmapDataObject</title>
</header>
<module>wxBitmapDataObject</module>
<modulesummary>Functions for wxBitmapDataObject class</modulesummary>
<description><p><seeerl marker="wxBitmapDataObject"><c>wxBitmapDataObject</c></seeerl> is a specialization of <seeerl marker="wxDataObject"><c>wxDataObject</c></seeerl> for bitmap data. It can be used without change to paste data into the <seeerl marker="wxClipboard"><c>wxClipboard</c></seeerl> or a <c>wxDropSource</c> (not implemented in wx). A user may wish to derive a new class from this class for providing a bitmap on-demand in order to minimize memory consumption when offering data in several formats, such as a bitmap and GIF.
</p><p>This class may be used as is, but <seemfa marker="#getBitmap/1"><c>getBitmap/1</c></seemfa> may be overridden to increase efficiency.
</p><p>See: <url href="https://docs.wxwidgets.org/3.1/overview_dnd.html#overview_dnd">Overview dnd</url>, <seeerl marker="wxDataObject"><c>wxDataObject</c></seeerl>, <c>wxDataObjectSimple</c> (not implemented in wx), <seeerl marker="wxFileDataObject"><c>wxFileDataObject</c></seeerl>, <seeerl marker="wxTextDataObject"><c>wxTextDataObject</c></seeerl>, <seeerl marker="wxDataObject"><c>wxDataObject</c></seeerl>
</p>
<p>This class is derived (and can use functions) from:
<seeerl marker="wxDataObject"><c>wxDataObject</c></seeerl></p>
<p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_bitmap_data_object.html">wxBitmapDataObject</url></p>
</description>
<datatypes><datatype><name name="wxBitmapDataObject"/></datatype></datatypes>
<funcs>
<func>
<name name="new" arity="0" clause_i="1" since=""/>
<fsummary>See: <c>new/1</c></fsummary>
</func>
<func>
<name name="new" arity="1" clause_i="1" since=""/>
<name name="new" arity="1" clause_i="2" since=""/>
<fsummary>Constructor, optionally passing a bitmap (otherwise use <c>setBitmap/2</c> later). </fsummary>
<desc><p>Constructor, optionally passing a bitmap (otherwise use <seemfa marker="#setBitmap/2"><c>setBitmap/2</c></seemfa> later).
</p></desc>
</func>
<func>
<name name="getBitmap" arity="1" clause_i="1" since=""/>
<fsummary>Returns the bitmap associated with the data object. </fsummary>
<desc><p>Returns the bitmap associated with the data object.
</p><p>You may wish to override this method when offering data on-demand, but this is not required by wxWidgets' internals. Use this method to get data in bitmap form from the <seeerl marker="wxClipboard"><c>wxClipboard</c></seeerl>.
</p></desc>
</func>
<func>
<name name="setBitmap" arity="2" clause_i="1" since=""/>
<fsummary>Sets the bitmap associated with the data object. </fsummary>
<desc><p>Sets the bitmap associated with the data object.
</p><p>This method is called when the data object receives data. Usually there will be no reason to override this function.
</p></desc>
</func>
<func>
<name name="destroy" arity="1" clause_i="1" since=""/>
<fsummary>Destructor</fsummary>
<desc><p>Destroys the object.</p></desc>
</func>
</funcs>
</erlref>
|
