Inheritance diagram for xtd::forms::native::progress_dialog:

Definition

Contains progress dialog native API.

Namespace: xtd::forms::native

Library: xtd.forms.native

Warning: Internal use only

Protected Static Methods
static bool	cancelled (intptr dialog)
	Gets whether user has clicked on cancel button.

static intptr	create (intptr hwnd, const xtd::string &text, const xtd::string &message, const std::vector< xtd::string > &informations, size_t marquee_animation_speed, int32 minimum, int32 maximum, int32 value, size_t options)
	Creates progress dialog.

static void	destroy (intptr dialog)
	Destroys progress dialog.

static void	informations (intptr dialog, const std::vector< xtd::string > &informations)
	Sets the information texts.

static void	marquee (intptr dialog, bool marquee, size_t animation_speed)
	Gets a value that Indicates progress by continuously scrolling a block across a progress_bar in a marquee fashion.

static void	maximum (intptr dialog, int32 maximum)
	Sets the maximum value of the range of the control.

static void	message (intptr dialog, const xtd::string &message)
	Sets the message text.

static void	minimum (intptr dialog, int32 minimum)
	Sets the minimum value of the range of the control.

static void	resume (intptr dialog)
	Resume progress dialog box after Abort button clicked.

static void	show (intptr dialog)
	Runs progress dialog box.

static void	show_sheet (intptr dialog)
	Runs progress dialog box as sheet.

static bool	skipped (intptr dialog)
	Gets whether user has clicked on skip button.

static void	value (intptr dialog, int32 value)
	Sets the current position of the progress bar.

Member Function Documentation

◆ cancelled()

static bool xtd::forms::native::progress_dialog::cancelled ( intptr dialog )

staticprotected

Gets whether user has clicked on cancel button.

Parameters

dialog Progress dialog window handle.

Returns: true if user has clicked on cancel button; otherwise false.

Warning: Internal use only

◆ create()

static intptr xtd::forms::native::progress_dialog::create	(	intptr	hwnd,
		const xtd::string &	text,
		const xtd::string &	message,
		const std::vector< xtd::string > &	informations,
		size_t	marquee_animation_speed,
		int32	minimum,
		int32	maximum,
		int32	value,
		size_t	options
	)

staticprotected

Creates progress dialog.

Parameters

hwnd	Parent window handle.
text	A string that specifies the title bar caption to display.
message	A string that specifies the text to display.
informations	The information texts.
marquee_animation_speed	The time period, in milliseconds, that it takes the progress block to scroll across the progress bar.
minimum	The minimum value of the range.
maximum	The maximum value of the range.
value	The position within the range of the progress bar. The default is 0.
options	A bitwise progress dialog flags value.

Returns: The created progress dialog window handle.

Warning: Internal use only

◆ destroy()

static void xtd::forms::native::progress_dialog::destroy ( intptr dialog )

staticprotected

Destroys progress dialog.

Parameters

dialog Progress dialog window handle to destroy.

Warning: Internal use only

◆ informations()

static void xtd::forms::native::progress_dialog::informations	(	intptr	dialog,
		const std::vector< xtd::string > &	informations
	)

staticprotected

Sets the information texts.

Parameters

dialog	Progress dialog window handle.
informations	The information texts.

Warning: Internal use only

◆ marquee()

static void xtd::forms::native::progress_dialog::marquee	(	intptr	dialog,
		bool	marquee,
		size_t	animation_speed
	)

staticprotected

Gets a value that Indicates progress by continuously scrolling a block across a progress_bar in a marquee fashion.

Parameters

dialog	Progress dialog window handle.
marquee	tree is marquee; otherwise false. The default is false.

Warning: Internal use only

◆ maximum()

static void xtd::forms::native::progress_dialog::maximum	(	intptr	dialog,
		int32	maximum
	)

staticprotected

Sets the maximum value of the range of the control.

Parameters

dialog	Progress dialog window handle.
maximum	The maximum value of the range.

Warning: Internal use only

◆ message()

static void xtd::forms::native::progress_dialog::message	(	intptr	dialog,
		const xtd::string &	message
	)

staticprotected

Sets the message text.

Parameters

dialog	Progress dialog window handle.
description	The message text.

Warning: Internal use only

◆ minimum()

static void xtd::forms::native::progress_dialog::minimum	(	intptr	dialog,
		int32	minimum
	)

staticprotected

Sets the minimum value of the range of the control.

Parameters

dialog	Progress dialog window handle.
minimum	The minimum value of the range.

Warning: Internal use only

◆ resume()

static void xtd::forms::native::progress_dialog::resume ( intptr dialog )

staticprotected

Resume progress dialog box after Abort button clicked.

Parameters

dialog Progress dialog window handle.

Warning: Internal use only

◆ show()

static void xtd::forms::native::progress_dialog::show ( intptr dialog )

staticprotected

Runs progress dialog box.

Parameters

dialog Progress dialog window handle.

Warning: Internal use only

◆ show_sheet()

static void xtd::forms::native::progress_dialog::show_sheet ( intptr dialog )

staticprotected

Runs progress dialog box as sheet.

Parameters

dialog Progress dialog window handle.

Warning: Internal use only

◆ skipped()

static bool xtd::forms::native::progress_dialog::skipped ( intptr dialog )

staticprotected

Gets whether user has clicked on skip button.

Parameters

dialog Progress dialog window handle.

Returns: true if user has clicked on skip button; otherwise false.

Warning: Internal use only

◆ value()

static void xtd::forms::native::progress_dialog::value	(	intptr	dialog,
		int32	value
	)

staticprotected

Sets the current position of the progress bar.

Parameters

dialog	Progress dialog window handle.
value	The position within the range of the progress bar. The default is 0.

Warning: Internal use only

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

xtd.forms.native/include/xtd/forms/native/progress_dialog.h

Definition

Protected Static Methods

Member Function Documentation

◆ cancelled()

◆ create()

◆ destroy()

◆ informations()

◆ marquee()

◆ maximum()

◆ message()

◆ minimum()

◆ resume()

◆ show()

◆ show_sheet()

◆ skipped()

◆ value()