xtd::forms::paint_event_args Class Reference

#include <paint_event_args.h>

Definition

Provides data for the paint event.

Namespace

xtd::forms

Library

xtd.forms

Remarks

The paint event occurs when a control is redrawn. A paint_event_args specifies the graphics to use to paint the control and the clip_rectangle in which to paint.

Examples

fill_rectangle.cpp, and user_control.cpp.

Inherits xtd::event_args.

Public Member Functions
	paint_event_args (xtd::drawing::graphics &graphics, const drawing::rectangle &clip_rectangle)
	Initializes a new instance of the paint_event_args class with the specified control, clipping rectangle.
	paint_event_args (xtd::forms::control &control, const drawing::rectangle &clip_rectangle)
	Initializes a new instance of the paint_event_args class with the specified control, clipping rectangle.
const drawing::rectangle &	clip_rectangle () const
	Gets the rectangle in which to paint.
drawing::graphics &	graphics ()
	Gets the graphics used to paint.
Public Member Functions inherited from xtd::event_args
	event_args ()=default
	Initializes a new instance of the event_args class.
Public Member Functions inherited from xtd::object
	object ()=default
	Create a new instance of the ultimate base class object.
virtual bool	equals (const object &obj) const noexcept
	Determines whether the specified object is equal to the current object.
virtual size_t	get_hash_code () const noexcept
	Serves as a hash function for a particular type.
template<typename object_t >
std::unique_ptr< object_t >	memberwise_clone () const
	Gets the type of the current instance.
virtual xtd::ustring	to_string () const noexcept
	Returns a std::string that represents the current object.

Additional Inherited Members
Static Public Attributes inherited from xtd::event_args
static const event_args	empty
	Provides a value to use with events that do not have event data.
Static Public Member Functions inherited from xtd::object
static bool	equals (const object &object_a, const object &object_b) noexcept
	Determines whether the specified object instances are considered equal.
static bool	reference_equals (const object &object_a, const object &object_b) noexcept
	Determines whether the specified object instances are the same instance.

Constructor & Destructor Documentation

paint_event_args() [1/2]

xtd::forms::paint_event_args::paint_event_args ( xtd::forms::control &  control, const drawing::rectangle &  clip_rectangle  )

inline

Initializes a new instance of the paint_event_args class with the specified control, clipping rectangle.

Parameters

control	The xtd::forms::control used to paint the item.
clip_rectangle	The xtd::drawing::rectangle that represents the rectangle in which to paint.

paint_event_args() [2/2]

xtd::forms::paint_event_args::paint_event_args ( xtd::drawing::graphics &  graphics, const drawing::rectangle &  clip_rectangle  )

inline

Initializes a new instance of the paint_event_args class with the specified control, clipping rectangle.

Parameters

graphics_	The xtd::drawing::graphics used to paint the item.
clip_rectangle	The xtd::drawing::rectangle that represents the rectangle in which to paint.

Member Function Documentation

clip_rectangle()

const drawing::rectangle & xtd::forms::paint_event_args::clip_rectangle ( ) const

inline

Gets the rectangle in which to paint.

Returns

The xtd::drawing::rectangle in which to paint.

graphics()

drawing::graphics & xtd::forms::paint_event_args::graphics

(

)

Gets the graphics used to paint.

Returns

The xtd::drawing::graphics object used to paint. The xtd::drawing::graphics object provides methods for drawing objects on the display device.

---

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

• xtd.forms/include/xtd/forms/paint_event_args.h