Inheritance diagram for xtd::forms::style_sheets::border_style:

Definition

The style specifies what kind of borders to display.

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

xtd::forms::style_sheets::border_style::border_style

border_style()=default

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

xtd::iequatable

Defines a generalized method that a value type or class implements to create a type-specific method f...

Definition iequatable.hpp:22

xtd::object

Supports all classes in the xtd class hierarchy and provides low-level services to derived classes....

Definition object.hpp:45

forms_export_

#define forms_export_

Define shared library export.

Definition forms_export.hpp:13

Inheritance: xtd::object → xtd::forms::style_sheets::border_style

Implements: xtd::iequatable <>

Header: #include <xtd/forms/style_sheets/border_style>

Namespace: xtd::forms::style_sheets

Library: xtd.forms

Public Fields
static const border_style	empty
	Provides a xtd::forms::style_sheets::border_style object with no xtd::forms::style_sheets::border_style.

Public Constructors
	border_style ()=default
	Initializes a new instance of the xtd::forms::style_sheets::border_style class.

	border_style (border_type all)
	Initializes a new instance of the xtd::forms::style_sheets::border_style class using the supplied xtd::forms::style_sheets::border_style size for all edges.

	border_style (border_type left, border_type top, border_type right, border_type bottom)
	Initializes a new instance of the xtd::forms::style_sheets::border_style class using a separate xtd::forms::style_sheets::border_style size for each edge.

Peorperties
border_type	all () const noexcept
	Gets the xtd::forms::style_sheets::border_style value for all the edges.

void	all (border_type all) noexcept
	Sets the xtd::forms::style_sheets::border_style value for all the edges.

border_type	bottom () const
	Gets the xtd::forms::style_sheets::border_style value for the bottom edge.

void	bottom (border_type bottom) noexcept
	Sets the xtd::forms::style_sheets::border_style value for the bottom edge.

border_type	left () const noexcept
	Gets the xtd::forms::style_sheets::border_style value for the left edge.

void	left (border_type left) noexcept
	Sets the xtd::forms::style_sheets::border_style value for the left edge.

border_type	right () const noexcept
	Gets the xtd::forms::style_sheets::border_style value for the right edge.

void	right (border_type right)
	Sets the xtd::forms::style_sheets::border_style value for the right edge.

border_type	top () const noexcept
	Gets the xtd::forms::style_sheets::border_style value for the top edge.

void	top (border_type top) noexcept
	Sets the xtd::forms::style_sheets::border_style value for the top edge.

Public Methods
bool	equals (const xtd::object &obj) const noexcept override
	Determines whether the specified object is equal to the current object.

bool	equals (const border_style &other) const noexcept override
	Determines whether the specified object is equal to the current object.

xtd::size	get_hash_code () const noexcept override
	Serves as a hash function for a particular type.

Additional Inherited Members
virtual bool	equals (const border_style &) const noexcept=0
	Indicates whether the current object is equal to another object of the same type.

	object ()=default
	Create a new instance of the ultimate base class object.

virtual type_object	get_type () const noexcept
	Gets the type of the current instance.

template<class object_t>
xtd::unique_ptr_object< 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.

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_style() [1/3]

xtd::forms::style_sheets::border_style::border_style ( )

default

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

◆ border_style() [2/3]

xtd::forms::style_sheets::border_style::border_style ( border_type all )

explicit

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

Parameters

all	The number of pixels to be used for xtd::forms::style_sheets::border_style for all edges.

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

◆ border_style() [3/3]

xtd::forms::style_sheets::border_style::border_style	(	border_type	left,
		border_type	top,
		border_type	right,
		border_type	bottom )

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

Parameters

left	The xtd::forms::style_sheets::border_style size for the left edge.
top	The xtd::forms::style_sheets::border_style size for the top edge.
right	The xtd::forms::style_sheets::border_style size for the right edge.
bottom	The xtd::forms::style_sheets::border_style size 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]

border_type xtd::forms::style_sheets::border_style::all ( ) const

noexcept

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

Returns: The xtd::forms::style_sheets::border_style 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_style value, then this common value is returned. Otherwise, -1 is returned to indicate that all the xtd::forms::style_sheets::border_style values are not equal.

◆ all() [2/2]

void xtd::forms::style_sheets::border_style::all ( border_type all )

noexcept

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

Parameters

all	The xtd::forms::style_sheets::border_style 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_style value, then this common value is returned. Otherwise, -1 is returned to indicate that all the xtd::forms::style_sheets::border_style values are not equal.

◆ bottom() [1/2]

border_type xtd::forms::style_sheets::border_style::bottom ( ) const

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

Returns: The xtd::forms::style_sheets::border_style for the bottom edge.

Remarks: Setting this value can also alter the all property.

◆ bottom() [2/2]

void xtd::forms::style_sheets::border_style::bottom ( border_type bottom )

noexcept

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

Parameters

bottom The xtd::f noexceptorms::style_sheets::border_style for the bottom edge.

Remarks: Setting this value can also alter the all property.

◆ left() [1/2]

border_type xtd::forms::style_sheets::border_style::left ( ) const

noexcept

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

Returns: The xtd::forms::style_sheets::border_style for the left edge.

Remarks: Setting this value can also alter the all property.

◆ left() [2/2]

void xtd::forms::style_sheets::border_style::left ( border_type left )

noexcept

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

Parameters

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

Remarks: Setting this value can also alter the all property.

◆ right() [1/2]

border_type xtd::forms::style_sheets::border_style::right ( ) const

noexcept

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

Returns: The xtd::forms::style_sheets::border_style for the right edge.

Remarks: Setting this value can also alter the all property.

◆ right() [2/2]

void xtd::forms::style_sheets::border_style::right ( border_type right )

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

Parameters

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

Remarks: Setting this value can also alter the all property.

◆ top() [1/2]

border_type xtd::forms::style_sheets::border_style::top ( ) const

noexcept

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

Returns: The xtd::forms::style_sheets::border_style for the top edge.

Remarks: Setting this value can also alter the all property.

◆ top() [2/2]

void xtd::forms::style_sheets::border_style::top ( border_type top )

noexcept

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

Parameters

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

Remarks: Setting this value can also alter the all property.

◆ equals() [1/2]

bool xtd::forms::style_sheets::border_style::equals ( const xtd::object & obj ) const

overridevirtualnoexcept

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]

bool xtd::forms::style_sheets::border_style::equals ( const border_style & other ) const

overridenoexcept

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

xtd::size xtd::forms::style_sheets::border_style::get_hash_code ( ) const

overridevirtualnoexcept

Serves as a hash function for a particular type.

Returns: A hash code for the current object.

Reimplemented from xtd::object.

Member Data Documentation

◆ empty

const border_style xtd::forms::style_sheets::border_style::empty

static

Provides a xtd::forms::style_sheets::border_style object with no xtd::forms::style_sheets::border_style.

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

xtd.forms/include/xtd/forms/style_sheets/border_style.hpp

Definition

Public Fields

Public Constructors

Peorperties

Public Methods

Additional Inherited Members

Constructor & Destructor Documentation

◆ border_style() [1/3]

◆ border_style() [2/3]

◆ border_style() [3/3]

Member Function Documentation

◆ all() [1/2]

◆ all() [2/2]

◆ bottom() [1/2]

◆ bottom() [2/2]

◆ left() [1/2]

◆ left() [2/2]

◆ right() [1/2]

◆ right() [2/2]

◆ top() [1/2]

◆ top() [2/2]

◆ equals() [1/2]

◆ equals() [2/2]

◆ get_hash_code()

Member Data Documentation

◆ empty