xtd 0.2.0
xtd::forms::style_sheets::border_radius Class Reference
Inheritance diagram for xtd::forms::style_sheets::border_radius:
xtd::iequatable< border_radius > xtd::object xtd::interface

Definition

The radius is used to add rounded borders to an element.

class forms_export_ border_radius : public xtd::iequatable<border_radius>, public xtd::object
border_radius()=default
Initializes a new instance of the xtd::forms::style_sheets::border_radius class.
Defines a generalized method that a value type or class implements to create a type-specific method f...
Definition: iequatable.h:18
Supports all classes in the xtd class hierarchy and provides low-level services to derived classes....
Definition: object.h:32
#define forms_export_
Define shared library export.
Definition: forms_export.h:13
Inheritance
xtd::objectxtd::forms::style_sheets::border_radius
Implements
xtd::iequatable <>
Header
#include <xtd/forms/style_sheets/brer_rzdius>
Namespace
xtd::forms::style_sheets
Library
xtd.forms

Fields

static const border_radius empty
 Provides an empty xtd::forms::style_sheets::border_radius object. More...
 

Constructors

 border_radius ()=default
 Initializes a new instance of the xtd::forms::style_sheets::border_radius class. More...
 
 border_radius (xtd::forms::style_sheets::length all)
 Initializes a new instance of the xtd::forms::style_sheets::border_radius class using the supplied xtd::forms::style_sheets::border_radius size for all edges. More...
 
 border_radius (xtd::forms::style_sheets::length top_left, xtd::forms::style_sheets::length top_right, xtd::forms::style_sheets::length bottom_right, xtd::forms::style_sheets::length bottom_left)
 Initializes a new instance of the xtd::forms::style_sheets::border_radius class using a separate xtd::forms::style_sheets::border_radius size for each edge. More...
 

Peorperties

xtd::forms::style_sheets::length all () const noexcept
 Gets the xtd::forms::style_sheets::border_radius value for all the edges. More...
 
void all (xtd::forms::style_sheets::length all) noexcept
 Sets the xtd::forms::style_sheets::border_radius value for all the edges. More...
 
xtd::forms::style_sheets::length bottom_right () const noexcept
 Gets the xtd::forms::style_sheets::border_radius value for the bottom_right edge. More...
 
void bottom_right (xtd::forms::style_sheets::length bottom_right) noexcept
 Sets the xtd::forms::style_sheets::border_radius value for the bottom_right edge. More...
 
xtd::forms::style_sheets::length top_left () const noexcept
 Gets the xtd::forms::style_sheets::border_radius value for the top_left edge. More...
 
void top_left (xtd::forms::style_sheets::length top_left) noexcept
 Sets the xtd::forms::style_sheets::border_radius value for the top_left edge. More...
 
xtd::forms::style_sheets::length bottom_left () const noexcept
 Gets the xtd::forms::style_sheets::border_radius value for the bottom_left edge. More...
 
void bottom_left (xtd::forms::style_sheets::length bottom_left) noexcept
 Sets the xtd::forms::style_sheets::border_radius value for the bottom_left edge. More...
 
xtd::forms::style_sheets::length top_right () const noexcept
 Gets the xtd::forms::style_sheets::border_radius value for the top_right edge. More...
 
void top_right (xtd::forms::style_sheets::length top_right) noexcept
 Sets the xtd::forms::style_sheets::border_radius value for the top_right edge. More...
 

Methods

bool equals (const border_radius &other) const noexcept override
 

Additional Inherited Members

- Public Member Functions inherited from xtd::iequatable< border_radius >
virtual bool equals (const border_radius &) const noexcept=0
 Indicates whether the current object is equal to another object of the same type. More...
 
- 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...
 
- 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

◆ border_radius() [1/3]

xtd::forms::style_sheets::border_radius::border_radius ( )
default

Initializes a new instance of the xtd::forms::style_sheets::border_radius class.

◆ border_radius() [2/3]

xtd::forms::style_sheets::border_radius::border_radius ( xtd::forms::style_sheets::length  all)
explicit

Initializes a new instance of the xtd::forms::style_sheets::border_radius class using the supplied xtd::forms::style_sheets::border_radius size for all edges.

Parameters
allThe number of pixels to be used for xtd::forms::style_sheets::border_radius for all edges.
Remarks
This constructor sets the bottom_left, top_left, bottom_right, top_right and all properties to the value of the all parameter.

◆ border_radius() [3/3]

xtd::forms::style_sheets::border_radius::border_radius ( xtd::forms::style_sheets::length  top_left,
xtd::forms::style_sheets::length  top_right,
xtd::forms::style_sheets::length  bottom_right,
xtd::forms::style_sheets::length  bottom_left 
)

Initializes a new instance of the xtd::forms::style_sheets::border_radius class using a separate xtd::forms::style_sheets::border_radius size for each edge.

Parameters
top_leftThe xtd::forms::style_sheets::border_radius size, in pixels, for the top_left edge.
top_rightThe xtd::forms::style_sheets::border_radius size, in pixels, for the top_right edge.
bottom_rightThe xtd::forms::style_sheets::border_radius size, in pixels, for the bottom_right edge.
bottom_leftThe xtd::forms::style_sheets::border_radius size, in pixels, for the bottom_left edge.
Remarks
If all of the parameter values are equal, then the all property will reflect this common value.

Member Function Documentation

◆ all() [1/2]

xtd::forms::style_sheets::length xtd::forms::style_sheets::border_radius::all ( ) const
noexcept

Gets the xtd::forms::style_sheets::border_radius value for all the edges.

Returns
The xtd::forms::style_sheets::border_radius, in pixels, for all edges if the same; otherwise, -1.
Remarks
When retrieving this property, if all the edges use the same xtd::forms::style_sheets::border_radius value, then this common value is returned. Otherwise, -1 is returned to indicate that all the xtd::forms::style_sheets::border_radius values are not equal.

◆ all() [2/2]

void xtd::forms::style_sheets::border_radius::all ( xtd::forms::style_sheets::length  all)
noexcept

Sets the xtd::forms::style_sheets::border_radius value for all the edges.

Parameters
allThe xtd::forms::style_sheets::border_radius, in pixels, for all edges if the same; otherwise, -1.
Remarks
When retrieving this property, if all the edges use the same xtd::forms::style_sheets::border_radius value, then this common value is returned. Otherwise, -1 is returned to indicate that all the xtd::forms::style_sheets::border_radius values are not equal.

◆ bottom_left() [1/2]

xtd::forms::style_sheets::length xtd::forms::style_sheets::border_radius::bottom_left ( ) const
noexcept

Gets the xtd::forms::style_sheets::border_radius value for the bottom_left edge.

Returns
The xtd::forms::style_sheets::border_radius, in pixels, for the bottom_left edge.
Remarks
Setting this value can also alter the all property.

◆ bottom_left() [2/2]

void xtd::forms::style_sheets::border_radius::bottom_left ( xtd::forms::style_sheets::length  bottom_left)
noexcept

Sets the xtd::forms::style_sheets::border_radius value for the bottom_left edge.

Parameters
bottom_leftThe xtd::forms::style_sheets::border_radius, in pixels, for the bottom_left edge.
Remarks
Setting this value can also alter the all property.

◆ bottom_right() [1/2]

xtd::forms::style_sheets::length xtd::forms::style_sheets::border_radius::bottom_right ( ) const
noexcept

Gets the xtd::forms::style_sheets::border_radius value for the bottom_right edge.

Returns
The xtd::forms::style_sheets::border_radius, in pixels, for the bottom_right edge.
Remarks
Setting this value can also alter the all property.

◆ bottom_right() [2/2]

void xtd::forms::style_sheets::border_radius::bottom_right ( xtd::forms::style_sheets::length  bottom_right)
noexcept

Sets the xtd::forms::style_sheets::border_radius value for the bottom_right edge.

Parameters
bottom_rightThe xtd::forms::style_sheets::border_radius, in pixels, for the bottom_right edge.
Remarks
Setting this value can also alter the all property.

◆ top_left() [1/2]

xtd::forms::style_sheets::length xtd::forms::style_sheets::border_radius::top_left ( ) const
noexcept

Gets the xtd::forms::style_sheets::border_radius value for the top_left edge.

Returns
The xtd::forms::style_sheets::border_radius, in pixels, for the top_left edge.
Remarks
Setting this value can also alter the all property.

◆ top_left() [2/2]

void xtd::forms::style_sheets::border_radius::top_left ( xtd::forms::style_sheets::length  top_left)
noexcept

Sets the xtd::forms::style_sheets::border_radius value for the top_left edge.

Parameters
top_leftThe xtd::forms::style_sheets::border_radius, in pixels, for the top_left edge.
Remarks
Setting this value can also alter the all property.

◆ top_right() [1/2]

xtd::forms::style_sheets::length xtd::forms::style_sheets::border_radius::top_right ( ) const
noexcept

Gets the xtd::forms::style_sheets::border_radius value for the top_right edge.

Returns
The xtd::forms::style_sheets::border_radius, in pixels, for the top_right edge.
Remarks
Setting this value can also alter the all property.

◆ top_right() [2/2]

void xtd::forms::style_sheets::border_radius::top_right ( xtd::forms::style_sheets::length  top_right)
noexcept

Sets the xtd::forms::style_sheets::border_radius value for the top_right edge.

Parameters
top_rightThe xtd::forms::style_sheets::border_radius, in pixels, for the top_right edge.
Remarks
Setting this value can also alter the all property.

Member Data Documentation

◆ empty

const border_radius xtd::forms::style_sheets::border_radius::empty
static

Provides an empty xtd::forms::style_sheets::border_radius object.


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