xtd::forms::control_paint Class Reference

#include <control_paint.h>

Definition

Provides methods used to paint common Windows controls and their elements. This class cannot be inherited.

Namespace

xtd::forms

Library

xtd.forms

Inherits xtd::static_object.

Static Public Member Functions
static xtd::drawing::color	average (const xtd::drawing::color &color1, const xtd::drawing::color &color2, double weight)
	Returns the weighted average color between the two given colors.
static xtd::drawing::color	average (const xtd::drawing::color &color1, const xtd::drawing::color &color2, double weight, bool average_alpha)
	Returns the weighted average color between the two given colors.
static xtd::drawing::color	dark (const xtd::drawing::color &base_color)
	Creates a new dark color object for the control from the specified color.
static xtd::drawing::color	dark (const xtd::drawing::color &base_color, double perc_of_dark_dark)
	Creates a new dark color object for the control from the specified color and darkens it by the specified percentage.
static xtd::drawing::color	dark_dark (const xtd::drawing::color &base_color)
	Creates a new dark color object for the control from the specified color.
static void	draw_button (xtd::drawing::graphics &graphics, const xtd::drawing::rectangle &rectangle, xtd::forms::button_state state)
static void	draw_button (xtd::drawing::graphics &graphics, int32_t x, int32_t y, int32_t width, int32_t height, xtd::forms::button_state state)
static void	draw_image (xtd::drawing::graphics &graphics, const xtd::drawing::image &image, const xtd::drawing::rectangle &rectangle, xtd::forms::image_layout image_layout)
	Draws the specified image in a specified rectangle with specified layout.
static void	draw_image (xtd::drawing::graphics &graphics, const xtd::drawing::image &image, int32_t x, int32_t y, int32_t width, int32_t height, xtd::forms::image_layout image_layout)
	Draws the specified image in a specified rectangle with specified layout.
static void	draw_image_disabled (xtd::drawing::graphics &graphics, const xtd::drawing::image &image, const xtd::drawing::point &location, const xtd::drawing::color &background)
	Draws the specified image in a disabled state.
static void	draw_image_disabled (xtd::drawing::graphics &graphics, const xtd::drawing::image &image, const xtd::drawing::point &location, float brightness)
	Draws the specified image in a disabled state.
static void	draw_image_disabled (xtd::drawing::graphics &graphics, const xtd::drawing::image &image, int32_t x, int32_t y, const xtd::drawing::color &background)
	Draws the specified image in a disabled state.
static void	draw_image_disabled (xtd::drawing::graphics &graphics, const xtd::drawing::image &image, int32_t x, int32_t y, float brightness)
	Draws the specified image in a disabled state.
static xtd::drawing::color	light (const xtd::drawing::color &base_color)
	Creates a new light color object for the control from the specified color.
static xtd::drawing::color	light (const xtd::drawing::color &base_color, double perc_of_light_light)
	Creates a new light color object for the control from the specified color and lightens it by the specified percentage.
static xtd::drawing::color	light_light (const xtd::drawing::color &base_color)
	Creates a new light color object for the control from the specified color.
static xtd::drawing::string_format	string_format (xtd::forms::text_format_flags flags)
	Convert xtd::forms::text_format_flags to xtd::drawing::string_format.

Member Function Documentation

average() [1/2]

static xtd::drawing::color xtd::forms::control_paint::average ( const xtd::drawing::color &  color1, const xtd::drawing::color &  color2, double  weight  )

inlinestatic

Returns the weighted average color between the two given colors.

Parameters

color1	The first color.
color2	The second color.
weight	The weighting factor

Returns

The average color.

Remarks

The red, green and blue values are averages using the following formula:

color = color1 * (1 - weight) + color2 * 1 - weight;

Thus, a weight value of 1.0 will return the second color, while a value of 0.0 will return the first color.

average() [2/2]

static xtd::drawing::color xtd::forms::control_paint::average ( const xtd::drawing::color &  color1, const xtd::drawing::color &  color2, double  weight, bool  average_alpha  )

inlinestatic

Returns the weighted average color between the two given colors.

Parameters

color1	The first color.
color2	The second color.
weight	The weighting factor
average_alpha	if true alpha was compute to; otherwise the alpha result is the alpha of color1

Returns

The average color.

Remarks

The alpha, red, green and blue values are averages using the following formula:

color = color1 * (1 - weight) + color2 * weight;

Thus, a weight value of 1.0 will return the first color, while a value of 0.0 will return the second color.

dark() [1/2]

static xtd::drawing::color xtd::forms::control_paint::dark ( const xtd::drawing::color &  base_color )

inlinestatic

Creates a new dark color object for the control from the specified color.

Parameters

color

The xtd::drawing::color to be darkened.

Returns

A xtd::drawing::color that represents the dark color on the control.

Remarks

If the specified xtd::drawing::color is one of the xtd::drawing::system_color, the color is converted to a xtd::drawing::system_color.control_dark color; otherwise, the color's luminosity value is decreased.

dark() [2/2]

static xtd::drawing::color xtd::forms::control_paint::dark ( const xtd::drawing::color &  base_color, double  perc_of_dark_dark  )

inlinestatic

Creates a new dark color object for the control from the specified color and darkens it by the specified percentage.

Parameters

color	The xtd::drawing::color to be darkened.
perc_of_dark	The percentage to darken the specified xtd::drawing::color.

Remarks

If the specified xtd::drawing::color is one of the xtd::drawing::system_color, the color is converted to a xtd::drawing::system_color.control_dark color; otherwise, the color's luminosity value is decreased.

dark_dark()

static xtd::drawing::color xtd::forms::control_paint::dark_dark ( const xtd::drawing::color &  base_color )

inlinestatic

Creates a new dark color object for the control from the specified color.

Parameters

color

The xtd::drawing::color to be darkened.

Returns

A xtd::drawing::color that represents the dark color on the control.

Remarks

If the specified xtd::drawing::color is one of the xtd::drawing::system_color, the color is converted to a xtd::drawing::system_color.control_dark_dark color; otherwise, the color's luminosity value is decreased.

draw_image() [1/2]

static void xtd::forms::control_paint::draw_image ( xtd::drawing::graphics &  graphics, const xtd::drawing::image &  image, const xtd::drawing::rectangle &  rectangle, xtd::forms::image_layout  image_layout  )

inlinestatic

Draws the specified image in a specified rectangle with specified layout.

Parameters

xtd::drawing::graphics	The Graphics to draw on.
image	The xtd::drawing::image to draw.
rectangle	xtd::drawing::rectangle structure that defines the rectangle of the drawn image.
image_layout	One of the values of xtd::forms::image_layout (center , none, stretch, tile, or zoom).

draw_image() [2/2]

static void xtd::forms::control_paint::draw_image ( xtd::drawing::graphics &  graphics, const xtd::drawing::image &  image, int32_t  x, int32_t  y, int32_t  width, int32_t  height, xtd::forms::image_layout  image_layout  )

static

Draws the specified image in a specified rectangle with specified layout.

Parameters

xtd::drawing::graphics	The Graphics to draw on.
image	The xtd::drawing::image to draw.
x	The x-coordinate of the top left of the drawn image.
y	The y-coordinate of the top left of the drawn image.
width	The width of the drawn image.
height	The height of the drawn image.
image_layout	One of the values of xtd::forms::image_layout (center , none, stretch, tile, or zoom).

draw_image_disabled() [1/4]

static void xtd::forms::control_paint::draw_image_disabled ( xtd::drawing::graphics &  graphics, const xtd::drawing::image &  image, const xtd::drawing::point &  location, const xtd::drawing::color &  background  )

inlinestatic

Draws the specified image in a disabled state.

Parameters

xtd::drawing::graphics	The Graphics to draw on.
image	The xtd::drawing::image to draw.
location	The xtd::drawing::point of the top left of the border image.
background	The xtd::drawing::color of the background behind the image.

Remarks

The background parameter is used to calculate the fill color of the disabled image so that it is always visible against the background

draw_image_disabled() [2/4]

static void xtd::forms::control_paint::draw_image_disabled ( xtd::drawing::graphics &  graphics, const xtd::drawing::image &  image, const xtd::drawing::point &  location, float  brightness  )

inlinestatic

Draws the specified image in a disabled state.

Parameters

xtd::drawing::graphics	The Graphics to draw on.
image	The xtd::drawing::image to draw.
location	The xtd::drawing::point of the top left of the border image.
brightness	The brightness (between 0.0 and 1.0 for drawing image disabled.

Remarks

The background parameter is used to calculate the fill color of the disabled image so that it is always visible against the background

draw_image_disabled() [3/4]

static void xtd::forms::control_paint::draw_image_disabled ( xtd::drawing::graphics &  graphics, const xtd::drawing::image &  image, int32_t  x, int32_t  y, const xtd::drawing::color &  background  )

inlinestatic

Draws the specified image in a disabled state.

Parameters

xtd::drawing::graphics	The Graphics to draw on.
image	The xtd::drawing::image to draw.
x	The x-coordinate of the top left of the border image.
y	The y-coordinate of the top left of the border image.
background	The xtd::drawing::color of the background behind the image.

Remarks

The background parameter is used to calculate the fill color of the disabled image so that it is always visible against the background

draw_image_disabled() [4/4]

static void xtd::forms::control_paint::draw_image_disabled ( xtd::drawing::graphics &  graphics, const xtd::drawing::image &  image, int32_t  x, int32_t  y, float  brightness  )

static

Draws the specified image in a disabled state.

Parameters

xtd::drawing::graphics	The Graphics to draw on.
image	The xtd::drawing::image to draw.
x	The x-coordinate of the top left of the border image.
y	The y-coordinate of the top left of the border image.
brightness	The brightness (between 0.0 and 1.0 for drawing image disabled.

Remarks

The background parameter is used to calculate the fill color of the disabled image so that it is always visible against the background

light() [1/2]

static xtd::drawing::color xtd::forms::control_paint::light ( const xtd::drawing::color &  base_color )

inlinestatic

Creates a new light color object for the control from the specified color.

Parameters

color

The xtd::drawing::color to be lightened.

Returns

A xtd::drawing::color that represents the light color on the control.

Remarks

If the specified xtd::drawing::color is one of the xtd::drawing::system_color, the color is converted to a xtd::drawing::system_color.control_light color; otherwise, the color's luminosity value is decreased.

light() [2/2]

static xtd::drawing::color xtd::forms::control_paint::light ( const xtd::drawing::color &  base_color, double  perc_of_light_light  )

inlinestatic

Creates a new light color object for the control from the specified color and lightens it by the specified percentage.

Parameters

color	The xtd::drawing::color to be lightened.
perc_of_light	The percentage to lighten the specified xtd::drawing::color.

Remarks

If the specified xtd::drawing::color is one of the xtd::drawing::system_color, the color is converted to a xtd::drawing::system_color.control_light color; otherwise, the color's luminosity value is decreased.

light_light()

static xtd::drawing::color xtd::forms::control_paint::light_light ( const xtd::drawing::color &  base_color )

inlinestatic

Creates a new light color object for the control from the specified color.

Parameters

color

The xtd::drawing::color to be lightened.

Returns

A xtd::drawing::color that represents the light color on the control.

Remarks

If the specified xtd::drawing::color is one of the xtd::drawing::system_color, the color is converted to a xtd::drawing::system_color.control_light_light color; otherwise, the color's luminosity value is decreased.

string_format()

static xtd::drawing::string_format xtd::forms::control_paint::string_format ( xtd::forms::text_format_flags  flags )

inlinestatic

Convert xtd::forms::text_format_flags to xtd::drawing::string_format.

Parameters

flags

a text_format_flags to convert.

Returns

A string_format converted.

---

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

• xtd.forms/include/xtd/forms/control_paint.h