xtd 1.0.0
Loading...
Searching...
No Matches
progress_dialog.hpp
Go to the documentation of this file.
1
4#pragma once
5#include "component.hpp"
7#include "iwin32_window.hpp"
8#include <xtd/string>
9
11namespace xtd {
13 namespace forms {
33 struct data;
34 public:
36
41
45
47
51 [[nodiscard]] auto cancelled() const -> bool;
52
55 [[nodiscard]] auto dialog_appearance() const noexcept -> xtd::forms::dialog_appearance;
60
63 [[nodiscard]] auto informations() const noexcept -> const xtd::array<xtd::string>&;
67 auto informations(const xtd::array<xtd::string>& value) -> progress_dialog&;
68
71 [[nodiscard]] auto marquee() const noexcept -> bool;
76
81 [[nodiscard]] auto marquee_animation_speed() const noexcept -> xtd::usize;
87
92 [[nodiscard]] auto maximum() const noexcept -> xtd::int32;
98
101 [[nodiscard]] auto message() const noexcept -> const xtd::string&;
105 auto message(const xtd::string& value) -> progress_dialog&;
106
110 [[nodiscard]] auto minimum() const noexcept -> xtd::int32;
116
119 [[nodiscard]] auto show_cancel_button() const noexcept -> bool;
124
127 [[nodiscard]] auto show_elapsed_time() const noexcept -> bool;
132
135 [[nodiscard]] auto show_estimated_time() const noexcept -> bool;
140
143 [[nodiscard]] auto show_remaining_time() const noexcept -> bool;
148
151 [[nodiscard]] auto show_skip_button() const noexcept -> bool;
156
159 [[nodiscard]] auto skipped() const -> bool;
160
164 [[nodiscard]] auto step() const noexcept -> xtd::int32;
169
172 [[nodiscard]] auto text() const noexcept -> const xtd::string&;
176 auto text(const xtd::string& value) -> progress_dialog&;
177
183 [[nodiscard]] auto value() const noexcept -> xtd::int32;
191
193
196 auto hide() -> void;
197
202 auto increment(xtd::int32 increment) -> void;
203
206 auto perform_step() -> void;
207
209 auto reset() noexcept -> void;
210
212 auto resume() -> void;
213
215 auto show() -> void;
218 auto show(const xtd::forms::iwin32_window& owner) -> void;
219
222 auto show_sheet(const xtd::forms::iwin32_window& owner) -> void;
223
225 auto show_dialog() -> void;
228 auto show_dialog(const xtd::forms::iwin32_window& owner) -> void;
231 auto show_sheet_dialog(const xtd::forms::iwin32_window& owner) -> void;
233
234 private:
235 auto get_option(xtd::usize flag) const noexcept -> bool;
236 auto set_option(xtd::usize flag, bool value) -> void;
237 auto recreate_dialog() -> void;
238
239 xtd::sptr<data> data_;
240 };
241 }
242}
Provides methods for creating, manipulating, searching, and sorting arrays, thereby serving as the ba...
Definition array.hpp:64
Provides the base implementation and enables object sharing between applications.
Definition component.hpp:26
Provides an interface to expose Win32 HWND handles.
Definition iwin32_window.hpp:23
auto show_remaining_time() const noexcept -> bool
Gets a value that indicates whether remaining time is shown.
auto marquee_animation_speed() const noexcept -> xtd::usize
Gets he time period, in milliseconds, that it takes the progress block to scroll across the progress ...
auto show_elapsed_time() const noexcept -> bool
Gets a value that indicates whether elapsed time is shown.
auto resume() -> void
Resume progress dialog box after Abort button clicked.
auto step() const noexcept -> xtd::int32
Gets the amount by which a call to the PerformStep() method increases the current position of the pro...
auto text() const noexcept -> const xtd::string &
Gets the dialog title.
auto show_skip_button() const noexcept -> bool
Gets a value that indicates whether skip button is shown.
auto show_cancel_button() const noexcept -> bool
Gets a value that indicates whether cancel button is shown.
auto marquee() const noexcept -> bool
Gets a value that Indicates progress by continuously scrolling a block across a progress_bar in a mar...
auto hide() -> void
Hides progress dialog box.
auto maximum() const noexcept -> xtd::int32
Gets the maximum value of the range of the control.
auto show_sheet_dialog(const xtd::forms::iwin32_window &owner) -> void
Runs progress dialog box with specified owner.
auto perform_step() -> void
Advances the current position of the progress bar by the amount of the Step property.
auto show_sheet(const xtd::forms::iwin32_window &owner) -> void
Runs progress dialog box as sheet with specified owner.
auto show_dialog() -> void
Runs progress dialog box.
progress_dialog()
Initializes a new instance of the progress_dialog class.
auto skipped() const -> bool
Gets whether user has clicked on skip button.
auto value() const noexcept -> xtd::int32
Gets the current position of the progress bar.
auto message() const noexcept -> const xtd::string &
Gets the message text.
auto reset() noexcept -> void
Resets all properties to empty string.
auto show_estimated_time() const noexcept -> bool
Gets a value that indicates whether estimated time is shown.
auto cancelled() const -> bool
Gets whether user has clicked on cancel button.
auto show() -> void
Runs progress dialog box.
auto minimum() const noexcept -> xtd::int32
Gets the minimum value of the range of the control.
auto dialog_appearance() const noexcept -> xtd::forms::dialog_appearance
Gets the dialog appearance.
auto informations() const noexcept -> const xtd::array< xtd::string > &
Gets the information texts.
auto increment(xtd::int32 increment) -> void
Advances the current position of the progress bar by the specified amount.
Contains xtd::forms::component class.
Contains xtd::forms::dialog_appearance enum class.
#define forms_export_
Define shared library export.
Definition forms_export.hpp:13
xtd::shared_ptr_object< type_t > sptr
The xtd::sptr object is a shared pointer.
Definition sptr.hpp:25
std::int32_t int32
Represents a 32-bit signed integer.
Definition int32.hpp:25
std::size_t usize
Represents an unsigned size of any object in bytes.
Definition usize.hpp:22
Contains xtd::forms::iwin32_window interface.
The xtd::forms namespace contains classes for creating Windows-based applications that take full adva...
Definition texts.hpp:219
The xtd namespace contains all fundamental classes to access Hardware, Os, System,...
Definition abstract_object.hpp:8
constexpr auto data() const noexcept -> const_pointer
Gets direct access to the underlying contiguous storage.
Definition read_only_span.hpp:197