xtd - Reference Guide  0.1.0
Modern c++17 framework to create console, gui and unit test applications on Windows, macOS and Linux.
xtd::forms::cancel_event_args Class Reference

Provides data for a cancelable event. More...

#include <cancel_event_args.h>

Inheritance diagram for xtd::forms::cancel_event_args:
xtd::event_args xtd::forms::form_closing_event_args

Public Member Functions

 cancel_event_args ()=default
 Initializes a new instance of the cancel_event_args class with the cancel property set to false. More...
 
 cancel_event_args (bool cancel)
 Initializes a new instance of the cancel_event_args class with the cancel property set to the given value. More...
 
virtual bool cancel () const
 Gets a value indicating whether the event should be canceled. More...
 
virtual void cancel (bool cancel)
 Sets a value indicating whether the event should be canceled. More...
 

Static Public Attributes

static const event_args empty
 Provides a value to use with events that do not have event data. More...
 

Protected Attributes

bool cancel_ = false
 

Detailed Description

Provides data for a cancelable event.

Remarks
A cancelable event is raised by a component when it is about to perform an action that can be canceled, such as the closing event of a form.

The documentation for this class was generated from the following file: