xtd::forms::component Class Reference

#include <component.h>

Definition

Provides the base implementation and enables object sharing between applications.

Namespace

xtd::forms

Library

xtd.forms

Remarks

component is the base class for all components and controls.

Inherits xtd::object.

Inherited by xtd::forms::about_dialog, xtd::forms::background_worker, xtd::forms::busy_dialog, xtd::forms::common_dialog, xtd::forms::control, xtd::forms::exception_dialog, xtd::forms::image_list, xtd::forms::menu, xtd::forms::message_dialog, xtd::forms::progress_dialog, and xtd::forms::timer.

Protected Member Functions
	component ()=default
	Initialises a new instance of the component class.
virtual bool	can_raise_events () const
	Gets a value indicating whether the component can raise an event.
bool	design_mode () const
	Gets a value that indicates whether the component is currently in design mode.

Additional Inherited Members
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.
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.

Constructor & Destructor Documentation

component()

xtd::forms::component::component ( )

protecteddefault

Initialises a new instance of the component class.

Member Function Documentation

can_raise_events()

virtual bool xtd::forms::component::can_raise_events ( ) const

inlineprotectedvirtual

Gets a value indicating whether the component can raise an event.

Returns

true if the component can raise events; otherwise, false. The default is true.

Remarks

The default implementation of this property always returns true. Classes that inherit from the Component class should override this property to provide the ability to disable the raising of events.

Reimplemented in xtd::forms::control.

design_mode()

bool xtd::forms::component::design_mode ( ) const

inlineprotected

Gets a value that indicates whether the component is currently in design mode.

Returns

true if the component is in design mode; otherwise, false.

---

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

• xtd.forms/include/xtd/forms/component.h