xtd::forms::style_sheets::border_color Class Reference

Inheritance diagram for xtd::forms::style_sheets::border_color:

Definition

The xtd::forms::style_sheets::border_color is used to set the color of the borders.

class forms_export_ border_color : public xtd::iequatable<border_color>, public xtd::object

Inheritance

xtd::object → xtd::forms::style_sheets::border_color

Implements

xtd::iequatable <>

Header

#include <xtd/forms/style_sheets/border_color>

Namespace

xtd::forms::style_sheets

Library

xtd.forms

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

Public Constructors
	border_color ()=default
	Initializes a new instance of the xtd::forms::style_sheets::border_color class.
	border_color (const xtd::drawing::color &all)
	Initializes a new instance of the xtd::forms::style_sheets::border_color class using the supplied border_color for all edges.
	border_color (const xtd::drawing::color &left, const xtd::drawing::color &top, const xtd::drawing::color &right, const xtd::drawing::color &bottom)
	Initializes a new instance of the xtd::forms::style_sheets::border_color class using a separate border_color for each edge.

Peorperties
const xtd::drawing::color &	all () const noexcept
	Gets the xtd::forms::style_sheets::border_color value for all the edges.
void	all (const xtd::drawing::color &all) noexcept
	Sets the xtd::forms::style_sheets::border_color value for all the edges.
const xtd::drawing::color &	bottom () const noexcept
	Gets the xtd::forms::style_sheets::border_color value for the bottom edge.
void	bottom (const xtd::drawing::color &bottom) noexcept
	Sets the xtd::forms::style_sheets::border_color value for the bottom edge.
const xtd::drawing::color &	left () const noexcept
	Gets the xtd::forms::style_sheets::border_color value for the left edge.
void	left (const xtd::drawing::color &left) noexcept
	Sets the xtd::forms::style_sheets::border_color value for the left edge.
const xtd::drawing::color &	right () const noexcept
	Gets the xtd::forms::style_sheets::border_color value for the right edge.
void	right (const xtd::drawing::color &right) noexcept
	Sets the xtd::forms::style_sheets::border_color value for the right edge.
const xtd::drawing::color &	top () const noexcept
	Gets the xtd::forms::style_sheets::border_color value for the top edge.
void	top (const xtd::drawing::color &top) noexcept
	Sets the xtd::forms::style_sheets::border_color value for the top edge.

Public Methods
bool	equals (const border_color &other) const noexcept override
virtual bool	equals (const object &obj) const noexcept
	Determines whether the specified object is equal to the current object.
template<typename object_a_t , typename 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_color >
virtual bool	equals (const border_color &) 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<typename 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<typename object_a_t , typename 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<typename object_a_t , typename 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_color() [1/3]

xtd::forms::style_sheets::border_color::border_color ( )

default

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

border_color() [2/3]

xtd::forms::style_sheets::border_color::border_color ( const xtd::drawing::color &  all )

explicit

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

Parameters

all	The xtd::forms::style_sheets::color_data to be used for border_color for all edges.

Remarks

This constructor sets the right, left, bottom, top and all properties to the value of the all parameter.

border_color() [3/3]

xtd::forms::style_sheets::border_color::border_color	(	const xtd::drawing::color &	left,
		const xtd::drawing::color &	top,
		const xtd::drawing::color &	right,
		const xtd::drawing::color &	bottom
	)

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

Parameters

left	The border_color for the left edge.
top	The border_color for the top edge.
right	The border_color for the right edge.
bottom	The border_color for the bottom 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]

const xtd::drawing::color & xtd::forms::style_sheets::border_color::all ( ) const

noexcept

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

Returns

The xtd::forms::style_sheets::border_color for all edges if the same; otherwise, xtd::forms::style_sheets::color_data::empty.

Remarks

When retrieving this property, if all the edges use the same border_color value, then this common value is returned. Otherwise, xtd::forms::style_sheets::color_data::empty is returned to indicate that all the xtd::forms::style_sheets::border_color values are not equal.

all() [2/2]

void xtd::forms::style_sheets::border_color::all ( const xtd::drawing::color &  all )

noexcept

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

Parameters

all	The xtd::forms::style_sheets::border_color for all edges if the same; otherwise, xtd::forms::style_sheets::color_data::empty.

Remarks

When retrieving this property, if all the edges use the same border_color value, then this common value is returned. Otherwise, xtd::forms::style_sheets::color_data::empty is returned to indicate that all the xtd::forms::style_sheets::border_color values are not equal.

bottom() [1/2]

const xtd::drawing::color & xtd::forms::style_sheets::border_color::bottom ( ) const

noexcept

Gets the xtd::forms::style_sheets::border_color value for the bottom edge.

Returns

The xtd::forms::style_sheets::border_color for the bottom edge.

Remarks

Setting this value can also alter the all property.

bottom() [2/2]

void xtd::forms::style_sheets::border_color::bottom ( const xtd::drawing::color &  bottom )

noexcept

Sets the xtd::forms::style_sheets::border_color value for the bottom edge.

Parameters

bottom

The xtd::forms::style_sheets::border_color for the bottom edge.

Remarks

Setting this value can also alter the all property.

left() [1/2]

const xtd::drawing::color & xtd::forms::style_sheets::border_color::left ( ) const

noexcept

Gets the xtd::forms::style_sheets::border_color value for the left edge.

Returns

The xtd::forms::style_sheets::border_color for the left edge.

Remarks

Setting this value can also alter the all property.

left() [2/2]

void xtd::forms::style_sheets::border_color::left ( const xtd::drawing::color &  left )

noexcept

Sets the xtd::forms::style_sheets::border_color value for the left edge.

Parameters

left	The xtd::forms::style_sheets::border_color for the left edge.

Remarks

Setting this value can also alter the all property.

right() [1/2]

const xtd::drawing::color & xtd::forms::style_sheets::border_color::right ( ) const

noexcept

Gets the xtd::forms::style_sheets::border_color value for the right edge.

Returns

The xtd::forms::style_sheets::border_color for the right edge.

Remarks

Setting this value can also alter the all property.

right() [2/2]

void xtd::forms::style_sheets::border_color::right ( const xtd::drawing::color &  right )

noexcept

Sets the xtd::forms::style_sheets::border_color value for the right edge.

Parameters

right

The xtd::forms::style_sheets::border_color for the right edge.

Remarks

Setting this value can also alter the all property.

top() [1/2]

const xtd::drawing::color & xtd::forms::style_sheets::border_color::top ( ) const

noexcept

Gets the xtd::forms::style_sheets::border_color value for the top edge.

Returns

The xtd::forms::style_sheets::border_color for the top edge.

Remarks

Setting this value can also alter the all property.

top() [2/2]

void xtd::forms::style_sheets::border_color::top ( const xtd::drawing::color &  top )

noexcept

Sets the xtd::forms::style_sheets::border_color value for the top edge.

Parameters

top	The xtd::forms::style_sheets::border_color for the top 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<typename object_a_t , typename 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_color xtd::forms::style_sheets::border_color::empty

static

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

---

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

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