xtd - Reference Guide  0.2.0
Modern c++17/20 framework to create console, GUI and unit test applications on Windows, macOS, Linux, iOS and android.
Public Attributes | Public Member Functions | Protected Member Functions | List of all members
xtd::forms::track_bar Class Reference

#include <track_bar.h>

Definition

Represents a standard Windows track bar.

Namespace
xtd::forms
Library
xtd.forms
Remarks
The track_bar is a scrollable control similar to the scroll_bar control. You can configure ranges through which the value of the value property of a track bar scrolls by setting the minimum property to specify the lower end of the range and the maximum property to specify the upper end of the range.
The large_change property defines the increment to add or subtract from the value property when clicks occur on either side of the scroll box. The track bar can be displayed horizontally or vertically.
You can use this control to input numeric data obtained through the value property. You can display this numeric data in a control or use it in code.
Examples
The following code example demonstrate the use of track_bar control.
#include <xtd/xtd>
using namespace xtd;
using namespace xtd::forms;
class form1 : public form {
public:
form1() {
client_size({300, 300});
text("Track bar example");
progress_bar1.location({80, 50});
progress_bar1.maximum(200);
progress_bar1.orientation(forms::orientation::vertical);
progress_bar1.parent(*this);
progress_bar1.size({23, 200});
label1.location({150, 50});
label1.parent(*this);
track_bar1.location({50, 50});
track_bar1.maximum(200);
track_bar1.auto_size(false);
track_bar1.orientation(forms::orientation::vertical);
track_bar1.parent(*this);
track_bar1.value_changed += [&] {
progress_bar1.value(track_bar1.value());
label1.text(ustring::format("{}", track_bar1.value()));
};
track_bar1.value(100);
track_bar1.tick_style(forms::tick_style::none);
track_bar1.size({25, 200});
}
private:
track_bar track_bar1;
progress_bar progress_bar1;
label label1;
};
int main() {
application::run(form1());
}
Examples:
track_bar.cpp.

Public Attributes

event< track_bar, event_handlerscroll
 Occurs when either a mouse or keyboard action moves the scroll box. More...
 
event< track_bar, event_handlervalue_changed
 Occurs when the value property of a track bar changes, either by movement of the scroll box or by manipulation in code. More...
 
- Public Attributes inherited from xtd::forms::control
event< control, event_handlerauto_size_changed
 Occurs when the value of the auto_size property changes. More...
 
event< control, event_handlerback_color_changed
 Occurs when the value of the back_color property changes. More...
 
event< control, event_handlerbackground_image_changed
 Occurs when the value of the background_image property changes. More...
 
event< control, event_handlerbackground_image_layout_changed
 Occurs when the value of the background_image_layout property changes. More...
 
event< control, event_handlerclick
 Occurs when the control is clicked. More...
 
event< control, event_handlerclient_size_changed
 Occurs when the value of the client_size property changes. More...
 
event< control, control_event_handlercontrol_added
 Occurs when a new control is added to the control::control_collection. More...
 
event< control, control_event_handlercontrol_removed
 Occurs when a new control is removed to the control::control_collection. More...
 
event< control, event_handlercursor_changed
 Occurs when the value of the cursor property changes. More...
 
event< control, event_handlerdock_changed
 Occurs when the value of the dock property changes. More...
 
event< control, event_handlerdouble_click
 Occurs when the control is double-clicked. More...
 
event< control, event_handlerenabled_changed
 Occurs when the value of the enabled property changes. More...
 
event< control, event_handlerfont_changed
 Occurs when the value of the font property changes. More...
 
event< control, event_handlerfore_color_changed
 Occurs when the value of the fore_color property changes. More...
 
event< control, event_handlergot_focus
 Occurs when the control receives focus. More...
 
event< control, event_handlerhandle_created
 Occurs when a handle is created for the control. More...
 
event< control, event_handlerhandle_destroyed
 Occurs when the control's handle is in the process of being destroyed. More...
 
event< control, key_event_handlerkey_down
 Occurs when a key is pressed while the control has focus. More...
 
event< control, key_press_event_handlerkey_press
 Occurs when a character. space or backspace key is pressed while the control has focus. More...
 
event< control, key_event_handlerkey_up
 Occurs when a key is released while the control has focus. More...
 
event< control, event_handlerlayout
 Occurs when a control should reposition its child controls. More...
 
event< control, event_handlerlocation_changed
 Occurs when the value of the location property changes. More...
 
event< control, event_handlerlost_focus
 Occurs when the control loses focus. More...
 
event< control, mouse_event_handlermouse_click
 Occurs when the control is clicked by the mouse. More...
 
event< control, mouse_event_handlermouse_double_click
 Occurs when the control is double clicked by the mouse. More...
 
event< control, mouse_event_handlermouse_down
 Occurs when the mouse pointer is over the control and a mouse button is pressed. More...
 
event< control, event_handlermouse_enter
 Occurs when the mouse pointer enters the control. More...
 
event< control, mouse_event_handlermouse_horizontal_wheel
 Occurs when the mouse horizontal wheel moves while the control has focus. More...
 
event< control, event_handlermouse_leave
 Occurs when the mouse pointer leaves the control. More...
 
event< control, mouse_event_handlermouse_move
 Occurs when the mouse pointer is moved over the control. More...
 
event< control, mouse_event_handlermouse_up
 Occurs when the mouse pointer is over the control and a mouse button is released. More...
 
event< control, mouse_event_handlermouse_wheel
 Occurs when the mouse wheel moves while the control has focus. More...
 
event< control, paint_event_handlerpaint
 Occurs when the control is redrawn. More...
 
event< control, event_handlerparent_changed
 Occurs when the value of the parent property changes. More...
 
event< control, event_handlerresize
 Occurs when the control is resized. More...
 
event< control, event_handlersize_changed
 Occurs when the value of the size property changes. More...
 
event< control, event_handlertext_changed
 Occurs when the value of the text property changes. More...
 
event< control, event_handlervisible_changed
 Occurs when the value of the visible property changes. More...
 

Public Member Functions

 track_bar ()
 Initializes a new instance of the track_bar class. More...
 
drawing::size default_size () const override
 Gets the default size of the control. More...
 
virtual int32_t large_change ()
 Gets a value to be added to or subtracted from the value property when the scroll box is moved a large distance. More...
 
virtual track_barlarge_change (int32_t large_change)
 Sets a value to be added to or subtracted from the value property when the scroll box is moved a large distance. More...
 
virtual int32_t maximum ()
 Gets the upper limit of the range this track_bar is working with. More...
 
virtual track_barmaximum (int32_t maximum)
 sets the upper limit of the range this track_bar is working with. More...
 
virtual int32_t minimum ()
 Gets the lower limit of the range this track_bar is working with. More...
 
virtual track_barminimum (int32_t minimum)
 Sets the lower limit of the range this track_bar is working with. More...
 
virtual forms::orientation orientation () const
 Gets a value indicating the horizontal or vertical orientation of the track bar. More...
 
virtual track_barorientation (forms::orientation orientation)
 Sets a value indicating the horizontal or vertical orientation of the track bar. More...
 
void set_range (int min_value, int max_value)
 Sets the minimum and maximum values for a xtd::forms::track_bar. More...
 
virtual int32_t small_change ()
 Gets he value added to or subtracted from the Value property when the scroll box is moved a small distance. More...
 
virtual track_barsmall_change (int32_t small_change)
 Sets the value added to or subtracted from the Value property when the scroll box is moved a small distance. More...
 
virtual int32_t tick_frequency ()
 Gets a value that specifies the delta between ticks drawn on the control. More...
 
virtual track_bartick_frequency (int32_t tick_frequency)
 Sets a value that specifies the delta between ticks drawn on the control. More...
 
virtual forms::tick_style tick_style ()
 Gets a value indicating how to display the tick marks on the track bar. More...
 
virtual track_bartick_style (forms::tick_style tick_style)
 Sets a value indicating how to display the tick marks on the track bar. More...
 
xtd::ustring to_string () const noexcept override
 Returns a string that represents the track_bar control. More...
 
virtual int32_t value ()
 Gets a numeric value that represents the current position of the scroll box on the track bar. More...
 
virtual track_barvalue (int32_t value)
 Sets a numeric value that represents the current position of the scroll box on the track bar. More...
 
- Public Member Functions inherited from xtd::forms::control
 control ()
 Initializes a new instance of the control class with default settings. More...
 
 control (const xtd::ustring &text)
 Initializes a new instance of the control class with specific text. More...
 
 control (const control &parent, const xtd::ustring &text)
 Initializes a new instance of the control class as a child control, with specific text. More...
 
 control (const xtd::ustring &text, int32_t left, int32_t top, int32_t width, int32_t height)
 Initializes a new instance of the control class with specific text, size, and location. More...
 
 control (const control &parent, const xtd::ustring &text, int32_t left, int32_t top, int32_t width, int32_t height)
 Initializes a new instance of the control class as a child control, with specific text, size, and location. 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...
 
virtual const xtd::drawing::imagebackground_image () const
 Gets the background image displayed in the control. More...
 
virtual controlbackground_image (const xtd::drawing::image &background_image)
 Sets the background image displayed in the control. More...
 
virtual xtd::forms::image_layout background_image_layout () const
 Gets the background image layout as defined in the xtd::forms::image_layout enumeration. More...
 
virtual controlbackground_image_layout (xtd::forms::image_layout background_image_layout)
 Sets the background image layout as defined in the xtd::forms::image_layout enumeration. More...
 
std::shared_ptr< xtd::iasync_resultbegin_invoke (delegate< void()> value)
 Executes the specified delegate asynchronously on the thread that the control's underlying handle was created on. More...
 
std::shared_ptr< xtd::iasync_resultbegin_invoke (delegate< void(std::vector< std::any >)> value, const std::vector< std::any > &args)
 Executes the specified delegate asynchronously with the specified arguments, on the thread that the control's underlying handle was created on. More...
 
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 ()
 Brings the control to the front of the z-order. More...
 
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 xtd::ustring company_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 ()
 Forces the creation of the visible control, including the creation of the handle and any visible child controls. More...
 
drawing::graphics create_graphics () const
 Creates the xtd::drawing::graphics for the control. More...
 
virtual void create_handle ()
 Creates a handle for the control. More...
 
virtual bool created ()
 Gets a value indicating whether the control has been created. More...
 
virtual forms::cursor cursor () const
 Gets the cursor that is displayed when the mouse pointer is over the control. More...
 
virtual controlcursor (const forms::cursor &cursor)
 Sets the cursor that is displayed when the mouse pointer is over the control. More...
 
virtual drawing::color default_back_color () const
 Gets the default background color of the control. More...
 
virtual forms::cursor default_cursor () const
 Gets the default cursor for the control. More...
 
virtual drawing::font default_font () const
 Gets the default font of the control. More...
 
virtual drawing::color default_fore_color () const
 Gets the default foreground color of the control. More...
 
virtual void destroy_control ()
 Forces the destruction of the visible control, including the destruction of the handle and any visible child controls. More...
 
virtual void destroy_handle ()
 Destroys the handle associated with the control. More...
 
virtual drawing::rectangle display_rectangle () const
 Gets the rectangle that represents the display area of the control. More...
 
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)
 Sets or sets which control borders are docked to its parent control and determines how a control is resized with its parent. More...
 
virtual bool double_buffered () const
 Gets a value indicating whether this control should redraw its surface using a secondary buffer to reduce or prevent flicker. More...
 
virtual controldouble_buffered (bool double_buffered)
 Sets a value indicating whether this control should redraw its surface using a secondary buffer to reduce or prevent flicker. More...
 
virtual bool enabled () const
 Gets a value indicating whether the control can respond to user interaction. More...
 
virtual controlenabled (bool enabled)
 Sets a value indicating whether the control can respond to user interaction. More...
 
void end_invoke (std::shared_ptr< xtd::iasync_result > async)
 Retrieves the return value of the asynchronous operation represented by the async_result_invoke passed. More...
 
bool focus ()
 Sets input focus to the control. More...
 
virtual bool focused () const
 Gets a value indicating whether the control has input focus. More...
 
virtual drawing::font font () const
 Gets the font of the text displayed by the control. More...
 
virtual controlfont (const drawing::font &font)
 Sets the font of the text displayed by the control. More...
 
virtual drawing::color fore_color () const
 Gets the foreground color of the control. More...
 
virtual controlfore_color (const drawing::color &color)
 Sets the foreground color of the control. More...
 
size_t get_child_index (intptr_t child) const
 Retrieves the index of a control within the control collection. More...
 
size_t get_child_index (intptr_t child, bool &throw_exception) const
 Retrieves the index of the specified child control within the control collection, and optionally raises an exception if the specified control is not within the control collection. More...
 
intptr_t handle () const override
 Gets the window handle that the control is bound to. More...
 
virtual int32_t height () const
 Gets the height of the control. More...
 
virtual controlheight (int32_t height)
 Sets the height of the control. More...
 
virtual void hide ()
 Conceals the control from the user. More...
 
virtual void invalidate () const
 Invalidates the entire surface of the control and causes the control to be redrawn. More...
 
virtual void invalidate (bool invalidate_children) const
 Invalidates a specific region of the control and causes a paint message to be sent to the control. Optionally, invalidates the child controls assigned to the control. More...
 
virtual void invalidate (const drawing::rectangle &rect) const
 Invalidates the specified region of the control (adds it to the control's update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control. More...
 
virtual void invalidate (const drawing::rectangle &rect, bool invalidate_children) const
 Invalidates the specified region of the control (adds it to the control's update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control. Optionally, invalidates the child controls assigned to the control. More...
 
void invoke (delegate< void()> value)
 Executes the specified delegate on the thread that owns the control's underlying window handle. More...
 
void invoke (delegate< void(std::vector< std::any >)> value, const std::vector< std::any > &args)
 Executes the specified delegate, on the thread that owns the control's underlying window handle, with the specified list of arguments. More...
 
bool is_handle_created () const
 Gets a value indicating whether the control has a handle associated with it. More...
 
virtual int32_t left () const
 Gets the distance, in pixels, between the left edge of the control and the left edge of its container's client area. More...
 
virtual controlleft (int32_t left)
 Sets the distance, in pixels, between the left edge of the control and the left edge of its container's client area. More...
 
virtual drawing::point location () const
 Gets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container. More...
 
virtual controllocation (const drawing::point &location)
 Sets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container. More...
 
virtual forms::padding margin () const
 Gets the space between controls. More...
 
virtual controlmargin (const forms::padding &margin)
 Sets the space between controls. More...
 
virtual const drawing::sizemaximum_size () const
 Gets the size that is the upper limit that xtd::forms::control::get_preferred_size can specify. More...
 
virtual controlmaximum_size (const drawing::size &size)
 Sets the size that is the upper limit that xtd::forms::control::get_preferred_size can specify. More...
 
virtual const drawing::sizeminimum_size () const
 Gets the size that is the lower limit that xtd::forms::control::get_preferred_size can specify. More...
 
virtual controlminimum_size (const drawing::size &size)
 Sets the size that is the lower limit that xtd::forms::control::get_preferred_size can specify. More...
 
virtual const xtd::ustringname () const
 Gets the name of the control. More...
 
virtual controlname (const xtd::ustring &name)
 Sets the name of the control. More...
 
virtual forms::padding padding () const
 Gets padding within the control. More...
 
virtual controlpadding (const forms::padding &padding)
 Sets padding within the control. More...
 
virtual std::optional< control_refparent () const
 Gets the parent container of the control. More...
 
virtual controlparent (const control &parent)
 Sets the parent container of the control. More...
 
virtual controlparent (std::nullptr_t)
 Resets the parent container of the control. More...
 
void perform_layout ()
 Forces the control to apply layout logic to all its child controls. More...
 
xtd::drawing::point point_to_client (const xtd::drawing::point &p)
 Computes the location of the specified screen point into client coordinates. More...
 
xtd::drawing::point point_to_screen (const xtd::drawing::point &p)
 Computes the location of the specified client point into screen coordinates. More...
 
virtual bool pre_process_message (xtd::forms::message &message)
 Preprocesses keyboard or input messages within the message loop before they are dispatched. More...
 
virtual xtd::ustring product_name () const
 Gets the product name of the assembly containing the control. More...
 
bool recreating_handle () const
 Gets a value indicating whether the control is currently re-creating its handle. More...
 
virtual void refresh () const
 Forces the control to invalidate its client area and immediately redraw itself and any child controls. More...
 
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
 Gets the distance, in pixels, between the right edge of the control and the left edge of its container's client area. More...
 
intptr_t send_message (intptr_t hwnd, int32_t msg, intptr_t wparam, intptr_t lparam) const
 Send a message with specified hwnd, message, wparam and lparam. More...
 
void set_auto_size_mode (auto_size_mode auto_size_mode)
 Sets a value indicating how a control will behave when its auto_size property is enabled. More...
 
void set_bounds (int32_t x, int32_t y, int32_t width, int32_t height)
 Sets the bounds of the control to the specified location and size. More...
 
void set_bounds (int32_t x, int32_t y, int32_t width, int32_t height, bounds_specified specified)
 Sets the specified bounds of the control to the specified location and size. More...
 
virtual void show ()
 Displays the control to the user. More...
 
virtual const drawing::sizesize () const
 Gets the height and width of the control. More...
 
virtual controlsize (const drawing::size &size)
 Sets the height and width of the control. 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 xtd::ustringtext () const
 Gets the text associated with this control. More...
 
virtual controltext (const xtd::ustring &text)
 Sets the text associated with this control. More...
 
virtual int32_t top () const
 Gets the distance, in pixels, between the top edge of the control and the top edge of its container's client area. More...
 
virtual controltop (int32_t top)
 Sets the distance, in pixels, between the top edge of the control and the top edge of its container's client area. More...
 
virtual std::optional< control_reftop_level_control () const
 Gets the parent control that is not parented by another Windows Forms control. Typically, this is the outermost Form that the control is contained in. More...
 
virtual void update () const
 Causes the control to redraw the invalidated regions within its client area. More...
 
virtual bool visible () const
 Gets a value indicating whether the control and all its child controls are displayed. More...
 
virtual controlvisible (bool visible)
 Sets a value indicating whether the control and all its child controls are displayed. More...
 
virtual int32_t width () const
 Gets the width of the control. More...
 
virtual controlwidth (int32_t width)
 Sets the width of the control. 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...
 

Protected Member Functions

forms::create_params create_params () const override
 Gets the required creation parameters when the control handle is created. More...
 
drawing::size measure_control () const override
 Measure this control. More...
 
void on_handle_created (const event_args &e) override
 Overrides control::on_handle_created(const event_args&) More...
 
virtual void on_scroll (const event_args &e)
 Raises the track_bar::scroll event. More...
 
virtual void on_value_changed (const event_args &e)
 Raises the track_bar::value_changed event. More...
 
void set_bounds_core (int32_t x, int32_t y, int32_t width, int32_t height, bounds_specified specified) override
 Performs the work of setting the specified bounds of this control. More...
 
void set_client_size_core (int32_t width, int32_t height) override
 Sets the size of the client area of the control. More...
 
void wnd_proc (message &message) override
 Processes Windows messages. More...
 
- Protected Member Functions inherited from xtd::forms::control
virtual void def_wnd_proc (message &message)
 Sends the specified message to the default window procedure. More...
 
bool get_style (control_styles flag) const
 Retrieves the value of the specified control style bit for the control. More...
 
drawing::size measure_text () const
 Measure this control text. More...
 
virtual void on_auto_size_changed (const event_args &e)
 Raises the control::auto_size_changed event. More...
 
virtual void on_back_color_changed (const event_args &e)
 Raises the control::back_color_changed event. More...
 
virtual void on_background_image_changed (const event_args &e)
 Raises the control::background_image_changed event. More...
 
virtual void on_background_image_layout_changed (const event_args &e)
 Raises the control::background_image_layout_changed event. More...
 
virtual void on_click (const event_args &e)
 Raises the control::click event. More...
 
virtual void on_client_size_changed (const event_args &e)
 Raises the control::client_size_changed event. More...
 
virtual void on_control_added (const control_event_args &e)
 Raises the control::control_added event. More...
 
virtual void on_control_removed (const control_event_args &e)
 Raises the control::control_removed event. More...
 
virtual void on_create_control ()
 Raises the control::create_control event. More...
 
virtual void on_cursor_changed (const event_args &e)
 Raises the control::cursor_changed event. More...
 
virtual void on_dock_changed (const event_args &e)
 Raises the control::dock_changed event. More...
 
virtual void on_double_click (const event_args &e)
 Raises the double_click event. More...
 
virtual void on_enabled_changed (const event_args &e)
 Raises the control::enabled_changed event. More...
 
virtual void on_font_changed (const event_args &e)
 Raises the control::font_changed event. More...
 
virtual void on_fore_color_changed (const event_args &e)
 Raises the control::fore_color_changed event. More...
 
virtual void on_got_focus (const event_args &e)
 Raises the control::got_focus event. More...
 
virtual void on_handle_destroyed (const event_args &e)
 Raises the control::handle_destroyed event. More...
 
virtual void on_key_down (key_event_args &e)
 Raises the control::key_down event. More...
 
virtual void on_key_press (key_press_event_args &e)
 Raises the control::key_press event. More...
 
virtual void on_key_up (key_event_args &e)
 Raises the control::key_up event. More...
 
virtual void on_layout (const event_args &e)
 Raises the control::layout event. More...
 
virtual void on_location_changed (const event_args &e)
 Raises the control::location_changed event. More...
 
virtual void on_lost_focus (const event_args &e)
 Raises the control::lost_focus event. More...
 
virtual void on_mouse_click (const mouse_event_args &e)
 Raises the control::mouse_click event. More...
 
virtual void on_mouse_double_click (const mouse_event_args &e)
 Raises the control::mouse_double_click event. More...
 
virtual void on_mouse_down (const mouse_event_args &e)
 Raises the control::mouse_down event. More...
 
virtual void on_mouse_enter (const event_args &e)
 Raises the control::mouse_enter event. More...
 
virtual void on_mouse_horizontal_wheel (const mouse_event_args &e)
 Raises the control::mouse_horizontal_wheel event. More...
 
virtual void on_mouse_leave (const event_args &e)
 Raises the control::mouse_leave event. More...
 
virtual void on_mouse_move (const mouse_event_args &e)
 Raises the control::mouse_move event. More...
 
virtual void on_mouse_up (const mouse_event_args &e)
 Raises the control::mouse_up event. More...
 
virtual void on_mouse_wheel (const mouse_event_args &e)
 Raises the control::mouse_wheel event. More...
 
virtual void on_paint (paint_event_args &e)
 Raises the control::paint event. More...
 
virtual void on_parent_back_color_changed (const event_args &e)
 Raises the control::parent_back_color_changed event. More...
 
virtual void on_parent_changed (const event_args &e)
 Raises the control::parent_changed event. More...
 
virtual void on_parent_cursor_changed (const event_args &e)
 Raises the control::parent_cursor_changed event. More...
 
virtual void on_parent_enabled_changed (const event_args &e)
 Raises the xtd::control::enabled_changed event when the xtd::control::enabled property value of the control's container changes.. More...
 
virtual void on_parent_font_changed (const event_args &e)
 Raises the control::parent_font_changed event. More...
 
virtual void on_parent_fore_color_changed (const event_args &e)
 Raises the control::parent_fore_color_changed event. More...
 
virtual void on_resize (const event_args &e)
 Raises the control::resize event. More...
 
virtual void on_size_changed (const event_args &e)
 Raises the control::size_changed event. More...
 
virtual void on_text_changed (const event_args &e)
 Raises the control::text_changed event. More...
 
virtual void on_visible_changed (const event_args &e)
 Raises the control::visible_changed event. More...
 
virtual void recreate_handle ()
 Forces the re-creation of the handle for the control. More...
 
void set_style (control_styles flag, bool value)
 Sets a specified control_styles flag to either true or false. More...
 
- Protected Member Functions inherited from xtd::forms::component
 component ()=default
 Initialises a new instance of the component class. More...
 
bool design_mode () const
 Gets a value that indicates whether the component is currently in design mode. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from xtd::forms::control
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)
 A factory to create a specified control with specified location ,size back_color and fore_color. More...
 
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)
 A factory to create a specified control with specified parent, location ,size back_color and fore_color. More...
 
template<typename control_t >
static std::unique_ptr< control_t > create (const xtd::ustring &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)
 A factory to create a specified control with specified text, location ,size back_color and fore_color. More...
 
template<typename control_t >
static std::unique_ptr< control_t > create (const control &parent, const xtd::ustring &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)
 A factory to create a specified control with specified parent, text, location ,size back_color and fore_color. More...
 
static std::optional< control_reffrom_child_handle (intptr_t handle)
 Retrieves the control that contains the specified handle. More...
 
static std::optional< control_reffrom_handle (intptr_t handle)
 Returns the control that is currently associated with the specified handle. More...
 
static forms::keys modifier_keys ()
 Gets a value indicating which of the modifier keys (SHIFT, CTRL, and ALT) is in a pressed state. More...
 
static forms::mouse_buttons mouse_buttons ()
 Gets a value indicating which of the mouse buttons is in a pressed state. 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

◆ track_bar()

xtd::forms::track_bar::track_bar ( )

Initializes a new instance of the track_bar class.

Remarks
The track_bar is created with a default horizontal orientation and a range of 0 to 10, with a tick mark shown for every value.

Member Function Documentation

◆ create_params()

forms::create_params xtd::forms::track_bar::create_params ( ) const
overrideprotectedvirtual

Gets the required creation parameters when the control handle is created.

Returns
A create_params that contains the required creation parameters when the handle to the control is created.

Reimplemented from xtd::forms::control.

◆ default_size()

drawing::size xtd::forms::track_bar::default_size ( ) const
inlineoverridevirtual

Gets the default size of the control.

Returns
A size that represents the default size of the control.

Reimplemented from xtd::forms::control.

◆ large_change() [1/2]

virtual int32_t xtd::forms::track_bar::large_change ( )
inlinevirtual

Gets a value to be added to or subtracted from the value property when the scroll box is moved a large distance.

Returns
A numeric value. The default is 5.
Remarks
When the user presses the PAGE UP or PAGE DOWN key or clicks the track bar on either side of the scroll box, the value property changes according to the value set in the large_change property. You might consider setting the large_change value to a percentage of the height (for a vertically oriented track bar) or width (for a horizontally oriented track bar) value. This keeps the distance your track bar moves proportionate to its size.

◆ large_change() [2/2]

virtual track_bar& xtd::forms::track_bar::large_change ( int32_t  large_change)
virtual

Sets a value to be added to or subtracted from the value property when the scroll box is moved a large distance.

Parameters
large_changeA numeric value. The default is 5.
Returns
Current track_bar instance.
Remarks
When the user presses the PAGE UP or PAGE DOWN key or clicks the track bar on either side of the scroll box, the value property changes according to the value set in the large_change property. You might consider setting the large_change value to a percentage of the height (for a vertically oriented track bar) or width (for a horizontally oriented track bar) value. This keeps the distance your track bar moves proportionate to its size.

◆ maximum() [1/2]

virtual int32_t xtd::forms::track_bar::maximum ( )
inlinevirtual

Gets the upper limit of the range this track_bar is working with.

Returns
The maximum value for the track_bar. The default is 10.

◆ maximum() [2/2]

virtual track_bar& xtd::forms::track_bar::maximum ( int32_t  maximum)
virtual

sets the upper limit of the range this track_bar is working with.

Parameters
maximumThe maximum value for the track_bar. The default is 10.
Returns
Current track_bar instance.
Remarks
You can use the set_range method to set both the maximum and minimum properties at the same time.

◆ measure_control()

drawing::size xtd::forms::track_bar::measure_control ( ) const
overrideprotectedvirtual

Measure this control.

Returns
The drawing::size size of this control.

Reimplemented from xtd::forms::control.

◆ minimum() [1/2]

virtual int32_t xtd::forms::track_bar::minimum ( )
inlinevirtual

Gets the lower limit of the range this track_bar is working with.

Returns
The minimum value for the track_bar. The default is 0.

◆ minimum() [2/2]

virtual track_bar& xtd::forms::track_bar::minimum ( int32_t  minimum)
virtual

Sets the lower limit of the range this track_bar is working with.

Parameters
minimumThe minimum value for the track_bar. The default is 0.
Returns
Current track_bar instance.
Remarks
You can use the set_range method to set both the maximum and minimum properties at the same time.

◆ on_handle_created()

void xtd::forms::track_bar::on_handle_created ( const event_args e)
overrideprotectedvirtual

Overrides control::on_handle_created(const event_args&)

Parameters
eA EventArgs that contains the event data.

Reimplemented from xtd::forms::control.

◆ on_scroll()

virtual void xtd::forms::track_bar::on_scroll ( const event_args e)
protectedvirtual

Raises the track_bar::scroll event.

Parameters
eAn event_args that contains the event data.
Remarks
You can use the OnScroll event to update other controls as the position of the scroll box changes.
Raising an event invokes the event handler through a delegate.
The on_scroll method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.
Notes to Inheritors
Remarks
When overriding on_scroll(const event_args&) in a derived class, be sure to call the base class' on_scroll(const event_args&) method so that registered delegates receive the event.

◆ on_value_changed()

virtual void xtd::forms::track_bar::on_value_changed ( const event_args e)
protectedvirtual

Raises the track_bar::value_changed event.

Parameters
eThe event_args that contains the event data.

◆ orientation() [1/2]

virtual forms::orientation xtd::forms::track_bar::orientation ( ) const
inlinevirtual

Gets a value indicating the horizontal or vertical orientation of the track bar.

Returns
One of the orientation values.

◆ orientation() [2/2]

virtual track_bar& xtd::forms::track_bar::orientation ( forms::orientation  orientation)
virtual

Sets a value indicating the horizontal or vertical orientation of the track bar.

Parameters
orientationOne of the orientation values.
Returns
Current track_bar instance.
Remarks
When the orientation property is set to orientation::horizontal, the scroll box moves from left to right as the value increases. When the orientation property is set to orientation::vertical, the scroll box moves from bottom to top as the Value increases.

◆ set_bounds_core()

void xtd::forms::track_bar::set_bounds_core ( int32_t  x,
int32_t  y,
int32_t  width,
int32_t  height,
bounds_specified  specified 
)
inlineoverrideprotectedvirtual

Performs the work of setting the specified bounds of this control.

Parameters
xThe new left property value of the control.
yThe new top property value of the control.
widthThe new width property value of the control.
heightThe new height property value of the control.
specifiedA bitwise combination of the bounds_specified values.

Reimplemented from xtd::forms::control.

◆ set_client_size_core()

void xtd::forms::track_bar::set_client_size_core ( int32_t  width,
int32_t  height 
)
inlineoverrideprotectedvirtual

Sets the size of the client area of the control.

Parameters
widthThe client area width, in pixels.
heightThe client area height, in pixels.

Reimplemented from xtd::forms::control.

◆ set_range()

void xtd::forms::track_bar::set_range ( int  min_value,
int  max_value 
)
inline

Sets the minimum and maximum values for a xtd::forms::track_bar.

Parameters
min_valueThe lower limit of the range of the track bar.
max_valueThe upper limit of the range of the track bar.
Remarks
You can use this method to set the entire range for the xtd::forms::track_bar at the same time. To set the minimum or maximum values individually, use the xtd::forms::track_bar::minimum and xtd::forms::track_bar::maximum properties. If the min_value parameter is greater than the max_value parameter, max_value is set equal to min_value.

◆ small_change() [1/2]

virtual int32_t xtd::forms::track_bar::small_change ( )
inlinevirtual

Gets he value added to or subtracted from the Value property when the scroll box is moved a small distance.

Returns
A numeric value. The default value is 1.
Remarks
When the user presses one of the arrow keys, the value property changes according to the value set in the small_change property.
You might consider setting the value of small_change to a percentage of the value of the height (for a vertically oriented track bar) or width (for a horizontally oriented track bar) property. This sets the distance your track bar moves proportionate to its size.

◆ small_change() [2/2]

virtual track_bar& xtd::forms::track_bar::small_change ( int32_t  small_change)
virtual

Sets the value added to or subtracted from the Value property when the scroll box is moved a small distance.

Parameters
small_changeA numeric value. The default value is 1.
Returns
Current track_bar instance.
Remarks
When the user presses one of the arrow keys, the value property changes according to the value set in the small_change property.
You might consider setting the value of small_change to a percentage of the value of the height (for a vertically oriented track bar) or width (for a horizontally oriented track bar) property. This sets the distance your track bar moves proportionate to its size.

◆ tick_frequency() [1/2]

virtual int32_t xtd::forms::track_bar::tick_frequency ( )
inlinevirtual

Gets a value that specifies the delta between ticks drawn on the control.

Returns
The numeric value representing the delta between ticks. The default is 1.
Remarks
For a track_bar with a large range of values between the minimum and the maximum properties, it might be impractical to draw all the ticks for values on the control. For example, if you have a control with a range of 100, passing in a value of 5 here causes the control to draw 20 ticks. In this case, each tick represents five units in the range of values.

◆ tick_frequency() [2/2]

virtual track_bar& xtd::forms::track_bar::tick_frequency ( int32_t  tick_frequency)
virtual

Sets a value that specifies the delta between ticks drawn on the control.

Parameters
tick_frequencyThe numeric value representing the delta between ticks. The default is 1.
Returns
Current track_bar instance.
Remarks
For a track_bar with a large range of values between the minimum and the maximum properties, it might be impractical to draw all the ticks for values on the control. For example, if you have a control with a range of 100, passing in a value of 5 here causes the control to draw 20 ticks. In this case, each tick represents five units in the range of values.

◆ tick_style() [1/2]

virtual forms::tick_style xtd::forms::track_bar::tick_style ( )
inlinevirtual

Gets a value indicating how to display the tick marks on the track bar.

Returns
One of the Tick_style values. The default is bottom_right.
Remarks
You can use the tick_style property to modify the manner in which the tick marks are displayed on the track bar.

◆ tick_style() [2/2]

virtual track_bar& xtd::forms::track_bar::tick_style ( forms::tick_style  tick_style)
virtual

Sets a value indicating how to display the tick marks on the track bar.

Parameters
tick_styleOne of the tick_style values. The default is bottom_right.
Returns
Current track_bar instance.
Remarks
You can use the tick_style property to modify the manner in which the tick marks are displayed on the track bar.

◆ to_string()

xtd::ustring xtd::forms::track_bar::to_string ( ) const
inlineoverridevirtualnoexcept

Returns a string that represents the track_bar control.

Returns
A string that represents the current progress_bar.
Remarks
The return string includes the type and the values for the minimum, maximum, and value properties.

Reimplemented from xtd::forms::control.

◆ value() [1/2]

virtual int32_t xtd::forms::track_bar::value ( )
inlinevirtual

Gets a numeric value that represents the current position of the scroll box on the track bar.

Returns
A numeric value that is within the minimum and maximum range. The default value is 0.
Remarks
The Value property contains the number that represents the current position of the scroll box on the track bar.

◆ value() [2/2]

virtual track_bar& xtd::forms::track_bar::value ( int32_t  value)
virtual

Sets a numeric value that represents the current position of the scroll box on the track bar.

Parameters
valueA numeric value that is within the minimum and maximum range. The default value is 0.
Returns
Current track_bar instance.
Remarks
The Value property contains the number that represents the current position of the scroll box on the track bar.

◆ wnd_proc()

void xtd::forms::track_bar::wnd_proc ( message message)
overrideprotectedvirtual

Processes Windows messages.

Parameters
mThe Windows Message to process.
Remarks
All messages are sent to the wnd_proc method after getting filtered through the pre_process_message method.

Reimplemented from xtd::forms::control.


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