xtd.forms - Reference Guide  0.1.0
Modern c++17 library containing classes for creating Windows-based applications that take full advantage of the rich user interface features available in the Microsoft Windows, Apple macOS and Linux like Ubuntu operating system.
xtd::forms::track_bar Class Reference

Represents a standard Windows track bar. More...

#include <track_bar.hpp>

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

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 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...
 
ustring to_string () const 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 ustring &text)
 Initializes a new instance of the control class with specific text. More...
 
 control (const control &parent, const ustring &text)
 nitializes a new instance of the control class as a child control, with specific text. More...
 
 control (const 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 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 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 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 ustring 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
 
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 enabled () const
 
virtual controlenabled (bool enabled)
 
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 ()
 
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 const ustringname () const
 
virtual controlname (const ustring &name)
 
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...
 
xtd::drawing::point point_to_client (const xtd::drawing::point &p)
 
xtd::drawing::point point_to_screen (const xtd::drawing::point &p)
 
virtual ustring 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)
 
virtual void show ()
 
virtual drawing::size size () const
 
virtual controlsize (const drawing::size &size)
 
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 ustringtext () const
 
virtual controltext (const ustring &text)
 
virtual int32_t top () const
 
virtual controltop (int32_t top)
 
virtual std::optional< control_reftop_level_control () const
 
virtual void update () const
 
virtual bool visible () const
 
virtual controlvisible (bool visible)
 
virtual int32_t width () const
 
virtual controlwidth (int32_t width)
 

Public Attributes

event< track_bar, event_handler< control & > > scroll
 Occurs when either a mouse or keyboard action moves the scroll box. More...
 
event< track_bar, event_handler< control & > > value_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_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...
 
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 Scroll event. More...
 
virtual void on_value_changed (const event_args &e)
 Raises the 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)
 
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
 
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)
 
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 ()
 
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
bool design_mode () const
 Gets a value that indicates whether the component is currently in design mode. More...
 

Additional Inherited Members

- Public Types inherited from xtd::forms::control
using control_collection = layout::arranged_element_collection< control_ref >
 Represents a collection of controls. More...
 
- 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)
 
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 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)
 
template<typename control_t >
static std::unique_ptr< control_t > create (const control &parent, const 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)
 
static std::optional< control_reffrom_child_handle (intptr_t handle)
 
static std::optional< control_reffrom_handle (intptr_t handle)
 
static forms::mouse_buttons mouse_buttons ()
 

Detailed Description

Represents a standard Windows track bar.

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.
Example
The following code example demonstrate the use of track_bar control.
#include <xtd/xtd.forms>
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.orientation(forms::orientation::vertical);
track_bar1.parent(*this);
track_bar1.value_changed += [this](control& sender, const event_args& e) {
progress_bar1.value(track_bar1.value());
label1.text(strings::format("{}", track_bar1.value()));
};
track_bar1.value(100);
track_bar1.tick_style(forms::tick_style::none);
track_bar1.size({45, 200});
}
private:
track_bar track_bar1;
progress_bar progress_bar1;
label label1;
};
int main() {
application::run(form1());
}

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.
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.
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.
Remarks
This metod is not relevant for this class.

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.
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 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
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 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.
Whenthe 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 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 track_bar at the same time. To set the minimum or maximum values individually, use the minimum and 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.
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.
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 Ttick_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.
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()

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

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.
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.

Member Data Documentation

§ scroll

event<track_bar, event_handler<control&> > xtd::forms::track_bar::scroll

Occurs when either a mouse or keyboard action moves the scroll box.

§ value_changed

event<track_bar, event_handler<control&> > xtd::forms::track_bar::value_changed

Occurs when the value property of a track bar changes, either by movement of the scroll box or by manipulation in code.


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