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:

animation.cpp, button_renderer.cpp, check_box_renderer.cpp, circular_form.cpp, color_picker.cpp, colors.cpp, draw_ellipse.cpp, draw_image.cpp, draw_line.cpp, draw_point.cpp, draw_rectangle.cpp, draw_rounded_rectangle.cpp, fill_ellipse.cpp, fill_rectangle.cpp, fill_rounded_rectangle.cpp, form_paint.cpp, hello_world_paint.cpp, minesweeper.cpp, owner_button.cpp, painting.cpp, radio_button_renderer.cpp, user_control.cpp, wiggly.cpp, and wnd_proc.cpp.

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

Properties
const drawing::rectangle &	clip_rectangle () const noexcept
	Gets the rectangle in which to paint. More...
drawing::graphics &	graphics ()
	Gets the graphics used to paint. More...

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. More...
Public Member Functions inherited from xtd::event_args
	event_args ()=default
	Initializes a new instance of the event_args class. More...
Public Member Functions inherited from xtd::object
	object ()=default
	Create a new instance of the ultimate base class object. More...
bool	equals (const object &obj) const noexcept
	Determines whether the specified object is equal to the current object. More...
virtual size_t	get_hash_code () const noexcept
	Serves as a hash function for a particular type. More...
template<typename object_t >
std::unique_ptr< object_t >	memberwise_clone () const noexcept
	Gets the type of the current instance. More...
virtual xtd::ustring	to_string () const noexcept
	Returns a sxd::ustring that represents the current object. More...
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. More...
static bool	reference_equals (const object &object_a, const object &object_b) noexcept
	Determines whether the specified object instances are the same instance. More...

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
	)

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
	)

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

noexcept

Gets the rectangle in which to paint.

Returns

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

Examples:

animation.cpp, colors.cpp, draw_image.cpp, draw_line.cpp, minesweeper.cpp, owner_button.cpp, and wiggly.cpp.

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.

Examples:

animation.cpp, button_renderer.cpp, check_box_renderer.cpp, colors.cpp, draw_ellipse.cpp, draw_image.cpp, draw_line.cpp, draw_point.cpp, draw_rectangle.cpp, draw_rounded_rectangle.cpp, fill_ellipse.cpp, fill_rectangle.cpp, fill_rounded_rectangle.cpp, minesweeper.cpp, owner_button.cpp, radio_button_renderer.cpp, user_control.cpp, wiggly.cpp, and wnd_proc.cpp.

---

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

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