xtd::forms::style_sheets::shadow Class Reference

Inheritance diagram for xtd::forms::style_sheets::shadow:

Definition

The style specifies the shadow of text and elements.

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

Inheritance

xtd::object → xtd::forms::style_sheets::shadow

Implements

xtd::iequatable <>

Header

#include <xtd/forms/style_sheets/shadow>

Namespace

xtd::forms::style_sheets

Library

xtd.forms

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

Public Constructors
	shadow ()=default
	Initializes a new instance of the xtd::forms::style_sheets::shadow class.
	shadow (const xtd::drawing::point &offset, int32 radius, const xtd::drawing::color &color)
	Initializes a new instance of the xtd::forms::style_sheets::shadow class with the offset point, radius, and color.

Peorperties
auto	color () const noexcept -> const xtd::drawing::color &
	Gets the shadow color.
auto	color (const xtd::drawing::color &value) noexcept -> void
	Sets the shadow color.
auto	offset () const noexcept -> const xtd::drawing::point &
	Gets the shadow offset in pixels.
auto	offset (const xtd::drawing::point &value) noexcept -> void
	Sets the shadow offset point in pixels.
auto	radius () const noexcept -> xtd::int32
	Gets the shadow blurring radius in pixels.
auto	radius (xtd::int32 value) noexcept -> void
	Sets the shadow blurring radius in pixels.

Public Methods
auto	equals (const xtd::object &obj) const noexcept -> bool override
	Determines whether the specified object is equal to the current object.
auto	equals (const shadow &other) const noexcept -> bool override
	Determines whether the specified object is equal to the current object.
auto	get_hash_code () const noexcept -> xtd::usize override
	Serves as a hash function for a particular type.

Additional Inherited Members
virtual auto	equals (const shadow &) const noexcept -> bool=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 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	to_string () const -> xtd::string
	Returns a xtd::string that represents the current object.
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

shadow() [1/2]

xtd::forms::style_sheets::shadow::shadow ( )

default

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

shadow() [2/2]

xtd::forms::style_sheets::shadow::shadow	(	const xtd::drawing::point &	offset,
		int32	radius,
		const xtd::drawing::color &	color )

Initializes a new instance of the xtd::forms::style_sheets::shadow class with the offset point, radius, and color.

Parameters

offset	The shadow offset point in pixels.
radius	The shadow blurring radius.
color	The shadow color.

Member Function Documentation

color() [1/2]

auto xtd::forms::style_sheets::shadow::color ( ) const -> const xtd::drawing::color &

nodiscardnoexcept

Gets the shadow color.

Returns

The shadow color.

color() [2/2]

auto xtd::forms::style_sheets::shadow::color ( const xtd::drawing::color & value ) -> void

noexcept

Sets the shadow color.

Parameters

value

The shadow color.

offset() [1/2]

auto xtd::forms::style_sheets::shadow::offset ( ) const -> const xtd::drawing::point &

nodiscardnoexcept

Gets the shadow offset in pixels.

Returns

The shadow offset.

offset() [2/2]

auto xtd::forms::style_sheets::shadow::offset ( const xtd::drawing::point & value ) -> void

noexcept

Sets the shadow offset point in pixels.

Parameters

value

The shadow offset point.

radius() [1/2]

auto xtd::forms::style_sheets::shadow::radius ( ) const -> xtd::int32

nodiscardnoexcept

Gets the shadow blurring radius in pixels.

Returns

The shadow blurring radius.

radius() [2/2]

auto xtd::forms::style_sheets::shadow::radius ( xtd::int32 value ) -> void

noexcept

Sets the shadow blurring radius in pixels.

Parameters

value

The shadow blurring radius.

equals() [1/2]

auto xtd::forms::style_sheets::shadow::equals ( const xtd::object & obj ) const -> bool

nodiscardoverridevirtualnoexcept

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]

auto xtd::forms::style_sheets::shadow::equals ( const shadow & other ) const -> bool

nodiscardoverridenoexcept

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

auto xtd::forms::style_sheets::shadow::get_hash_code ( ) const -> xtd::usize

nodiscardoverridevirtualnoexcept

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 shadow xtd::forms::style_sheets::shadow::empty

static

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

---

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

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