xtd 0.2.0
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 bool cancelled() const;
52
60
63 const xtd::array<xtd::string>& informations() const noexcept;
68
71 bool marquee() const noexcept;
76
81 size_t marquee_animation_speed() const noexcept;
87
92 int32 maximum() const noexcept;
98
101 const xtd::string& message() const noexcept;
106
110 int32 minimum() const noexcept;
116
119 bool show_cancel_button() const noexcept;
124
127 bool show_elapsed_time() const noexcept;
132
135 bool show_estimated_time() const noexcept;
140
143 bool show_remaining_time() const noexcept;
148
151 bool show_skip_button() const noexcept;
156
159 bool skipped() const;
160
164 virtual int32 step() const noexcept;
169
172 const xtd::string& text() const noexcept;
176 progress_dialog& text(const xtd::string& text);
177
183 int32 value() const noexcept;
191
193
196 void hide();
197
203
207
209 void reset() noexcept;
210
212 void resume();
213
215 void show();
217 void show(const iwin32_window& owner);
218
220 void show_sheet(const iwin32_window& owner);
221
225 void show_dialog(const iwin32_window& owner);
229
230 private:
231 bool get_option(size_t flag) const noexcept;
232 void set_option(size_t flag, bool value);
233 void recreate_dialog();
234
235 xtd::sptr<data> data_;
236 };
237 }
238}
Provides methods for creating, manipulating, searching, and sorting arrays, thereby serving as the ba...
Definition array.hpp:61
component()
Initialises a new instance of the component class.
Provides an interface to expose Win32 HWND handles.
Definition iwin32_window.hpp:23
const xtd::string & message() const noexcept
Gets the message text.
bool show_elapsed_time() const noexcept
Gets a value that indicates whether elapsed time is shown.
int32 maximum() const noexcept
Gets the maximum value of the range of the control.
const xtd::array< xtd::string > & informations() const noexcept
Gets the information texts.
bool show_remaining_time() const noexcept
Gets a value that indicates whether remaining time is shown.
bool skipped() const
Gets whether user has clicked on skip button.
virtual int32 step() const noexcept
Gets the amount by which a call to the PerformStep() method increases the current position of the pro...
void show_dialog()
Runs progress dialog box.
void hide()
Hides progress dialog box.
void perform_step()
Advances the current position of the progress bar by the amount of the Step property.
xtd::forms::dialog_appearance dialog_appearance() const noexcept
Gets the dialog appearance.
void resume()
Resume progress dialog box after Abort button clicked.
bool show_estimated_time() const noexcept
Gets a value that indicates whether estimated time is shown.
void reset() noexcept
Resets all properties to empty string.
int32 minimum() const noexcept
Gets the minimum value of the range of the control.
progress_dialog()
Initializes a new instance of the progress_dialog class.
void show_sheet(const iwin32_window &owner)
Runs progress dialog box as sheet.
void show_sheet_dialog(const iwin32_window &owner)
Runs progress dialog box.
void show()
Runs progress dialog box.
bool marquee() const noexcept
Gets a value that Indicates progress by continuously scrolling a block across a progress_bar in a mar...
void increment(int32 increment)
Advances the current position of the progress bar by the specified amount.
bool cancelled() const
Gets whether user has clicked on cancel button.
bool show_skip_button() const noexcept
Gets a value that indicates whether skip button is shown.
int32 value() const noexcept
Gets the current position of the progress bar.
bool show_cancel_button() const noexcept
Gets a value that indicates whether cancel button is shown.
const xtd::string & text() const noexcept
Gets the dialog title.
size_t marquee_animation_speed() const noexcept
Gets he time period, in milliseconds, that it takes the progress block to scroll across the progress ...
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
int32_t int32
Represents a 32-bit signed integer.
Definition int32.hpp:23
control_appearance dialog_appearance
Specifies the appearance of a dialog.
Definition dialog_appearance.hpp:21
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 const_pointer data() const noexcept
Gets direct access to the underlying contiguous storage.
Definition read_only_span.hpp:201