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
const xtd::drawing::color &	color () const noexcept
	Gets the shadow color.
void	color (const xtd::drawing::color &value) noexcept
	Sets the shadow color.
const xtd::drawing::point &	offset () const noexcept
	Gets the shadow offset in pixels.
void	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.
void	radius (int32 value) noexcept
	Sets the shadow blurring radius 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::iequatable< shadow >
virtual bool	equals (const shadow &) const noexcept=0
	Indicates whether the current object is equal to another object of the same type.
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.
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/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]

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

noexcept

Gets the shadow color.

Returns

The shadow color.

color() [2/2]

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

noexcept

Sets the shadow color.

Parameters

value

The shadow color.

offset() [1/2]

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

noexcept

Gets the shadow offset in pixels.

Returns

The shadow offset.

offset() [2/2]

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

noexcept

Sets the shadow offset point in pixels.

Parameters

value

The shadow offset point.

radius() [1/2]

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

noexcept

Gets the shadow blurring radius in pixels.

Returns

The shadow blurring radius.

radius() [2/2]

void xtd::forms::style_sheets::shadow::radius ( int32  value )

noexcept

Sets the shadow blurring radius in pixels.

Parameters

value

The shadow blurring radius.

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

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.h