xtd 0.2.0
Loading...
Searching...
No Matches
xtd::drawing::brush Class Reference
Inheritance diagram for xtd::drawing::brush:
xtd::object xtd::iequatable< brush > xtd::interface xtd::equality_operators< type_t, equatable_t > xtd::drawing::drawing_2d::conical_gradient_brush xtd::drawing::drawing_2d::hatch_brush xtd::drawing::drawing_2d::linear_gradient_brush xtd::drawing::drawing_2d::radial_gradient_brush xtd::drawing::solid_brush xtd::drawing::texture_brush

Definition

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

Defines objects used to fill the interiors of graphical shapes such as rectangles,...
Definition brush.h:33
Supports all classes in the xtd class hierarchy and provides low-level services to derived classes....
Definition object.h:42
#define drawing_export_
Define shared library export.
Definition drawing_export.h:13
Inheritance
xtd::objectxtd::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 brush &value) const noexcept override
 
xtd::string to_string () const noexcept override
 Converts this brush object to a human-readable string.
 
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.
 

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

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

◆ 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
brushA pointer to the GDI+ brush object.

◆ 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
objThe 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
static void write_line()
Writes the current line terminator to the standard output stream using the specified format informati...
The xtd namespace contains all fundamental classes to access Hardware, Os, System,...
Definition xtd_about_box.h:10

Reimplemented from xtd::object.

Reimplemented in xtd::drawing::drawing_2d::conical_gradient_brush, xtd::drawing::drawing_2d::hatch_brush, xtd::drawing::drawing_2d::linear_gradient_brush, xtd::drawing::drawing_2d::radial_gradient_brush, xtd::drawing::solid_brush, and xtd::drawing::texture_brush.

◆ 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_aThe first object to compare.
object_bThe 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
virtual bool equals(const object &obj) const noexcept
Determines whether the specified object is equal to the current object.

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