<?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>wxNotifyEvent</title>
</header>
<module>wxNotifyEvent</module>
<modulesummary>Functions for wxNotifyEvent class</modulesummary>
<description><p>This class is not used by the event handlers by itself, but is a base class for other event classes (such as <seeerl marker="wxBookCtrlEvent"><c>wxBookCtrlEvent</c></seeerl>).
      </p><p>It (or an object of a derived class) is sent when the controls state is being changed and allows the program to <seemfa marker="#veto/1"><c>veto/1</c></seemfa> this change if it wants to prevent it from happening.
      </p><p>See: <seeerl marker="wxBookCtrlEvent"><c>wxBookCtrlEvent</c></seeerl>
      </p>
  <p>This class is derived (and can use functions) from: 
    <seeerl marker="wxCommandEvent"><c>wxCommandEvent</c></seeerl> <seeerl marker="wxEvent"><c>wxEvent</c></seeerl></p>
  
  <p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_notify_event.html">wxNotifyEvent</url></p>
  </description>
<datatypes><datatype><name name="wxNotifyEvent"/></datatype></datatypes>

<funcs>
  <func>
    <name name="allow" arity="1" clause_i="1" since=""/>
    <fsummary>This is the opposite of <c>veto/1</c>: it explicitly allows the event to be processed. </fsummary>
    <desc><p>This is the opposite of <seemfa marker="#veto/1"><c>veto/1</c></seemfa>: it explicitly allows the event to be processed. 
      </p><p>For most events it is not necessary to call this method as the events are allowed anyhow but some are forbidden by default (this will be mentioned in the corresponding event description). 
      </p></desc>
  </func>
  
  <func>
    <name name="isAllowed" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if the change is allowed (<c>veto/1</c> hasn't been called) or false otherwise (if it was). </fsummary>
    <desc><p>Returns true if the change is allowed (<seemfa marker="#veto/1"><c>veto/1</c></seemfa> hasn't been called) or false otherwise (if it was). 
      </p></desc>
  </func>
  
  <func>
    <name name="veto" arity="1" clause_i="1" since=""/>
    <fsummary>Prevents the change announced by this event from happening. </fsummary>
    <desc><p>Prevents the change announced by this event from happening. 
      </p><p>It is in general a good idea to notify the user about the reasons for vetoing the change because otherwise the applications behaviour (which just refuses to do what the user wants) might be quite surprising. 
      </p></desc>
  </func>
  </funcs>
</erlref>
