xtd::forms::shadow Class Reference

Inheritance diagram for xtd::forms::shadow:

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.

Public Constructors
	shadow ()
	Initializes a new instance of the xtd::forms::shadow class.
	shadow (int32 x, int32 y)
	Initializes a new instance of the xtd::forms::shadow class with the specified offset x, and offset y.
	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.
	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.
	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.
	shadow (const xtd::drawing::point &offset)
	Initializes a new instance of the xtd::forms::shadow class with the specified offset point.
	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.
	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.
	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.

Public Properties
const xtd::drawing::color &	color () const noexcept
	Gets the shadow color.
shadow &	color (const xtd::drawing::color &value) noexcept
	Sets the shadow color.
const xtd::drawing::point &	offset () const noexcept
	Gets the shadow offset in pixels.
shadow &	offset (const xtd::drawing::point &value) noexcept
	Sets the shadow offset point in pixels.
int32	radius () const noexcept
	Gets the shadow blurring radius in pixels.
shadow &	radius (int32 value) noexcept
	Sets the shadow blurring radius in pixels.
int32	x () const noexcept
	Gets the shadow offset x in pixels.
shadow &	x (int32 value) noexcept
	Sets the shadow offset x in pixels.
int32	y () const noexcept
	Gets the shadow offset y in pixels.
shadow &	y (int32 value) noexcept
	Sets the shadow offset y in pixels.

Public Methods
bool	equals (const shadow &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::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.
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.
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

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.

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

---

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

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