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
intptr	handle () const noexcept
	Gets the handle of the brush.

Public Methods
bool	equals (const xtd::object &obj) const noexcept override
	Determines whether the specified object is equal to the current object.
bool	equals (const brush &other) const noexcept override
	Determines whether the specified object is equal to the current object.
xtd::size	get_hash_code () const noexcept override
	Serves as a hash function for a particular type.
xtd::string	to_string () const noexcept override
	Converts this brush object to a human-readable string.

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

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

Additional Inherited Members
Public Member Functions inherited from xtd::object
	object ()=default
	Create a new instance of the ultimate base class object.
virtual type_object	get_type () const noexcept
	Gets the type of the current instance.
template<class object_t >
xtd::uptr< object_t >	memberwise_clone () const
	Creates a shallow copy of the current object.
Public Member Functions inherited from xtd::iequatable< brush >
virtual bool	equals (const brush &) 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<class object_a_t , class 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<class object_a_t , class 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

brush()

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

protected

Initialize a new instance of brush class.

Member Function Documentation

handle()

intptr xtd::drawing::brush::handle ( ) const

noexcept

Gets the handle of the brush.

Returns

An intptr that contains the handle of the brush.

equals() [1/2]

bool xtd::drawing::brush::equals ( const xtd::object &  obj ) const

overridevirtualnoexcept

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]

bool xtd::drawing::brush::equals ( const brush &  other ) const

overridenoexcept

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()

xtd::size xtd::drawing::brush::get_hash_code ( ) const

overridevirtualnoexcept

Serves as a hash function for a particular type.

Returns

A hash code for the current object.

Reimplemented from xtd::object.

to_string()

xtd::string xtd::drawing::brush::to_string ( ) const

overridevirtualnoexcept

Converts this brush object to a human-readable string.

Returns

A string that represents this brush object.

Reimplemented from xtd::object.

set_native_brush()

void xtd::drawing::brush::set_native_brush ( intptr  brush )

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