Definition

Represents a shadow within a xtd::forms::shadow_label control.

Header: #include <xtd/forms/shadow>

Namespace: xtd::forms

Library: xtd.forms

Remarks: The xtd::forms::shadow_label::shadow class defines the properties of a shadow within a xtd::forms::shadow_label control. You can use these properties to provide data to the xtd::forms::shadow_label::shadow_clicked event of the xtd::forms::shadow_label control to perform tasks when the shadow is clicked in the control. The xtd::forms::shadow_label::shadow_data property enables you to define information that the xtd::forms::shadow_label::shadow_clicked event can use to display a URL within your web browser or to open a file.; In addition to information related to the shadow, the properties of the xtd::forms::shadow_label::shadow class also help define the text of the xtd::forms::shadow_label::lLink and its display state. The xtd::forms::shadow_label::start and xtd::forms::shadow_label::length properties define the location and length of text from the text of the xtd::forms::shadow_label control to display as a shadow. The xtd::forms::shadow_label::enabled property allows you to display the shadow as a disabled shadow, and the xtd::forms::shadow_label::visited property can alert the user that they already visited the specified shadow in the current instance of the xtd::forms::shadow_label.; You can display multiple shadows in a single xtd::forms::shadow_label control. Each xtd::forms::shadow_label::shadow is added into the xtd::forms::shadow_label::shadow_collection associated with the xtd::forms::shadow_label control. To obtain the collection of shadows defined in a xtd::forms::shadow_label control, use the xtd::forms::shadow_label::shadows property.

Constructors
	shadow ()
	Initializes a new instance of the xtd::forms::shadow class. More...

	shadow (int32 x, int32 y)
	Initializes a new instance of the xtd::forms::shadow class with the specified offset x, and offset y. More...

	shadow (int32 x, int32 y, int32 radius)
	Initializes a new instance of the xtd::forms::shadow class with the specified offset x, offset y, and radius. More...

	shadow (int32 x, int32 y, const xtd::drawing::color &color)
	Initializes a new instance of the xtd::forms::shadow class with the specified offset x, offset y and color. More...

	shadow (int32 x, int32 y, int32 radius, const xtd::drawing::color &color)
	Initializes a new instance of the xtd::forms::shadow class with the specified offset x, offset y, and color. More...

	shadow (const xtd::drawing::point &offset)
	Initializes a new instance of the xtd::forms::shadow class with the specified offset point. More...

	shadow (const xtd::drawing::point &offset, int32 radius)
	Initializes a new instance of the xtd::forms::shadow class with the specified offset point, and radius. More...

	shadow (const xtd::drawing::point &offset, const xtd::drawing::color &color)
	Initializes a new instance of the xtd::forms::shadow class with the specified offset point, and color. More...

	shadow (const xtd::drawing::point &offset, int32 radius, const xtd::drawing::color &color)
	Initializes a new instance of the xtd::forms::shadow class with the specified offset point, radius, and color. More...

Properties
const xtd::drawing::color &	color () const noexcept
	Gets the shadow color. More...

shadow &	color (const xtd::drawing::color &value) noexcept
	Sets the shadow color. More...

const xtd::drawing::point &	offset () const noexcept
	Gets the shadow offset in pixels. More...

shadow &	offset (const xtd::drawing::point &value) noexcept
	Sets the shadow offset point in pixels. More...

int32	radius () const noexcept
	Gets the shadow blurring radius in pixels. More...

shadow &	radius (int32 value) noexcept
	Sets the shadow blurring radius in pixels. More...

int32	x () const noexcept
	Gets the shadow offset x in pixels. More...

shadow &	x (int32 value) noexcept
	Sets the shadow offset x in pixels. More...

int32	y () const noexcept
	Gets the shadow offset y in pixels. More...

shadow &	y (int32 value) noexcept
	Sets the shadow offset y in pixels. More...

Methods
bool	equals (const shadow &other) const noexcept override

Additional Inherited Members
Public Member Functions inherited from xtd::object
	object ()=default
	Create a new instance of the ultimate base class object. More...

bool	equals (const object &obj) const noexcept
	Determines whether the specified object is equal to the current object. More...

virtual size_t	get_hash_code () const noexcept
	Serves as a hash function for a particular type. More...

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

template<typename object_t >
std::unique_ptr< object_t >	memberwise_clone () const noexcept
	Creates a shallow copy of the current object. More...

virtual xtd::ustring	to_string () const noexcept
	Returns a sxd::ustring that represents the current object. More...

Public Member Functions inherited from xtd::iequatable< shadow >
virtual bool	equals (const shadow &) const noexcept=0
	Indicates whether the current object is equal to another object of the same type. More...

Static Public Member Functions inherited from xtd::object
static bool	equals (const object &object_a, const object &object_b) noexcept
	Determines whether the specified object instances are considered equal. More...

static bool	reference_equals (const object &object_a, const object &object_b) noexcept
	Determines whether the specified object instances are the same instance. More...

Constructor & Destructor Documentation

◆ shadow() [1/9]

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

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

Remarks

When you create an instance of xtd::forms::shadow, the following read/write properties are set to initial values.

Property	Initial Value
color	xtd::application::style_sheet().system_colors().shadow_text()
offset x	2
offset y	2
radius	0

◆ shadow() [2/9]

xtd::forms::shadow::shadow	(	int32	x,
		int32	y
	)

Initializes a new instance of the xtd::forms::shadow class with the specified offset x, and offset y.

Parameters

x	The shadow offset x in pixels.
y	The shadow offset y in pixels.

◆ shadow() [3/9]

xtd::forms::shadow::shadow	(	int32	x,
		int32	y,
		int32	radius
	)

Initializes a new instance of the xtd::forms::shadow class with the specified offset x, offset y, and radius.

Parameters

x	The shadow offset x in pixels.
y	The shadow offset y in pixels.
radius	The shadow blurring radius.

◆ shadow() [4/9]

xtd::forms::shadow::shadow	(	int32	x,
		int32	y,
		const xtd::drawing::color &	color
	)

Initializes a new instance of the xtd::forms::shadow class with the specified offset x, offset y and color.

Parameters

x	The shadow offset x in pixels.
y	The shadow offset y in pixels.

◆ shadow() [5/9]

xtd::forms::shadow::shadow	(	int32	x,
		int32	y,
		int32	radius,
		const xtd::drawing::color &	color
	)

Initializes a new instance of the xtd::forms::shadow class with the specified offset x, offset y, and color.

Parameters

x	The shadow offset x in pixels.
y	The shadow offset y in pixels.
radius	The shadow blurring radius.

◆ shadow() [6/9]

xtd::forms::shadow::shadow ( const xtd::drawing::point & offset )

explicit

Initializes a new instance of the xtd::forms::shadow class with the specified offset point.

Parameters

offset The shadow offset point in pixels.

◆ shadow() [7/9]

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

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

Parameters

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

◆ shadow() [8/9]

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

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

Parameters

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

◆ shadow() [9/9]

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

Initializes a new instance of the xtd::forms::shadow class with the specified 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]

const xtd::drawing::color& xtd::forms::shadow::color ( ) const

noexcept

Gets the shadow color.

Returns: The shadow color.

◆ color() [2/2]

shadow& xtd::forms::shadow::color ( const xtd::drawing::color & value )

noexcept

Sets the shadow color.

Parameters

value The shadow color.

Returns: This current instance.

◆ offset() [1/2]

const xtd::drawing::point& xtd::forms::shadow::offset ( ) const

noexcept

Gets the shadow offset in pixels.

Returns: The shadow offset.

◆ offset() [2/2]

shadow& xtd::forms::shadow::offset ( const xtd::drawing::point & value )

noexcept

Sets the shadow offset point in pixels.

Parameters

value The shadow offset point.

Returns: This current instance.

◆ radius() [1/2]

int32 xtd::forms::shadow::radius ( ) const

noexcept

Gets the shadow blurring radius in pixels.

Returns: The shadow blurring radius.

◆ radius() [2/2]

shadow& xtd::forms::shadow::radius ( int32 value )

noexcept

Sets the shadow blurring radius in pixels.

Parameters

value The shadow blurring radius.

Returns: This current instance.

◆ x() [1/2]

int32 xtd::forms::shadow::x ( ) const

noexcept

Gets the shadow offset x in pixels.

Returns: The shadow offset x.

◆ x() [2/2]

shadow& xtd::forms::shadow::x ( int32 value )

noexcept

Sets the shadow offset x in pixels.

Parameters

value The shadow offset x.

Returns: This current instance.

◆ y() [1/2]

int32 xtd::forms::shadow::y ( ) const

noexcept

Gets the shadow offset y in pixels.

Returns: The shadow offset y.

◆ y() [2/2]

shadow& xtd::forms::shadow::y ( int32 value )

noexcept

Sets the shadow offset y in pixels.

Parameters

value The shadow offset y.

Returns: This current instance.

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

xtd.forms/include/xtd/forms/shadow.h

Definition

Constructors

Properties

Methods

Additional Inherited Members

Constructor & Destructor Documentation

◆ shadow() [1/9]

◆ shadow() [2/9]

◆ shadow() [3/9]

◆ shadow() [4/9]

◆ shadow() [5/9]

◆ shadow() [6/9]

◆ shadow() [7/9]

◆ shadow() [8/9]

◆ shadow() [9/9]

Member Function Documentation

◆ color() [1/2]

◆ color() [2/2]

◆ offset() [1/2]

◆ offset() [2/2]

◆ radius() [1/2]

◆ radius() [2/2]

◆ x() [1/2]

◆ x() [2/2]

◆ y() [1/2]

◆ y() [2/2]