summaryrefslogtreecommitdiff
path: root/lib/wx/doc/src/wxActivateEvent.xml
blob: 540f28a33aed9766d237d0e3db046dfd0ec03cf0 (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
<?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>wxWidgets team.</holder></copyright>
  <legalnotice>Licensed under the wxWindows Free Documentation Licence, Version 3
  </legalnotice>
  <title>wxActivateEvent</title>
</header>
<module>wxActivateEvent</module>
<modulesummary>Functions for wxActivateEvent class</modulesummary>
<description><p>An activate event is sent when a window or application is being activated or deactivated.
      </p><p>Note: Until wxWidgets 3.1.0 activation events could be sent by wxMSW when the window was minimized. This reflected the native MSW behaviour but was often surprising and unexpected, so starting from 3.1.0 such events are not sent any more when the window is in the minimized state.
      </p><p>See: <url href="https://docs.wxwidgets.org/3.1/overview_events.html#overview_events">Overview events</url>, <c>wxApp::IsActive</c> (not implemented in wx)
      </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_activate_event.html">wxActivateEvent</url></p>
  </description><section><title>Events</title><p>Use <seemfa marker="wxEvtHandler#connect/3"><c>wxEvtHandler:connect/3</c></seemfa> with <seetype marker="#wxActivateEventType"><c>wxActivateEventType</c></seetype> to subscribe to events of this type.</p></section>
<datatypes>
    <datatype><name name="wxActivateEvent"/></datatype>
    <datatype><name name="wxActivate"/></datatype>
    <datatype><name name="wxActivateEventType"/></datatype></datatypes>

<funcs>
  <func>
    <name name="getActive" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if the application or window is being activated, false otherwise. </fsummary>
    <desc><p>Returns true if the application or window is being activated, false otherwise. 
      </p></desc>
  </func>
  </funcs>
</erlref>