xtd - Reference Guide 0.2.0
xtd::forms::tool_bar_button_renderer Class Referencefinal

#include <tool_bar_button_renderer.h>

Definition

Provides tool bar button renderer methods.

class forms_export_ tool_bar_button_renderer static_
Inheritance
xtd::static → xtd::forms::tool_bar_button_renderer
Namespace
xtd::forms:
Library
xtd.forms

Methods

static void draw_tool_bar_button (const style_sheets::style_sheet &style_sheet, xtd::drawing::graphics &graphics, const xtd::drawing::rectangle &bounds, xtd::forms::visual_styles::push_button_state button_state, const std::optional< xtd::drawing::color > &back_color, const flat_button_appearance &appearance, const xtd::ustring &text, const std::optional< xtd::forms::content_alignment > &text_align, const std::optional< xtd::drawing::color > &fore_color, const std::optional< xtd::drawing::font > &font, const xtd::drawing::image &image, const std::optional< xtd::forms::content_alignment > &image_align)
 Draws a tool bar button in the specified bounds, button style, button state, background color, text, optional text flags, optional foreground color and optional font. More...
 

Member Function Documentation

◆ draw_tool_bar_button()

static void xtd::forms::tool_bar_button_renderer::draw_tool_bar_button ( const style_sheets::style_sheet style_sheet,
xtd::drawing::graphics graphics,
const xtd::drawing::rectangle bounds,
xtd::forms::visual_styles::push_button_state  button_state,
const std::optional< xtd::drawing::color > &  back_color,
const flat_button_appearance appearance,
const xtd::ustring text,
const std::optional< xtd::forms::content_alignment > &  text_align,
const std::optional< xtd::drawing::color > &  fore_color,
const std::optional< xtd::drawing::font > &  font,
const xtd::drawing::image image,
const std::optional< xtd::forms::content_alignment > &  image_align 
)
static

Draws a tool bar button in the specified bounds, button style, button state, background color, text, optional text flags, optional foreground color and optional font.

Parameters
style_sheetThe xtd::forms::style_sheets::style_sheet used to draw a button.
graphicsThe xtd::drawing::graphics used to draw a button.
boundsThe xtd::drawing::rectangle that specifies the bounds of the button.
button_stateThe visual state of a button that is drawn with visual styles.
back_colorThe background color for the button control.
appearanceThe xtd::forms::flat_appearance that represents the flat appearance of the tool bar button.
textThe text of the button control.
text_flagsContains the display and layout information for text strings.
fore_colorThe foreground color for the button control.
fontThe font of the text for the button control.
imageThe image of the button control.
image_alignContains the display and layout information for image .
Remarks
The parameter back_color is set only if they are different from its default value; otherwise std::nullopt.

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