xtd - Reference Guide 0.2.0
xtd::forms::status_bar_draw_item_event_args Class Reference

#include <status_bar_draw_item_event_args.h>

Definition

Provides data for the xtd::forms::status_bar::draw_item event.

Namespace
xtd::forms
Library
xtd.forms
Remarks
The xtd::forms::status_bar::draw_item event occurs when a visual aspect of an owner-drawn xtd::forms::status_bar_panel changes. A xtd::forms::status_bar_draw_item_event_args specifies the xtd::drawing::graphics object to use to draw the panel, the xtd::drawing::rectangle object in which to draw the panel, the panel identification number, state information about the panel, and the panel to draw. You can use the data provided by this class in an event handler for the xtd::forms::status_bar::draw_item event to create custom-drawn panels in your application's xtd::forms::status_bar control.

Constructors

 status_bar_draw_item_event_args (xtd::drawing::graphics &g, const xtd::drawing::font &font, const xtd::drawing::rectangle &r, size_t item_id, xtd::forms::draw_item_state item_state, const xtd::forms::status_bar_panel &panel)
 Initializes a new instance of the xtd::forms::status_bar_draw_item_event_args class without specifying a background and foreground color for the xtd::forms::status_bar_panel. More...
 
 status_bar_draw_item_event_args (xtd::drawing::graphics &g, const xtd::drawing::font &font, const xtd::drawing::rectangle &r, size_t item_id, xtd::forms::draw_item_state item_state, const xtd::forms::status_bar_panel &panel, intptr_t handle)
 Initializes a new instance of the xtd::forms::status_bar_draw_item_event_args class without specifying a background and foreground color for the xtd::forms::status_bar_panel. More...
 
 status_bar_draw_item_event_args (xtd::drawing::graphics &g, const xtd::drawing::font &font, const xtd::drawing::rectangle &r, size_t item_id, xtd::forms::draw_item_state item_state, const xtd::forms::status_bar_panel &panel, const xtd::drawing::color &back_color, const xtd::drawing::color &fore_color)
 Initializes a new instance of the xtd::forms::status_bar_draw_item_event_args class without specifying a background and foreground color for the xtd::forms::status_bar_panel. More...
 
 status_bar_draw_item_event_args (xtd::drawing::graphics &g, const xtd::drawing::font &font, const xtd::drawing::rectangle &r, size_t item_id, xtd::forms::draw_item_state item_state, const xtd::forms::status_bar_panel &panel, const xtd::drawing::color &back_color, const xtd::drawing::color &fore_color, intptr_t handle)
 Initializes a new instance of the xtd::forms::status_bar_draw_item_event_args class without specifying a background and foreground color for the xtd::forms::status_bar_panel. More...
 

Properties

const xtd::forms::status_bar_panelpanel () const
 Gets the xtd::forms::tool_bar_panel to draw. More...
 
intptr_t handle () const
 Gets internal handle. 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::forms::draw_item_event_args
 draw_item_event_args (xtd::drawing::graphics &graphics, const xtd::drawing::font &font, const xtd::drawing::rectangle &rect, size_t index, xtd::forms::draw_item_state state)
 Initializes a new instance of the xtd::forms::draw_item_event_args class for the specified control with the specified font, state, surface to draw on, and the bounds to draw within. More...
 
 draw_item_event_args (xtd::drawing::graphics &graphics, const xtd::drawing::font &font, const xtd::drawing::rectangle &rect, size_t index, xtd::forms::draw_item_state state, const xtd::drawing::color &back_color, const xtd::drawing::color &fore_core)
 Initializes a new instance of the xtd::forms::draw_item_event_args class for the specified control with the specified font, state, foreground color, background color, surface to draw on, and the bounds to draw within. More...
 
const xtd::drawing::colorback_color () const noexcept
 Gets the background color of the item that is being drawn. More...
 
const xtd::drawing::rectanglebounds () const noexcept
 Gets the rectangle that represents the bounds of the item that is being drawn. More...
 
const xtd::drawing::fontfont () const noexcept
 Gets the font that is assigned to the item being drawn. More...
 
const xtd::drawing::colorfore_color () const noexcept
 Gets the foreground color of the of the item being drawn. More...
 
xtd::drawing::graphicsgraphics () noexcept
 Gets the graphics surface to draw the item on. More...
 
size_t index () const noexcept
 Gets the index value of the item that is being drawn. More...
 
xtd::forms::draw_item_state state () const noexcept
 Gets the state of the item being drawn. 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...
 
virtual 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
 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

◆ status_bar_draw_item_event_args() [1/4]

xtd::forms::status_bar_draw_item_event_args::status_bar_draw_item_event_args ( xtd::drawing::graphics g,
const xtd::drawing::font font,
const xtd::drawing::rectangle r,
size_t  item_id,
xtd::forms::draw_item_state  item_state,
const xtd::forms::status_bar_panel panel 
)
inline

Initializes a new instance of the xtd::forms::status_bar_draw_item_event_args class without specifying a background and foreground color for the xtd::forms::status_bar_panel.

Parameters
gThe xtd::drawing::graphics to use to draw the xtd::forms::status_bar_panel.
fontThe xtd::drawing::font used to render text.
rThe xtd::drawing::rectangle that represents the client area of the xtd::forms::status_bar_panel.
item_idThe zero-based index of the panel in the xtd::forms::status_bar::status_bar_panel_collection of the xtd::forms::status_bar control.
item_stateOne of the xtd::forms::draw_item_state values that represents state information about the xtd::forms::status_bar_panel.
panelA xtd::forms::tool_bar_panel that represents the panel to draw.

◆ status_bar_draw_item_event_args() [2/4]

xtd::forms::status_bar_draw_item_event_args::status_bar_draw_item_event_args ( xtd::drawing::graphics g,
const xtd::drawing::font font,
const xtd::drawing::rectangle r,
size_t  item_id,
xtd::forms::draw_item_state  item_state,
const xtd::forms::status_bar_panel panel,
intptr_t  handle 
)
inline

Initializes a new instance of the xtd::forms::status_bar_draw_item_event_args class without specifying a background and foreground color for the xtd::forms::status_bar_panel.

Parameters
gThe xtd::drawing::graphics to use to draw the xtd::forms::status_bar_panel.
fontThe xtd::drawing::font used to render text.
rThe xtd::drawing::rectangle that represents the client area of the xtd::forms::status_bar_panel.
item_idThe zero-based index of the panel in the xtd::forms::status_bar::status_bar_panel_collection of the xtd::forms::status_bar control.
item_stateOne of the xtd::forms::draw_item_state values that represents state information about the xtd::forms::status_bar_panel.
panelA xtd::forms::tool_bar_panel that represents the panel to draw.
handleAn internal handle.

◆ status_bar_draw_item_event_args() [3/4]

xtd::forms::status_bar_draw_item_event_args::status_bar_draw_item_event_args ( xtd::drawing::graphics g,
const xtd::drawing::font font,
const xtd::drawing::rectangle r,
size_t  item_id,
xtd::forms::draw_item_state  item_state,
const xtd::forms::status_bar_panel panel,
const xtd::drawing::color back_color,
const xtd::drawing::color fore_color 
)
inline

Initializes a new instance of the xtd::forms::status_bar_draw_item_event_args class without specifying a background and foreground color for the xtd::forms::status_bar_panel.

Parameters
gThe xtd::drawing::graphics to use to draw the xtd::forms::status_bar_panel.
fontThe xtd::drawing::font used to render text.
rThe xtd::drawing::rectangle that represents the client area of the xtd::forms::status_bar_panel.
item_idThe zero-based index of the panel in the xtd::forms::status_bar::status_bar_panel_collection of the xtd::forms::status_bar control.
item_stateOne of the xtd::forms::draw_item_state values that represents state information about the xtd::forms::status_bar_panel.
panelA xtd::forms::tool_bar_panel that represents the panel to draw.

◆ status_bar_draw_item_event_args() [4/4]

xtd::forms::status_bar_draw_item_event_args::status_bar_draw_item_event_args ( xtd::drawing::graphics g,
const xtd::drawing::font font,
const xtd::drawing::rectangle r,
size_t  item_id,
xtd::forms::draw_item_state  item_state,
const xtd::forms::status_bar_panel panel,
const xtd::drawing::color back_color,
const xtd::drawing::color fore_color,
intptr_t  handle 
)
inline

Initializes a new instance of the xtd::forms::status_bar_draw_item_event_args class without specifying a background and foreground color for the xtd::forms::status_bar_panel.

Parameters
gThe xtd::drawing::graphics to use to draw the xtd::forms::status_bar_panel.
fontThe xtd::drawing::font used to render text.
rThe xtd::drawing::rectangle that represents the client area of the xtd::forms::status_bar_panel.
item_idThe zero-based index of the panel in the xtd::forms::status_bar::status_bar_panel_collection of the xtd::forms::status_bar control.
item_stateOne of the xtd::forms::draw_item_state values that represents state information about the xtd::forms::status_bar_panel.
panelA xtd::forms::tool_bar_panel that represents the panel to draw.
handleAn internal handle.

Member Function Documentation

◆ handle()

intptr_t xtd::forms::status_bar_draw_item_event_args::handle ( ) const
inline

Gets internal handle.

Returns
Internal handle.

◆ panel()

const xtd::forms::status_bar_panel& xtd::forms::status_bar_draw_item_event_args::panel ( ) const
inline

Gets the xtd::forms::tool_bar_panel to draw.

Returns
The xtd::forms::tool_bar_panel to draw.

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