xtd 0.2.0
xtd::forms::flat_button_appearance Class Reference

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.

Constructors

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

Properties

std::optional< xtd::drawing::colorborder_color () const noexcept
 Gets the color of the border around the button. More...
 
flat_button_appearanceborder_color (const xtd::drawing::color &color)
 Sets the color of the border around the button. More...
 
flat_button_appearanceborder_color (std::nullptr_t color)
 Resets the color of the border around the button. More...
 
std::optional< int32border_radius () const noexcept
 Gets a value that specifies the radius, in pixels, of the border around the button. More...
 
flat_button_appearanceborder_radius (int32 radius)
 Sets a value that specifies the radius, in pixels, of the border around the button. More...
 
flat_button_appearanceborder_radius (std::nullptr_t radius)
 Resets a value that specifies the radius, in pixels, of the border around the button. More...
 
std::optional< int32border_size () const noexcept
 Gets a value that specifies the size, in pixels, of the border around the button. More...
 
flat_button_appearanceborder_size (int32 size)
 Sets a value that specifies the size, in pixels, of the border around the button. More...
 
flat_button_appearanceborder_size (std::nullptr_t size)
 Resets a value that specifies the size, in pixels, of the border around the button. More...
 
std::optional< xtd::drawing::colorchecked_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. More...
 
flat_button_appearancechecked_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. More...
 
flat_button_appearancechecked_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. More...
 
std::optional< xtd::drawing::colormouse_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. More...
 
flat_button_appearancemouse_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. More...
 
flat_button_appearancemouse_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. More...
 
std::optional< xtd::drawing::colormouse_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. More...
 
flat_button_appearancemouse_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. More...
 
flat_button_appearancemouse_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. More...
 

Methods

bool equals (const flat_button_appearance &other) const noexcept override
 

Additional Inherited Members

- Public Member Functions inherited from xtd::object
 object ()=default
 Create a new instance of the ultimate base class object. More...
 
bool equals (const object &obj) const noexcept
 Determines whether the specified object is equal to the current object. More...
 
virtual size_t get_hash_code () const noexcept
 Serves as a hash function for a particular type. More...
 
virtual type_object get_type () const noexcept
 Gets the type of the current instance. More...
 
template<typename object_t >
std::unique_ptr< object_t > memberwise_clone () const noexcept
 Creates a shallow copy of the current object. More...
 
virtual xtd::ustring to_string () const noexcept
 Returns a sxd::ustring that represents the current object. More...
 
- 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. More...
 
- 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. More...
 
static bool reference_equals (const object &object_a, const object &object_b) noexcept
 Determines whether the specified object instances are the same instance. More...
 

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
colorA 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
colornullptr.
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
sizeAn 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
sizenullptr.
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
sizeAn 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
sizenullptr.
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.

◆ 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
colorA 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
colornullptr.
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
colorA 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
colornullptr.
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
colorA 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
colornullptr.
Returns
Current xtd::forms::flat_button_appearance.

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