xtd - Reference Guide  0.1.0
Modern c++17 framework to create console, gui and unit test applications on Windows, macOS and Linux.
xtd::forms::progress_bar Class Reference

Represents a Windows progress bar control. More...

#include <progress_bar.h>

Inheritance diagram for xtd::forms::progress_bar:
xtd::forms::control xtd::forms::component xtd::forms::iwin32_window

Public Types

using control_collection = layout::arranged_element_collection< control_ref >
 Represents a collection of controls. More...
 

Public Member Functions

 progress_bar ()
 Initializes a new instance of the progress_bar class. More...
 
virtual anchor_styles anchor () const
 Gets the edges of the container to which a control is bound and determines how a control is resized with its parent. More...
 
virtual controlanchor (anchor_styles anchor)
 Gets the edges of the container to which a control is bound and determines how a control is resized with its parent. More...
 
virtual drawing::point auto_scroll_point () const
 Gets where this control is scrolled to in scroll_control_into_view(control). More...
 
virtual bool auto_size () const
 Gets a value that indicates whether the control resizes based on its contents. More...
 
virtual controlauto_size (bool auto_size)
 Sets a value that indicates whether the control resizes based on its contents. More...
 
virtual drawing::color back_color () const
 Gets the background color for the control. More...
 
virtual controlback_color (const drawing::color &color)
 Sets the background color for the control. More...
 
async_result_invoke begin_invoke (delegate< void(std::vector< std::any >)> value, const std::vector< std::any > &args)
 
async_result_invoke begin_invoke (delegate< void()> value)
 
virtual int32_t bottom () const
 Gets the distance, in pixels, between the bottom edge of the control and the top edge of its container's client area. More...
 
virtual drawing::rectangle bounds () const
 Gets the size and location of the control including its nonclient elements, in pixels, relative to the parent control. More...
 
virtual controlbounds (const drawing::rectangle &bounds)
 Sets the size and location of the control including its nonclient elements, in pixels, relative to the parent control. More...
 
virtual void bring_to_front ()
 
virtual bool can_focus () const
 Gets a value indicating whether the control can receive focus. More...
 
bool can_raise_events () const override
 Determines if events can be raised on the control. More...
 
virtual bool can_select () const
 Gets a value indicating whether the control can be selected. More...
 
virtual const drawing::rectangleclient_rectangle () const
 Gets the rectangle that represents the client area of the control. More...
 
virtual const drawing::sizeclient_size () const
 Gets the height and width of the client area of the control. More...
 
virtual controlclient_size (const drawing::size &client_size)
 Sets the height and width of the client area of the control. More...
 
virtual std::string compagny_name () const
 Gets the name of the company or creator of the application containing the control. More...
 
virtual control_collectioncontrols ()
 Gets the collection of controls contained within the control. More...
 
virtual const control_collectioncontrols () const
 Gets the collection of controls contained within the control. More...
 
void create_control ()
 
drawing::graphics create_graphics () const
 
virtual void create_handle ()
 
virtual bool created ()
 Gets a value indicating whether the control has been created. More...
 
virtual forms::cursor cursor () const
 
virtual controlcursor (const forms::cursor &cursor)
 
virtual drawing::color default_back_color () const
 Gets the default background color of the control. More...
 
virtual forms::cursor default_cursor () const
 
virtual drawing::font default_font () const
 
virtual drawing::color default_fore_color () const
 
drawing::size default_size () const override
 Gets the default size of the control. More...
 
void destroy_control ()
 
virtual void destroy_handle ()
 
virtual drawing::rectangle display_rectangle () const
 
virtual dock_style dock () const
 Gets or sets which control borders are docked to its parent control and determines how a control is resized with its parent. More...
 
virtual controldock (dock_style dock)
 
virtual bool double_buffered () const
 
virtual controldouble_buffered (bool double_buffered)
 
virtual bool enabled () const
 
virtual controlenabled (bool enabled)
 
void end_invoke (async_result_invoke async)
 
bool focus ()
 
virtual bool focused () const
 
virtual drawing::font font () const
 
virtual controlfont (const drawing::font &font)
 
virtual drawing::color fore_color () const
 
virtual controlfore_color (const drawing::color &color)
 
intptr_t handle () const override
 Gets the handle to the window represented by the implementer. More...
 
virtual int32_t height () const
 
virtual controlheight (int32_t height)
 
virtual void hide ()
 
void increment (int32_t value)
 Advances the current position of the progress bar by the specified amount. More...
 
virtual void invalidate () const
 
virtual void invalidate (bool invalidate_children) const
 
virtual void invalidate (const drawing::rectangle &rect) const
 
virtual void invalidate (const drawing::rectangle &rect, bool invalidate_children) const
 
void invoke (delegate< void(std::vector< std::any >)> value, const std::vector< std::any > &args)
 
void invoke (delegate< void()> value)
 
bool is_handle_created () const
 
virtual int32_t left () const
 
virtual controlleft (int32_t left)
 
virtual drawing::point location () const
 
virtual controllocation (const drawing::point &location)
 
virtual forms::padding margin () const
 
virtual controlmargin (const forms::padding &margin)
 
virtual size_t marquee_animation_speed ()
 Gets he time period, in milliseconds, that it takes the progress block to scroll across the progress bar. More...
 
virtual progress_barmarquee_animation_speed (size_t marquee_animation_speed)
 Sets the time period, in milliseconds, that it takes the progress block to scroll across the progress bar. More...
 
virtual int32_t maximum ()
 Gets the maximum value of the range of the control. More...
 
virtual progress_barmaximum (int32_t maximum)
 Sets the maximum value of the range of the control. More...
 
virtual int32_t minimum ()
 Gets the minimum value of the range of the control. More...
 
virtual progress_barminimum (int32_t minimum)
 Sets the minimum value of the range of the control. More...
 
virtual const std::string & name () const
 
virtual controlname (const std::string &name)
 
virtual forms::orientation orientation () const
 Gets a value indicating the horizontal or vertical orientation of the progress bar. More...
 
virtual progress_barorientation (forms::orientation orientation)
 Sets a value indicating the horizontal or vertical orientation of the progress bar. More...
 
virtual forms::padding padding () const
 
virtual controlpadding (const forms::padding &padding)
 
virtual std::optional< control_refparent () const
 
virtual controlparent (const control &parent)
 
virtual controlparent (std::nullptr_t)
 
void perform_layout ()
 Forces the control to apply layout logic to all its child controls. More...
 
void perform_step ()
 Advances the current position of the progress bar by the amount of the Step property. More...
 
xtd::drawing::point point_to_client (const xtd::drawing::point &p)
 
xtd::drawing::point point_to_screen (const xtd::drawing::point &p)
 
virtual bool pre_process_message (xtd::forms::message &message)
 
virtual std::string product_name () const
 
bool recreating_handle () const
 
virtual void refresh () const
 
void resume_layout ()
 Resumes usual layout logic. More...
 
void resume_layout (bool perform_layout)
 Resumes usual layout logic, optionally forcing an immediate layout of pending layout requests. More...
 
virtual int32_t right () const
 
intptr_t send_message (intptr_t hwnd, int32_t msg, intptr_t wparam, intptr_t lparam) const
 
void set_auto_size_mode (auto_size_mode auto_size_mode)
 
void set_bounds (int32_t x, int32_t y, int32_t width, int32_t height)
 
void set_bounds (int32_t x, int32_t y, int32_t width, int32_t height, bounds_specified specified)
 
void set_range (int min_value, int max_value)
 
virtual void show ()
 
virtual const drawing::sizesize () const
 
virtual controlsize (const drawing::size &size)
 
virtual int32_t step ()
 Gets the amount by which a call to the PerformStep() method increases the current position of the progress bar. More...
 
virtual progress_barstep (int32_t step)
 Sets the amount by which a call to the PerformStep() method increases the current position of the progress bar. More...
 
virtual progress_bar_style style () const
 Gets the manner in which progress should be indicated on the progress bar. More...
 
virtual progress_barstyle (progress_bar_style style)
 Sets the manner in which progress should be indicated on the progress bar. More...
 
void suspend_layout ()
 Temporarily suspends the layout logic for the control. More...
 
virtual std::any tag () const
 Gets the object that contains data about the control. More...
 
virtual controltag (std::any tag)
 Sets the object that contains data about the control. More...
 
virtual const std::string & text () const
 
virtual controltext (const std::string &text)
 
std::string to_string () const override
 Returns a string that represents the progress_bar control. More...
 
virtual int32_t top () const
 
virtual controltop (int32_t top)
 
virtual std::optional< control_reftop_level_control () const
 
virtual void update () const
 
virtual int32_t value ()
 Gets the current position of the progress bar. More...
 
virtual progress_barvalue (int32_t value)
 Sets the current position of the progress bar. More...
 
virtual bool visible () const
 
virtual controlvisible (bool visible)
 
virtual int32_t width () const
 
virtual controlwidth (int32_t width)
 

Static Public Member Functions

template<typename control_t >
static std::unique_ptr< control_t > create (const drawing::point &location={-1, -1}, const drawing::size &size={-1, -1}, const drawing::color &back_color=drawing::color::empty, const drawing::color &fore_color=drawing::color::empty)
 
template<typename control_t >
static std::unique_ptr< control_t > create (const control &parent, const drawing::point &location={-1, -1}, const drawing::size &size={-1, -1}, const drawing::color &back_color=drawing::color::empty, const drawing::color &fore_color=drawing::color::empty)
 
template<typename control_t >
static std::unique_ptr< control_t > create (const std::string &text, const drawing::point &location={-1, -1}, const drawing::size &size={-1, -1}, const drawing::color &back_color=drawing::color::empty, const drawing::color &fore_color=drawing::color::empty)
 
template<typename control_t >
static std::unique_ptr< control_t > create (const control &parent, const std::string &text, const drawing::point &location={-1, -1}, const drawing::size &size={-1, -1}, const drawing::color &back_color=drawing::color::empty, const drawing::color &fore_color=drawing::color::empty)
 
static std::optional< control_reffrom_child_handle (intptr_t handle)
 
static std::optional< control_reffrom_handle (intptr_t handle)
 
static forms::keys modifier_keys ()
 
static forms::mouse_buttons mouse_buttons ()
 

Public Attributes

event< control, event_handler< control & > > auto_size_changed
 
event< control, event_handler< control & > > back_color_changed
 
event< control, event_handler< control & > > click
 
event< control, event_handler< control & > > client_size_changed
 
event< control, control_event_handler< control & > > control_added
 
event< control, control_event_handler< control & > > control_removed
 
event< control, event_handler< control & > > cursor_changed
 
event< control, event_handler< control & > > dock_changed
 
event< control, event_handler< control & > > double_click
 
event< control, event_handler< control & > > enabled_changed
 
event< control, event_handler< control & > > font_changed
 
event< control, event_handler< control & > > fore_color_changed
 
event< control, event_handler< control & > > got_focus
 
event< control, event_handler< control & > > handle_created
 
event< control, event_handler< control & > > handle_destroyed
 
event< control, key_event_handler< control & > > key_down
 
event< control, key_press_event_handler< control & > > key_press
 
event< control, key_event_handler< control & > > key_up
 
event< control, event_handler< control & > > layout
 Occurs when a control should reposition its child controls. More...
 
event< control, event_handler< control & > > location_changed
 
event< control, event_handler< control & > > lost_focus
 
event< control, mouse_event_handler< control & > > mouse_click
 
event< control, mouse_event_handler< control & > > mouse_double_click
 
event< control, mouse_event_handler< control & > > mouse_down
 
event< control, event_handler< control & > > mouse_enter
 
event< control, mouse_event_handler< control & > > mouse_horizontal_wheel
 
event< control, event_handler< control & > > mouse_leave
 
event< control, mouse_event_handler< control & > > mouse_move
 
event< control, mouse_event_handler< control & > > mouse_up
 
event< control, mouse_event_handler< control & > > mouse_wheel
 
event< control, paint_event_handler< control & > > paint
 
event< control, event_handler< control & > > parent_changed
 
event< control, event_handler< control & > > resize
 
event< control, event_handler< control & > > size_changed
 
event< control, event_handler< control & > > text_changed
 
event< control, event_handler< control & > > visible_changed
 

Protected Member Functions

forms::create_params create_params () const override
 Gets the required creation parameters when the control handle is created. More...
 
virtual void def_wnd_proc (message &message)
 
bool design_mode () const
 Gets a value that indicates whether the component is currently in design mode. More...
 
bool get_style (control_styles flag) const
 Retrieves the value of the specified control style bit for the control. More...
 
virtual drawing::size measure_control () const
 Measure this control. More...
 
drawing::size measure_text () const
 
virtual void on_auto_size_changed (const event_args &e)
 
virtual void on_back_color_changed (const event_args &e)
 
virtual void on_click (const event_args &e)
 
virtual void on_client_size_changed (const event_args &e)
 
virtual void on_control_added (const control_event_args &e)
 
virtual void on_control_removed (const control_event_args &e)
 
virtual void on_create_control ()
 
virtual void on_cursor_changed (const event_args &e)
 
virtual void on_dock_changed (const event_args &e)
 
virtual void on_double_click (const event_args &e)
 
virtual void on_enabled_changed (const event_args &e)
 
virtual void on_font_changed (const event_args &e)
 
virtual void on_fore_color_changed (const event_args &e)
 
virtual void on_got_focus (const event_args &e)
 
void on_handle_created (const event_args &e) override
 Overrides control::on_handle_created(const event_args&) More...
 
virtual void on_handle_destroyed (const event_args &e)
 
virtual void on_key_down (key_event_args &e)
 
virtual void on_key_press (key_press_event_args &e)
 
virtual void on_key_up (key_event_args &e)
 
virtual void on_layout (const event_args &e)
 
virtual void on_location_changed (const event_args &e)
 
virtual void on_lost_focus (const event_args &e)
 
virtual void on_mouse_click (const mouse_event_args &e)
 
virtual void on_mouse_double_click (const mouse_event_args &e)
 
virtual void on_mouse_down (const mouse_event_args &e)
 
virtual void on_mouse_enter (const event_args &e)
 
virtual void on_mouse_horizontal_wheel (const mouse_event_args &e)
 
virtual void on_mouse_leave (const event_args &e)
 
virtual void on_mouse_move (const mouse_event_args &e)
 
virtual void on_mouse_up (const mouse_event_args &e)
 
virtual void on_mouse_wheel (const mouse_event_args &e)
 
virtual void on_paint (paint_event_args &e)
 
virtual void on_parent_back_color_changed (const event_args &e)
 
virtual void on_parent_changed (const event_args &e)
 
virtual void on_parent_cursor_changed (const event_args &e)
 
virtual void on_parent_font_changed (const event_args &e)
 
virtual void on_parent_fore_color_changed (const event_args &e)
 
virtual void on_resize (const event_args &e)
 
virtual void on_size_changed (const event_args &e)
 
virtual void on_text_changed (const event_args &e)
 
virtual void on_visible_changed (const event_args &e)
 
virtual void recreate_handle ()
 
virtual void set_bounds_core (int32_t x, int32_t y, int32_t width, int32_t height, bounds_specified specified)
 Performs the work of setting the specified bounds of this control. More...
 
virtual void set_client_size_core (int32_t width, int32_t height)
 Sets the size of the client area of the control. More...
 
void set_style (control_styles flag, bool value)
 Sets a specified control_styles flag to either true or false. More...
 
virtual void wnd_proc (message &m)
 Processes Windows messages. More...
 

Detailed Description

Represents a Windows progress bar control.

Remarks
A ProgressBar control visually indicates the progress of a lengthy operation in one of three styles:
  • Segmented blocks that increase in steps from left to right.
  • A continuous bar that fills in from left to right.
  • A block that scrolls across a ProgressBar in a marquee fashion.
The style property determines the style of progress_bar that is displayed. Note that the progress_bar control can oriented horizontally or verticaly. The progress_bar control is typically used when an application performs tasks such as copying files or printing documents. Users of an application might consider an application unresponsive if there is no visual cue. By using the progress_bar in your application, you alert the user that the application is performing a lengthy task and that the application is still responding.
The maximum and minimum properties define the range of values to represent the progress of a task. The minimum property is typically set to a value of 0, and the maximum property is typically set to a value indicating the completion of a task. For example, to properly display the progress when copying a group of files, the maximum property could be set to the total number of files to be copied.
The value property represents the progress that the application has made toward completing the operation. The value displayed by the progress_bar only approximates the current value of the value property. Based on the size of the progress_bar, the value property determines when to display the next block or increase the size of the bar.
There are a number of ways to modify the value displayed by the progress_bar other than changing the value property directly. You can use the step property to specify a specific value to increment the Value property by, and then call the perform_step method to increment the value. To vary the increment value, you can use the increment method and specify a value with which to increment the value property.
Note
fore_color and back_color changes for the progress_bar will not be honored.
Example
The following code example demonstrate the use of progress_bar control.
#include <xtd/xtd>
using namespace xtd::forms;
namespace examples {
class form1 : public form {
public:
form1() {
text("Progress bar example");
client_size({300, 300});
progress_bar1.parent(*this);
progress_bar1.location({50, 50});
progress_bar1.width(200);
progress_bar2.parent(*this);
progress_bar2.location({50, 80});
progress_bar2.value(50);
progress_bar2.width(200);
progress_bar3.parent(*this);
progress_bar3.location({50, 110});
progress_bar3.maximum(300);
progress_bar3.increment(300);
progress_bar3.width(200);
progress_bar4.parent(*this);
progress_bar4.location({50, 140});
progress_bar4.step(1);
progress_bar4.width(200);
progress_bar5.parent(*this);
progress_bar5.location({50, 170});
progress_bar5.maximum(200);
progress_bar5.minimum(100);
progress_bar5.style(progress_bar_style::marquee);
progress_bar5.width(200);
timer1.interval(50);
timer1.tick += [&] {
progress_bar4.value(progress_bar4.value() < progress_bar4.maximum() ? progress_bar4.value() + 1 : progress_bar4.minimum());
};
timer1.enabled(true);
}
private:
timer timer1;
progress_bar progress_bar1;
progress_bar progress_bar2;
progress_bar progress_bar3;
progress_bar progress_bar4;
progress_bar progress_bar5;
};
}
int main() {
application::run(examples::form1());
}

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