Inheritance diagram for xtd::forms::padding:

Definition

Represents a display device or multiple display devices on a single system.

Header: #include <xtd/forms/padding>

Namespace: xtd::forms

Library: xtd.forms

Public Fields
static const padding	empty
	Provides a Padding object with no padding.

Public Constructors
	padding ()=default
	Initializes a new instance of the padding class.
	padding (int32 all)
	Initializes a new instance of the padding class using the supplied padding size for all edges.
	padding (int32 left, int32 top, int32 right, int32 bottom)
	Initializes a new instance of the padding class using a separate padding size for each edge.

Peorperties
int32	all () const noexcept
	Gets the padding value for all the edges.
void	all (int32 all)
	Sets the padding value for all the edges.
int32	bottom () const noexcept
	Gets the padding value for the bottom edge.
void	bottom (int32 bottom)
	Sets the padding value for the bottom edge.
int32	horizontal () const noexcept
	Gets the combined padding for the right and left edges.
int32	left () const noexcept
	Gets the padding value for the left edge.
void	left (int32 left)
	Sets the padding value for the left edge.
int32	right () const noexcept
	Gets the padding value for the right edge.
void	right (int32 right)
	Sets the padding value for the right edge.
int32	top () const noexcept
	Gets the padding value for the top edge.
void	top (int32 top)
	Sets the padding value for the top edge.
int32	vertical () const noexcept
	Gets the combined padding for the bottom and top edges.

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 padding &other) const noexcept override
	Determines whether the specified object is equal to the current object.
xtd::usize	get_hash_code () const noexcept override
	Serves as a hash function for a particular type.
xtd::string	to_string () const noexcept override
	Returns a string that represents the current padding.

Public Static Methods
static padding	add (const padding &p1, const padding &p2)
	Computes the sum of the two specified padding values.
static padding	subtract (const padding &p1, const padding &p2)
	Subtracts one specified Padding value from another.

Additional Inherited Members
	object ()=default
	Create a new instance of the ultimate base class object.
virtual auto	get_type () const noexcept -> type_object
	Gets the type of the current instance.
template<typename object_t>
auto	memberwise_clone () const -> xtd::unique_ptr_object< object_t >
	Creates a shallow copy of the current object.
virtual auto	equals (const padding &) const noexcept -> bool=0
	Indicates whether the current object is equal to another object of the same type.
template<typename object_a_t, typename object_b_t>
static auto	equals (const object_a_t &object_a, const object_b_t &object_b) noexcept -> bool
	Determines whether the specified object instances are considered equal.
template<typename object_a_t, typename object_b_t>
static auto	reference_equals (const object_a_t &object_a, const object_b_t &object_b) noexcept -> bool
	Determines whether the specified object instances are the same instance.

Constructor & Destructor Documentation

◆ padding() [1/3]

xtd::forms::padding::padding ( )

default

Initializes a new instance of the padding class.

◆ padding() [2/3]

xtd::forms::padding::padding ( int32 all )

Initializes a new instance of the padding class using the supplied padding size for all edges.

Parameters

all	The number of pixels to be used for padding for all edges.

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

◆ padding() [3/3]

xtd::forms::padding::padding	(	int32	left,
		int32	top,
		int32	right,
		int32	bottom )

Initializes a new instance of the padding class using a separate padding size for each edge.

Parameters

left	The padding size, in pixels, for the left edge.
top	The padding size, in pixels, for the top edge.
right	The padding size, in pixels, for the right edge.
bottom	The padding size, in pixels, 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]

int32 xtd::forms::padding::all ( ) const

noexcept

Gets the padding value for all the edges.

Returns: The padding, in pixels, for all edges if the same; otherwise, -1.

Remarks: When retrieving this property, if all the edges use the same padding value, then this common value is returned. Otherwise, -1 is returned to indicate that all the padding values are not equal.

◆ all() [2/2]

void xtd::forms::padding::all ( int32 all )

Sets the padding value for all the edges.

Parameters

all	The padding, in pixels, for all edges if the same; otherwise, -1.

Remarks: When retrieving this property, if all the edges use the same padding value, then this common value is returned. Otherwise, -1 is returned to indicate that all the padding values are not equal.

◆ bottom() [1/2]

int32 xtd::forms::padding::bottom ( ) const

noexcept

Gets the padding value for the bottom edge.

Returns: The padding, in pixels, for the bottom edge.

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

◆ bottom() [2/2]

void xtd::forms::padding::bottom ( int32 bottom )

Sets the padding value for the bottom edge.

Parameters

bottom The padding, in pixels, for the bottom edge.

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

◆ horizontal()

int32 xtd::forms::padding::horizontal ( ) const

noexcept

Gets the combined padding for the right and left edges.

Returns: Gets the sum, in pixels, of the left and right padding values.

◆ left() [1/2]

int32 xtd::forms::padding::left ( ) const

noexcept

Gets the padding value for the left edge.

Returns: The padding, in pixels, for the left edge.

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

◆ left() [2/2]

void xtd::forms::padding::left ( int32 left )

Sets the padding value for the left edge.

Parameters

left	The padding, in pixels, for the left edge.

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

◆ right() [1/2]

int32 xtd::forms::padding::right ( ) const

noexcept

Gets the padding value for the right edge.

Returns: The padding, in pixels, for the right edge.

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

◆ right() [2/2]

void xtd::forms::padding::right ( int32 right )

Sets the padding value for the right edge.

Parameters

right The padding, in pixels, for the right edge.

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

◆ top() [1/2]

int32 xtd::forms::padding::top ( ) const

noexcept

Gets the padding value for the top edge.

Returns: The padding, in pixels, for the top edge.

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

◆ top() [2/2]

void xtd::forms::padding::top ( int32 top )

Sets the padding value for the top edge.

Parameters

top	The padding, in pixels, for the top edge.

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

◆ vertical()

int32 xtd::forms::padding::vertical ( ) const

noexcept

Gets the combined padding for the bottom and top edges.

Parameters

p1	A padding.
p2	A padding.

Returns: Gets the sum, in pixels, of the top and bottom padding values.

◆ equals() [1/2]

bool xtd::forms::padding::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::padding::equals ( const padding & 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::usize xtd::forms::padding::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.

◆ to_string()

xtd::string xtd::forms::padding::to_string ( ) const

overridevirtualnoexcept

Returns a string that represents the current padding.

Returns: A string that represents the current padding.

Remarks: This method returns a string containing the labeled values of the padding for all four edges.

Reimplemented from xtd::object.

◆ add()

padding xtd::forms::padding::add	(	const padding &	p1,
		const padding &	p2 )

static

Computes the sum of the two specified padding values.

Returns: A padding that contains the sum of the two specified padding values.

◆ subtract()

padding xtd::forms::padding::subtract	(	const padding &	p1,
		const padding &	p2 )

static

Subtracts one specified Padding value from another.

Parameters

p1	A padding.
p2	A padding.

Returns: A padding that contains the result of the subtraction of one specified padding value from another.

Member Data Documentation

◆ empty

const padding xtd::forms::padding::empty

static

Provides a Padding object with no padding.

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

xtd.forms/include/xtd/forms/padding.hpp

Definition

Public Fields

Public Constructors

Peorperties

Public Methods

Public Static Methods

Additional Inherited Members

Constructor & Destructor Documentation

◆ padding() [1/3]

◆ padding() [2/3]

◆ padding() [3/3]

Member Function Documentation

◆ all() [1/2]

◆ all() [2/2]

◆ bottom() [1/2]

◆ bottom() [2/2]

◆ horizontal()

◆ left() [1/2]

◆ left() [2/2]

◆ right() [1/2]

◆ right() [2/2]

◆ top() [1/2]

◆ top() [2/2]

◆ vertical()

◆ equals() [1/2]

◆ equals() [2/2]

◆ get_hash_code()

◆ to_string()

◆ add()

◆ subtract()

Member Data Documentation

◆ empty