xtd::forms::style_sheets::border_radius Class Reference

Inheritance diagram for xtd::forms::style_sheets::border_radius:

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

Inheritance

xtd::object → xtd::forms::style_sheets::border_radius

Implements

xtd::iequatable <>

Header

#include <xtd/forms/style_sheets/brer_rzdius>

Namespace

xtd::forms::style_sheets

Library

xtd.forms

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

Public Constructors
	border_radius ()=default
	Initializes a new instance of the xtd::forms::style_sheets::border_radius class.
	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.
	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.

Peorperties
xtd::forms::style_sheets::length	all () const noexcept
	Gets the xtd::forms::style_sheets::border_radius value for all the edges.
void	all (xtd::forms::style_sheets::length all) noexcept
	Sets the xtd::forms::style_sheets::border_radius value for all the edges.
xtd::forms::style_sheets::length	bottom_right () const noexcept
	Gets the xtd::forms::style_sheets::border_radius value for the bottom_right edge.
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.
xtd::forms::style_sheets::length	top_left () const noexcept
	Gets the xtd::forms::style_sheets::border_radius value for the top_left edge.
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.
xtd::forms::style_sheets::length	bottom_left () const noexcept
	Gets the xtd::forms::style_sheets::border_radius value for the bottom_left edge.
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.
xtd::forms::style_sheets::length	top_right () const noexcept
	Gets the xtd::forms::style_sheets::border_radius value for the top_right edge.
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.

Public Methods
bool	equals (const border_radius &other) const noexcept override
virtual bool	equals (const object &obj) const noexcept
	Determines whether the specified object is equal to the current 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.

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.
Public Member Functions inherited from xtd::object
	object ()=default
	Create a new instance of the ultimate base class 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<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.
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

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

all	The 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_left	The xtd::forms::style_sheets::border_radius size, in pixels, for the top_left edge.
top_right	The xtd::forms::style_sheets::border_radius size, in pixels, for the top_right edge.
bottom_right	The xtd::forms::style_sheets::border_radius size, in pixels, for the bottom_right edge.
bottom_left	The 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

all	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.

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_right

The 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_left

The xtd::forms::style_sheets::border_radius, in pixels, for the top_left edge.

Remarks

Setting this value can also alter the all property.

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_left

The xtd::forms::style_sheets::border_radius, in pixels, for the bottom_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_right

The xtd::forms::style_sheets::border_radius, in pixels, for the top_right edge.

Remarks

Setting this value can also alter the all property.

equals() [1/2]

virtual bool xtd::object::equals ( const object &  obj ) const

virtualnoexcept

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.

Examples

The following code example compares the current instance with another object.

#include <xtd/console>
 
using namespace xtd;
 
auto main() -> int {
  auto object1 = new_ptr<object>();
  auto object2 = new_ptr<object>();
  
  auto object3 = object2;
  console::write_line(object1->equals(*object3));
  console::write_line(*object1 == *object3);
  object3 = object1;
  console::write_line(object1->equals(*object3));
  console::write_line(*object1 == *object3);
}
 
// This code produces the following output :
//
// false
// false
// true
// true

Reimplemented from xtd::object.

equals() [2/2]

template<class object_a_t , class object_b_t >

static bool xtd::object::equals ( const object_a_t &  object_a, const object_b_t &  object_b  )

inlinestaticnoexcept

Determines whether the specified object instances are considered equal.

Parameters

object_a	The first object to compare.
object_b	The second object to compare.

Returns

true if object_a is the same instance as object_b or if both are null references or if object_a(object_b) returns true. otherwise, false.

Examples

The following code example compares different objects.

#include <xtd/console>
 
using namespace xtd;
 
auto main() -> int {
  string s1 = "Tom";
  string s2 = "Carol";
  console::write_line("object::equals(\"{0}\", \"{1}\") => {2}", s1, s2, object::equals(s1, s2));
  
  s1 = "Tom";
  s2 = "Tom";
  console::write_line("object::equals(\"{0}\", \"{1}\") => {2}", s1, s2, object::equals(s1, s2));
  
  s1 = "";
  s2 = "Tom";
  console::write_line("object::equals(\"{0}\", \"{1}\") => {2}", s1, s2, object::equals(s1, s2));
  
  s1 = "Carol";
  s2 = "";
  console::write_line("object::equals(\"{0}\", \"{1}\") => {2}", s1, s2, object::equals(s1, s2));
  
  s1 = "";
  s2 = "";
  console::write_line("object::equals(\"{0}\", \"{1}\") => {2}", s1, s2, object::equals(s1, s2));
}
 
// This code produces the following output :
//
// object::equals("Tom", "Carol") => false
// object::equals("Tom", "Tom") => true
// object::equals("", "Tom") => false
// object::equals("Carol", "") => false
// object::equals("", "") => true

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:

• xtd.forms/include/xtd/forms/style_sheets/border_radius.hpp