xtd::forms::style_sheets::background_image Class Reference

Inheritance diagram for xtd::forms::style_sheets::background_image:

Definition

The image data allows you to specify the url or gradient mode.

class forms_export_ background_image : public xtd::object

Inheritance

xtd::object → xtd::forms::style_sheets::background_image

Header

#include <xtd/forms/style_sheets/background_image>

Namespace

xtd::forms::style_sheets

Library

xtd.forms

Remarks

This class is used by xtd::forms::style_sheets::ibox_model.

Public Fields
static const background_image	empty
	Provides an empty xtd::forms::style_sheets::background_image object.

Public Constructors
	background_image ()=default
	Initializes a new instance of the xtd::forms::style_sheets::background_image class.
	background_image (const xtd::string &url)
	Initializes a new instance of the xtd::forms::style_sheets::background_image class with specified url.
	background_image (const xtd::array< xtd::drawing::color > &colors)
	Initializes a new instance of the xtd::forms::style_sheets::background_image class with specified colors array.
	background_image (const xtd::array< xtd::drawing::color > &colors, xtd::int32 angle)
	Initializes a new instance of the xtd::forms::style_sheets::background_image class with specified colors and angle.
	background_image (xtd::forms::style_sheets::image_type image_typeimage_type, const xtd::array< xtd::drawing::color > &colors)
	Initializes a new instance of the xtd::forms::style_sheets::background_image class with specified style and colors.
	background_image (xtd::forms::style_sheets::image_type image_typeimage_type, const xtd::array< xtd::drawing::color > &colors, xtd::int32 angle)
	Initializes a new instance of the xtd::forms::style_sheets::background_image class with specified style, colors and angle.

Public Properties
auto	angle () const noexcept -> xtd::int32
	Gets the angle specifies the gradient direction.
auto	angle (xtd::int32 value) noexcept -> void
	Sets the angle specifies the gradient direction.
auto	colors () const noexcept -> const xtd::array< xtd::drawing::color > &
	Gets the colors specifies what colors to display.
auto	colors (const xtd::array< xtd::drawing::color > &value) -> void
	Sets the colors that specifies what colors to display.
auto	url () const noexcept -> const xtd::uri &
	Gets the url of image to display.
auto	url (const xtd::uri &value) noexcept -> void
	Sets the url of image to display.
auto	image_type () const noexcept -> xtd::forms::style_sheets::image_type
	Gets the image type that specifies what kind of image to display.
auto	image_type (xtd::forms::style_sheets::image_type value) noexcept -> void
	Sets the style specifies what kind of image to display.

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 background_image &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.
auto	to_string () const noexcept -> xtd::string override
	Returns a xtd::string that represents the current object.

Public Static Methods
static auto	make_brush (const xtd::forms::style_sheets::background_image &image, const xtd::drawing::rectangle &rect) -> xtd::uptr< xtd::drawing::brush >
	Creates a xtd::drawing::brush from specified image data and rectangle.

Additional Inherited Members
virtual auto	equals (const background_image &) 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.
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

background_image() [1/6]

xtd::forms::style_sheets::background_image::background_image ( )

default

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

Remarks

The following table shows the default values for the properties :

Property	Default value
xtd::forms::style_sheets::background_image::angle	180
xtd::forms::style_sheets::background_image::colors	An array with one color : xtd::drawing::color::black)
xtd::forms::style_sheets::background_image::image_type	xtd::forms::style_sheets::image_type::none
xtd::forms::style_sheets::background_image::url	An empty tring ("")

A value of 0 for angle is equivalent to "to top", a value of 90 for rangle is equivalent to "to right". a value of 180 for angle is equivalent to "to bottom", ...

background_image() [2/6]

xtd::forms::style_sheets::background_image::background_image ( const xtd::string & url )

explicit

Initializes a new instance of the xtd::forms::style_sheets::background_image class with specified url.

Parameters

url

The url of image to display. Property Default value xtd::forms::style_sheets::background_image::angle 180 xtd::forms::style_sheets::background_image::colors An array with one color : xtd::drawing::color::black) xtd::forms::style_sheets::background_image::image_type xtd::forms::style_sheets::image_type::url

Remarks

A value of 0 for angle is equivalent to "to top", a value of 90 for rangle is equivalent to "to right". a value of 180 for angle is equivalent to "to bottom", ...

background_image() [3/6]

xtd::forms::style_sheets::background_image::background_image ( const xtd::array< xtd::drawing::color > & colors )

explicit

Initializes a new instance of the xtd::forms::style_sheets::background_image class with specified colors array.

Parameters

color

The colors that specifies the color for gradient image to display. Property Default value xtd::forms::style_sheets::background_image::angle 180 xtd::forms::style_sheets::background_image::image_type xtd::forms::style_sheets::image_type::linera_gradient xtd::forms::style_sheets::background_image::url An empty tring ("")

Remarks

A value of 0 for angle is equivalent to "to top", a value of 90 for rangle is equivalent to "to right". a value of 180 for angle is equivalent to "to bottom", ...

background_image() [4/6]

xtd::forms::style_sheets::background_image::background_image	(	const xtd::array< xtd::drawing::color > &	colors,
		xtd::int32	angle )

Initializes a new instance of the xtd::forms::style_sheets::background_image class with specified colors and angle.

Parameters

color	The colors that specifies the color for gradient image to display.
angle	The angle specifies the gradient direction.

Remarks

A value of 0 for angle is equivalent to "to top", a value of 90 for rangle is equivalent to "to right". a value of 180 for angle is equivalent to "to bottom", ...

Exceptions

xtd::argument_exception

colors is less than 2.

background_image() [5/6]

xtd::forms::style_sheets::background_image::background_image	(	xtd::forms::style_sheets::image_type	image_type,
		const xtd::array< xtd::drawing::color > &	colors )

Initializes a new instance of the xtd::forms::style_sheets::background_image class with specified style and colors.

Parameters

image_type	The style specifies what kind of image to display.
color	The colors that specifies the color for gradient image to display.

Remarks

A value of 0 for angle is equivalent to "to top", a value of 90 for rangle is equivalent to "to right". a value of 180 for angle is equivalent to "to bottom", ...

Exceptions

xtd::argument_exception	colors is less than 2.
xtd::not_supported_exception	if xtd::forms::style_sheets::background_image::image_type is not of xtd::forms::style_sheets::image_type::url and not xtd::forms::style_sheets::image_type::linear_gradient.

background_image() [6/6]

xtd::forms::style_sheets::background_image::background_image	(	xtd::forms::style_sheets::image_type	image_type,
		const xtd::array< xtd::drawing::color > &	colors,
		xtd::int32	angle )

Initializes a new instance of the xtd::forms::style_sheets::background_image class with specified style, colors and angle.

Parameters

image_type	The style specifies what kind of image to display.
color	The colors that specifies the color for gradient image to display.
angle	The angle specifies the gradient direction.

Remarks

A value of 0 for angle is equivalent to "to top", a value of 90 for rangle is equivalent to "to right". a value of 180 for angle is equivalent to "to bottom", ...

Exceptions

xtd::argument_exception	colors is less than 2.
xtd::not_supported_exception	if xtd::forms::style_sheets::background_image::image_type is not of xtd::forms::style_sheets::image_type::url and not xtd::forms::style_sheets::image_type::linear_gradient.

Member Function Documentation

angle() [1/2]

auto xtd::forms::style_sheets::background_image::angle ( ) const -> xtd::int32

nodiscardnoexcept

Gets the angle specifies the gradient direction.

Returns

The angle specifies the gradient direction.

Remarks

A value of 0 for angle is equivalent to "to top", a value of 90 for rangle is equivalent to "to right". a value of 180 for angle is equivalent to "to bottom", ...

angle() [2/2]

auto xtd::forms::style_sheets::background_image::angle ( xtd::int32 value ) -> void

noexcept

Sets the angle specifies the gradient direction.

Parameters

value

The angle specifies the gradient direction.

Remarks

A value of 0 for angle is equivalent to "to top", a value of 90 for rangle is equivalent to "to right". a value of 180 for angle is equivalent to "to bottom", ...

colors() [1/2]

auto xtd::forms::style_sheets::background_image::colors ( ) const -> const xtd::array< xtd::drawing::color > &

nodiscardnoexcept

Gets the colors specifies what colors to display.

Returns

The colors specifies what colors to display.

Remarks

For xtd::forms::style_sheets::image_type::color, only the first color is used.

colors() [2/2]

auto xtd::forms::style_sheets::background_image::colors

(

const xtd::array< xtd::drawing::color > &

value

)

-> void

Sets the colors that specifies what colors to display.

Parameters

value

The colors specifies what colors to display.

Remarks

For xtd::forms::style_sheets::image_type::color, only the first color is used.

Exceptions

xtd::argument_exception

colors is less than 2.

url() [1/2]

auto xtd::forms::style_sheets::background_image::url ( ) const -> const xtd::uri &

nodiscardnoexcept

Gets the url of image to display.

Returns

The url of image to display.

url() [2/2]

auto xtd::forms::style_sheets::background_image::url ( const xtd::uri & value ) -> void

noexcept

Sets the url of image to display.

Parameters

value

The url of image to display.

image_type() [1/2]

auto xtd::forms::style_sheets::background_image::image_type ( ) const -> xtd::forms::style_sheets::image_type

nodiscardnoexcept

Gets the image type that specifies what kind of image to display.

Returns

The image type tht specifies what kind of image to display.

image_type() [2/2]

auto xtd::forms::style_sheets::background_image::image_type ( xtd::forms::style_sheets::image_type value ) -> void

noexcept

Sets the style specifies what kind of image to display.

Parameters

value

The style specifies what kind of image to display.

equals() [1/2]

auto xtd::forms::style_sheets::background_image::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::background_image::equals ( const background_image & 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::background_image::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.

to_string()

auto xtd::forms::style_sheets::background_image::to_string ( ) const -> xtd::string

nodiscardoverridevirtualnoexcept

Returns a xtd::string that represents the current object.

Returns

A string that represents the current object.

Examples

The following code example demonstrates what to_string returns.

#include <xtd/xtd>
 
namespace examples {
  namespace object_test {
    class object1 : public object {
    };
  }
}
 
auto main() -> int {
  ptr<object> obj1 = new_ptr<examples::object_test::object1>();
  console::write_line(obj1->to_string());
 
  ptr<object> obj2 = new_ptr<date_time>(1971, 1, 5, 23, 5, 0);
  console::write_line(obj2->to_string());
 
  ptr<object> obj3 = new_ptr<boolean_object>();
  console::write_line(obj3->to_string());
}
 
// This code produces the following output :
//
// examples::object_test::object1
// Tue Jan  5 23:05:00 1971
// false

Reimplemented from xtd::object.

make_brush()

auto xtd::forms::style_sheets::background_image::make_brush ( const xtd::forms::style_sheets::background_image & image, const xtd::drawing::rectangle & rect ) -> xtd::uptr< xtd::drawing::brush >

staticnodiscard

Creates a xtd::drawing::brush from specified image data and rectangle.

Parameters

image	Contains image data.
rect	The xtd::drawing::rectangle neeed for linear gradient brush

Returns

New instance of brush.

Member Data Documentation

empty

const background_image xtd::forms::style_sheets::background_image::empty

static

Provides an empty xtd::forms::style_sheets::background_image object.

---

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

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