summaryrefslogtreecommitdiff
path: root/lib/wx/doc/src/wxIconizeEvent.xml
blob: efbca3eb29a99fc2c1020844786569e121146110 (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
<?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>
    <holder>Ericsson AB. All Rights Reserved.</holder></copyright>
  <legalnotice>
      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.

  </legalnotice>
  <title>wxIconizeEvent</title>
</header>
<module>wxIconizeEvent</module>
<modulesummary>Functions for wxIconizeEvent class</modulesummary>
<description><p>An event being sent when the frame is iconized (minimized) or restored.
      </p><p>See: <url href="https://docs.wxwidgets.org/3.1/overview_events.html#overview_events">Overview events</url>, <seemfa marker="wxTopLevelWindow#iconize/2"><c>wxTopLevelWindow:iconize/2</c></seemfa>, <seemfa marker="wxTopLevelWindow#isIconized/1"><c>wxTopLevelWindow:isIconized/1</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_iconize_event.html">wxIconizeEvent</url></p>
  </description><section><title>Events</title><p>Use <seemfa marker="wxEvtHandler#connect/3"><c>wxEvtHandler:connect/3</c></seemfa> with <seetype marker="#wxIconizeEventType"><c>wxIconizeEventType</c></seetype> to subscribe to events of this type.</p></section>
<datatypes>
    <datatype><name name="wxIconizeEvent"/></datatype>
    <datatype><name name="wxIconize"/></datatype>
    <datatype><name name="wxIconizeEventType"/></datatype></datatypes>

<funcs>
  <func>
    <name name="isIconized" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if the frame has been iconized, false if it has been restored. </fsummary>
    <desc><p>Returns true if the frame has been iconized, false if it has been restored. 
      </p></desc>
  </func>
  </funcs>
</erlref>