Inheritance diagram for xtd::forms::flat_button_appearance:

Definition

Provides properties that specify the appearance of xtd::forms::button controls whose xtd::forms::flat_style is xtd::forms::flat_style::flat.

Header: #include <xtd/forms/flat_button_appearance>

Namespace: xtd::forms

Library: xtd.forms

Examples: border_style.cpp, calculator.cpp, and flat_button.cpp.

Public Constructors
	flat_button_appearance ()
	Initializes a new instance of the xtd::forms::flat_button_appearance class.

Public Properties
std::optional< xtd::drawing::color >	border_color () const noexcept
	Gets the color of the border around the button.

flat_button_appearance &	border_color (const xtd::drawing::color &color)
	Sets the color of the border around the button.

flat_button_appearance &	border_color (std::nullptr_t color)
	Resets the color of the border around the button.

std::optional< int32 >	border_radius () const noexcept
	Gets a value that specifies the radius, in pixels, of the border around the button.

flat_button_appearance &	border_radius (int32 radius)
	Sets a value that specifies the radius, in pixels, of the border around the button.

flat_button_appearance &	border_radius (std::nullptr_t radius)
	Resets a value that specifies the radius, in pixels, of the border around the button.

std::optional< int32 >	border_size () const noexcept
	Gets a value that specifies the size, in pixels, of the border around the button.

flat_button_appearance &	border_size (int32 size)
	Sets a value that specifies the size, in pixels, of the border around the button.

flat_button_appearance &	border_size (std::nullptr_t size)
	Resets a value that specifies the size, in pixels, of the border around the button.

std::optional< xtd::drawing::color >	checked_back_color () const noexcept
	Gets the color of the client area of the button when the button is checked and the mouse pointer is outside the bounds of the control.

flat_button_appearance &	checked_back_color (const xtd::drawing::color &color)
	Sets the color of the client area of the button when the button is checked and the mouse pointer is outside the bounds of the control.

flat_button_appearance &	checked_back_color (std::nullptr_t color)
	Resets the color of the client area of the button when the button is checked and the mouse pointer is outside the bounds of the control.

std::optional< xtd::drawing::color >	mouse_down_back_color () const noexcept
	Gets the color of the client area of the button when the mouse is pressed within the bounds of the control.

flat_button_appearance &	mouse_down_back_color (const xtd::drawing::color &color)
	Sets the color of the client area of the button when the mouse is pressed within the bounds of the control.

flat_button_appearance &	mouse_down_back_color (std::nullptr_t color)
	Resets the color of the client area of the button when the mouse is pressed within the bounds of the control.

std::optional< xtd::drawing::color >	mouse_over_back_color () const noexcept
	Gets the color of the client area of the button when the mouse pointer is within the bounds of the control.

flat_button_appearance &	mouse_over_back_color (const xtd::drawing::color &color)
	Sets the color of the client area of the button when the mouse pointer is within the bounds of the control.

flat_button_appearance &	mouse_over_back_color (std::nullptr_t color)
	Resets the color of the client area of the button when the mouse pointer is within the bounds of the control.

Public Methods
bool	equals (const xtd::object &obj) const noexcept override
	Determines whether the specified object is equal to the current object.

bool	equals (const flat_button_appearance &other) const noexcept override
	Determines whether the specified object is equal to the current object.

xtd::size	get_hash_code () const noexcept override
	Serves as a hash function for a particular type.

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

virtual type_object	get_type () const noexcept
	Gets the type of the current instance.

template<class 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.

Public Member Functions inherited from xtd::iequatable< flat_button_appearance >
virtual bool	equals (const flat_button_appearance &) const noexcept=0
	Indicates whether the current object is equal to another object of the same type.

Static Public Member Functions inherited from xtd::object
template<class object_a_t , class 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<class object_a_t , class 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

◆ flat_button_appearance()

xtd::forms::flat_button_appearance::flat_button_appearance ( )

Initializes a new instance of the xtd::forms::flat_button_appearance class.

Member Function Documentation

◆ border_color() [1/3]

std::optional< xtd::drawing::color > xtd::forms::flat_button_appearance::border_color ( ) const

noexcept

Gets the color of the border around the button.

Returns: A xtd::drawing::color structure representing the color of the border around the button.

◆ border_color() [2/3]

flat_button_appearance & xtd::forms::flat_button_appearance::border_color ( const xtd::drawing::color & color )

Sets the color of the border around the button.

Parameters

color A xtd::drawing::color structure representing the color of the border around the button.

Returns: Current xtd::forms::flat_button_appearance.

◆ border_color() [3/3]

flat_button_appearance & xtd::forms::flat_button_appearance::border_color ( std::nullptr_t color )

Resets the color of the border around the button.

Parameters

color nullptr.

Returns: Current xtd::forms::flat_button_appearance.

◆ border_radius() [1/3]

std::optional< int32 > xtd::forms::flat_button_appearance::border_radius ( ) const

noexcept

Gets a value that specifies the radius, in pixels, of the border around the button.

Returns: An int32 representing the radius, in pixels, of the border around the button.

◆ border_radius() [2/3]

flat_button_appearance & xtd::forms::flat_button_appearance::border_radius ( int32 radius )

Sets a value that specifies the radius, in pixels, of the border around the button.

Parameters

size	An int32 representing the radius, in pixels, of the border around the button.

Returns: Current xtd::forms::flat_button_appearance.

◆ border_radius() [3/3]

flat_button_appearance & xtd::forms::flat_button_appearance::border_radius ( std::nullptr_t radius )

Resets a value that specifies the radius, in pixels, of the border around the button.

Parameters

size nullptr.

Returns: Current xtd::forms::flat_button_appearance.

◆ border_size() [1/3]

std::optional< int32 > xtd::forms::flat_button_appearance::border_size ( ) const

noexcept

Gets a value that specifies the size, in pixels, of the border around the button.

Returns: An int32 representing the size, in pixels, of the border around the button.

◆ border_size() [2/3]

flat_button_appearance & xtd::forms::flat_button_appearance::border_size ( int32 size )

Sets a value that specifies the size, in pixels, of the border around the button.

Parameters

size	An int32 representing the size, in pixels, of the border around the button.

Returns: Current xtd::forms::flat_button_appearance.

◆ border_size() [3/3]

flat_button_appearance & xtd::forms::flat_button_appearance::border_size ( std::nullptr_t size )

Resets a value that specifies the size, in pixels, of the border around the button.

Parameters

size nullptr.

Returns: Current xtd::forms::flat_button_appearance.

◆ checked_back_color() [1/3]

std::optional< xtd::drawing::color > xtd::forms::flat_button_appearance::checked_back_color ( ) const

noexcept

Gets the color of the client area of the button when the button is checked and the mouse pointer is outside the bounds of the control.

Returns: A xtd::drawing::color structure representing the color of the client area of the button.

Examples: border_style.cpp.

◆ checked_back_color() [2/3]

flat_button_appearance & xtd::forms::flat_button_appearance::checked_back_color ( const xtd::drawing::color & color )

Sets the color of the client area of the button when the button is checked and the mouse pointer is outside the bounds of the control.

Parameters

color A xtd::drawing::color structure representing the color of the client area of the button.structure representing the color of the client area of the button.

Returns: Current xtd::forms::flat_button_appearance.

◆ checked_back_color() [3/3]

flat_button_appearance & xtd::forms::flat_button_appearance::checked_back_color ( std::nullptr_t color )

Resets the color of the client area of the button when the button is checked and the mouse pointer is outside the bounds of the control.

Parameters

color nullptr.

Returns: Current flat_button_appearance.

◆ mouse_down_back_color() [1/3]

std::optional< xtd::drawing::color > xtd::forms::flat_button_appearance::mouse_down_back_color ( ) const

noexcept

Gets the color of the client area of the button when the mouse is pressed within the bounds of the control.

Returns: A xtd::drawing::color structure representing the color of the client area of the button.

◆ mouse_down_back_color() [2/3]

flat_button_appearance & xtd::forms::flat_button_appearance::mouse_down_back_color ( const xtd::drawing::color & color )

Sets the color of the client area of the button when the mouse is pressed within the bounds of the control.

Parameters

color A xtd::drawing::color structure representing the color of the client area of the button.

Returns: Current xtd::forms::flat_button_appearance.

◆ mouse_down_back_color() [3/3]

flat_button_appearance & xtd::forms::flat_button_appearance::mouse_down_back_color ( std::nullptr_t color )

Resets the color of the client area of the button when the mouse is pressed within the bounds of the control.

Parameters

color nullptr.

Returns: Current xtd::forms::flat_button_appearance.

◆ mouse_over_back_color() [1/3]

std::optional< xtd::drawing::color > xtd::forms::flat_button_appearance::mouse_over_back_color ( ) const

noexcept

Gets the color of the client area of the button when the mouse pointer is within the bounds of the control.

Returns: A xtd::drawing::color structure representing the color of the client area of the button.

◆ mouse_over_back_color() [2/3]

flat_button_appearance & xtd::forms::flat_button_appearance::mouse_over_back_color ( const xtd::drawing::color & color )

Sets the color of the client area of the button when the mouse pointer is within the bounds of the control.

Parameters

color A xtd::drawing::color structure representing the color of the client area of the button.

Returns: Current xtd::forms::flat_button_appearance.

◆ mouse_over_back_color() [3/3]

flat_button_appearance & xtd::forms::flat_button_appearance::mouse_over_back_color ( std::nullptr_t color )

Resets the color of the client area of the button when the mouse pointer is within the bounds of the control.

Parameters

color nullptr.

Returns: Current xtd::forms::flat_button_appearance.

◆ equals() [1/2]

bool xtd::forms::flat_button_appearance::equals ( const xtd::object & obj ) const

overridevirtualnoexcept

Determines whether the specified object is equal to the current object.

Parameters

obj	The object to compare with the current object.

Returns: true if the specified object is equal to the current object. otherwise, false.

Reimplemented from xtd::object.

◆ equals() [2/2]

bool xtd::forms::flat_button_appearance::equals ( const flat_button_appearance & other ) const

overridenoexcept

Determines whether the specified object is equal to the current object.

Parameters

other The object to compare with the current object.

Returns: true if the specified object is equal to the current object. otherwise, false.

◆ get_hash_code()

xtd::size xtd::forms::flat_button_appearance::get_hash_code ( ) const

overridevirtualnoexcept

Serves as a hash function for a particular type.

Returns: A hash code for the current object.

Reimplemented from xtd::object.

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

xtd.forms/include/xtd/forms/flat_button_appearance.hpp

Definition

Public Constructors

Public Properties

Public Methods

Additional Inherited Members

Constructor & Destructor Documentation

◆ flat_button_appearance()

Member Function Documentation

◆ border_color() [1/3]

◆ border_color() [2/3]

◆ border_color() [3/3]

◆ border_radius() [1/3]

◆ border_radius() [2/3]

◆ border_radius() [3/3]

◆ border_size() [1/3]

◆ border_size() [2/3]

◆ border_size() [3/3]

◆ checked_back_color() [1/3]

◆ checked_back_color() [2/3]

◆ checked_back_color() [3/3]

◆ mouse_down_back_color() [1/3]

◆ mouse_down_back_color() [2/3]

◆ mouse_down_back_color() [3/3]

◆ mouse_over_back_color() [1/3]

◆ mouse_over_back_color() [2/3]

◆ mouse_over_back_color() [3/3]

◆ equals() [1/2]

◆ equals() [2/2]

◆ get_hash_code()