#include <form_closing_event_args.h>

Definition

Provides data for the form_closing event.

Namespace: xtd::forms

Library: xtd.forms

Examples: form.cpp.

Public Member Functions
	form_closing_event_args ()=default
	Initializes a new instance of the form_closing_event_args class.

	form_closing_event_args (xtd::forms::close_reason close_reason)
	Initializes a new instance of the form_closing_event_args class.

forms::close_reason	close_reason () const
	Gets a value that indicates why the form is being closed.

Public Member Functions inherited from xtd::forms::cancel_event_args
	cancel_event_args ()=default
	Initializes a new instance of the cancel_event_args class with the cancel property set to false.

	cancel_event_args (bool cancel)
	Initializes a new instance of the cancel_event_args class with the cancel property set to the given value.

virtual bool	cancel () const
	Gets a value indicating whether the event should be canceled.

virtual void	cancel (bool cancel)
	Sets a value indicating whether the event should be canceled.

Public Member Functions inherited from xtd::event_args
	event_args ()=default
	Initializes a new instance of the event_args class.

Public Member Functions inherited from xtd::object
	object ()=default
	Create a new instance of the ultimate base class object.

virtual bool	equals (const object &obj) const noexcept
	Determines whether the specified object is equal to the current object.

virtual size_t	get_hash_code () const noexcept
	Serves as a hash function for a particular type.

template<typename object_t >
std::unique_ptr< object_t >	memberwise_clone () const
	Gets the type of the current instance.

virtual xtd::ustring	to_string () const noexcept
	Returns a std::string that represents the current object.

Additional Inherited Members
Static Public Attributes inherited from xtd::event_args
static const event_args	empty
	Provides a value to use with events that do not have event data.

Static Public Member Functions inherited from xtd::object
static bool	equals (const object &object_a, const object &object_b) noexcept
	Determines whether the specified object instances are considered equal.

static bool	reference_equals (const object &object_a, const object &object_b) noexcept
	Determines whether the specified object instances are the same instance.

Protected Attributes inherited from xtd::forms::cancel_event_args
bool	cancel_

Constructor & Destructor Documentation

◆ form_closing_event_args() [1/2]

xtd::forms::form_closing_event_args::form_closing_event_args ( )

default

Initializes a new instance of the form_closing_event_args class.

◆ form_closing_event_args() [2/2]

xtd::forms::form_closing_event_args::form_closing_event_args ( xtd::forms::close_reason close_reason )

inline

Initializes a new instance of the form_closing_event_args class.

Parameters

close_reason A xtd::forms::close_reason value that represents the reason why the form is being closed.

Remarks: The close_reason and cancel parameters are used to initialize the close_reason and cancel properties, respectively.

Member Function Documentation

◆ close_reason()

forms::close_reason xtd::forms::form_closing_event_args::close_reason ( ) const

inline

Gets a value that indicates why the form is being closed.

Returns: One of the xtd::forms::close_reason enumerated values.

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

xtd.forms/include/xtd/forms/form_closing_event_args.h