xtd::drawing::brush Class Reference

Inheritance diagram for xtd::drawing::brush:

Definition

Defines objects used to fill the interiors of graphical shapes such as rectangles, ellipses, pies, polygons, and paths.

class drawing_export_ brush : public xtd::object

Inheritance

xtd::object → xtd::drawing::brush

Namespace

xtd::drawing

Library

xtd.drawing

Remarks

This is an abstract base class and cannot be instantiated. To create a brush object, use classes derived from xtd::drawing::brush, such as xtd::drawing::solid_brush, xtd::drawing::texture_brush, xtd::drawing::drawing_2d::hatch_brush, xtd::drawing::drawing_2d::conical_gradient_brush, xtd::drawing::drawing_2d::linear_gradient_brush, and xtd::drawing::drawing_2d::radial_gradient_brush.

xtd::drawing::solid_brush	xtd::drawing::texture_brush	xtd::drawing::drawing_2d::hatch_brush
xtd::drawing::drawing_2d::conical_gradient_brush	xtd::drawing::drawing_2d::linear_gradient_brush	xtd::drawing::drawing_2d::radial_gradient_brush

Public Properties
auto	handle () const noexcept -> intptr
	Gets the handle of the brush.

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 brush &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
	Converts this brush object to a human-readable string.

Protected constructors
	brush ()
	Initialize a new instance of brush class.

Protected Methods
auto	set_native_brush (intptr brush) -> void
	In a derived class, sets a reference to a GDI+ brush object.

Additional Inherited Members
	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	equals (const brush &) const noexcept -> bool=0
	Indicates whether the current object is equal to another object of the same type.
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

brush()

xtd::drawing::brush::brush ( )

protected

Initialize a new instance of brush class.

Member Function Documentation

handle()

auto xtd::drawing::brush::handle ( ) const -> intptr

nodiscardnoexcept

Gets the handle of the brush.

Returns

An intptr that contains the handle of the brush.

equals() [1/2]

auto xtd::drawing::brush::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::drawing::brush::equals ( const brush & 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::drawing::brush::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::drawing::brush::to_string ( ) const -> xtd::string

nodiscardoverridevirtualnoexcept

Converts this brush object to a human-readable string.

Returns

A string that represents this brush object.

Reimplemented from xtd::object.

set_native_brush()

auto xtd::drawing::brush::set_native_brush ( intptr brush ) -> void

protected

In a derived class, sets a reference to a GDI+ brush object.

Parameters

brush

A pointer to the GDI+ brush object.

---

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

• xtd.drawing/include/xtd/drawing/brush.hpp