xtd 0.2.0
Loading...
Searching...
No Matches
xtd::forms::component Class Reference
Inheritance diagram for xtd::forms::component:
xtd::object xtd::forms::about_dialog xtd::forms::assert_dialog xtd::forms::background_worker xtd::forms::busy_dialog xtd::forms::common_dialog xtd::forms::control xtd::forms::debug_message_dialog xtd::forms::exception_dialog xtd::forms::find_dialog xtd::forms::image_list xtd::forms::menu xtd::forms::message_dialog xtd::forms::message_notifier xtd::forms::message_notifier_button xtd::forms::progress_dialog xtd::forms::replace_dialog xtd::forms::status_bar_panel xtd::forms::timer xtd::forms::tool_bar_button xtd::forms::trace_message_dialog xtd::forms::xtd_about_dialog

Definition

Provides the base implementation and enables object sharing between applications.

Header
#include <xtd/forms/component>
Namespace
xtd::forms
Library
xtd.forms
Remarks
component is the base class for all components and controls.

Protected constructors

 component ()
 Initialises a new instance of the component class.
 

Protected Properties

virtual bool can_raise_events () const noexcept
 Gets a value indicating whether the component can raise an event.
 
bool design_mode () const noexcept
 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.
 
virtual type_object get_type () const noexcept
 Gets the type of the current instance.
 
template<typename object_t >
xtd::uptr< object_t > memberwise_clone () const
 Creates a shallow copy of the current object.
 
virtual xtd::string to_string () const noexcept
 Returns a xtd::string that represents the current object.
 
- Static Public Member Functions inherited from xtd::object
template<typename object_a_t , typename object_b_t >
static bool equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
 Determines whether the specified object instances are considered equal.
 
template<typename object_a_t , typename object_b_t >
static bool reference_equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
 Determines whether the specified object instances are the same instance.
 

Constructor & Destructor Documentation

◆ component()

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

Initialises a new instance of the component class.

Member Function Documentation

◆ can_raise_events()

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

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
protectednoexcept

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: