xtd::forms::flat_button_appearance Class Reference

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

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

Public Properties
auto	border_color () const noexcept -> std::optional< xtd::drawing::color >
	Gets the color of the border around the button.
auto	border_color (const xtd::drawing::color &value) -> flat_button_appearance &
	Sets the color of the border around the button.
auto	border_color (xtd::null_ptr) -> flat_button_appearance &
	Resets the color of the border around the button.
auto	border_radius () const noexcept -> std::optional< xtd::int32 >
	Gets a value that specifies the radius, in pixels, of the border around the button.
auto	border_radius (xtd::int32 value) -> flat_button_appearance &
	Sets a value that specifies the radius, in pixels, of the border around the button.
auto	border_radius (xtd::null_ptr) -> flat_button_appearance &
	Resets a value that specifies the radius, in pixels, of the border around the button.
auto	border_size () const noexcept -> std::optional< xtd::int32 >
	Gets a value that specifies the size, in pixels, of the border around the button.
auto	border_size (xtd::int32 value) -> flat_button_appearance &
	Sets a value that specifies the size, in pixels, of the border around the button.
auto	border_size (xtd::null_ptr) -> flat_button_appearance &
	Resets a value that specifies the size, in pixels, of the border around the button.
auto	checked_back_color () const noexcept -> std::optional< xtd::drawing::color >
	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.
auto	checked_back_color (const xtd::drawing::color &value) -> flat_button_appearance &
	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.
auto	checked_back_color (xtd::null_ptr) -> flat_button_appearance &
	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.
auto	mouse_down_back_color () const noexcept -> std::optional< xtd::drawing::color >
	Gets the color of the client area of the button when the mouse is pressed within the bounds of the control.
auto	mouse_down_back_color (const xtd::drawing::color &value) -> flat_button_appearance &
	Sets the color of the client area of the button when the mouse is pressed within the bounds of the control.
auto	mouse_down_back_color (xtd::null_ptr) -> flat_button_appearance &
	Resets the color of the client area of the button when the mouse is pressed within the bounds of the control.
auto	mouse_over_back_color () const noexcept -> std::optional< xtd::drawing::color >
	Gets the color of the client area of the button when the mouse pointer is within the bounds of the control.
auto	mouse_over_back_color (const xtd::drawing::color &value) -> flat_button_appearance &
	Sets the color of the client area of the button when the mouse pointer is within the bounds of the control.
auto	mouse_over_back_color (xtd::null_ptr) -> flat_button_appearance &
	Resets the color of the client area of the button when the mouse pointer is within the bounds of the control.

Public Methods
auto	equals (const xtd::object &obj) const noexcept -> bool override
	Determines whether the specified object is equal to the current object.
auto	equals (const flat_button_appearance &other) const noexcept -> bool override
	Determines whether the specified object is equal to the current object.
auto	get_hash_code () const noexcept -> xtd::usize override
	Serves as a hash function for a particular type.

Additional Inherited Members
	object ()=default
	Create a new instance of the ultimate base class object.
virtual auto	get_type () const noexcept -> type_object
	Gets the type of the current instance.
template<typename object_t>
auto	memberwise_clone () const -> xtd::unique_ptr_object< object_t >
	Creates a shallow copy of the current object.
virtual auto	to_string () const -> xtd::string
	Returns a xtd::string that represents the current object.
virtual auto	equals (const flat_button_appearance &) const noexcept -> bool=0
	Indicates whether the current object is equal to another object of the same type.
template<typename object_a_t, typename object_b_t>
static auto	equals (const object_a_t &object_a, const object_b_t &object_b) noexcept -> bool
	Determines whether the specified object instances are considered equal.
template<typename object_a_t, typename object_b_t>
static auto	reference_equals (const object_a_t &object_a, const object_b_t &object_b) noexcept -> bool
	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]

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

nodiscardnoexcept

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]

auto xtd::forms::flat_button_appearance::border_color

(

const xtd::drawing::color &

value

)

-> flat_button_appearance &

Sets the color of the border around the button.

Parameters

value

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]

auto xtd::forms::flat_button_appearance::border_color

(

xtd::null_ptr

)

-> flat_button_appearance &

Resets the color of the border around the button.

Parameters

xtd::null.

Returns

Current xtd::forms::flat_button_appearance.

border_radius() [1/3]

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

nodiscardnoexcept

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]

auto xtd::forms::flat_button_appearance::border_radius

(

xtd::int32

value

)

-> flat_button_appearance &

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

Parameters

value

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

Returns

Current xtd::forms::flat_button_appearance.

border_radius() [3/3]

auto xtd::forms::flat_button_appearance::border_radius

(

xtd::null_ptr

)

-> flat_button_appearance &

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

Parameters

xtd::null.

Returns

Current xtd::forms::flat_button_appearance.

border_size() [1/3]

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

nodiscardnoexcept

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]

auto xtd::forms::flat_button_appearance::border_size

(

xtd::int32

value

)

-> flat_button_appearance &

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

Parameters

value

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

Returns

Current xtd::forms::flat_button_appearance.

border_size() [3/3]

auto xtd::forms::flat_button_appearance::border_size

(

xtd::null_ptr

)

-> flat_button_appearance &

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

Parameters

xtd::null.

Returns

Current xtd::forms::flat_button_appearance.

checked_back_color() [1/3]

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

nodiscardnoexcept

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.

checked_back_color() [2/3]

auto xtd::forms::flat_button_appearance::checked_back_color

(

const xtd::drawing::color &

value

)

-> flat_button_appearance &

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

value

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]

auto xtd::forms::flat_button_appearance::checked_back_color

(

xtd::null_ptr

)

-> flat_button_appearance &

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

xtd::null.

Returns

Current flat_button_appearance.

mouse_down_back_color() [1/3]

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

nodiscardnoexcept

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]

auto xtd::forms::flat_button_appearance::mouse_down_back_color

(

const xtd::drawing::color &

value

)

-> flat_button_appearance &

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

Parameters

value

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]

auto xtd::forms::flat_button_appearance::mouse_down_back_color

(

xtd::null_ptr

)

-> flat_button_appearance &

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

Parameters

xtd::null.

Returns

Current xtd::forms::flat_button_appearance.

mouse_over_back_color() [1/3]

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

nodiscardnoexcept

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]

auto xtd::forms::flat_button_appearance::mouse_over_back_color

(

const xtd::drawing::color &

value

)

-> flat_button_appearance &

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

Parameters

value

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]

auto xtd::forms::flat_button_appearance::mouse_over_back_color

(

xtd::null_ptr

)

-> flat_button_appearance &

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

Parameters

xtd::null.

Returns

Current xtd::forms::flat_button_appearance.

equals() [1/2]

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

nodiscardoverridevirtualnoexcept

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]

auto xtd::forms::flat_button_appearance::equals ( const flat_button_appearance & other ) const -> bool

nodiscardoverridenoexcept

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()

auto xtd::forms::flat_button_appearance::get_hash_code ( ) const -> xtd::usize

nodiscardoverridevirtualnoexcept

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