napcok/calamares
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[libcalamaresui] APIDOX for ErrorDialog

Browse Source
This commit is contained in:
Adriaan de Groot 2021-12-07 12:40:05 +01:00
parent 49890acd04
commit ca7f288488
1 changed files with 29 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
src/libcalamaresui/widgets/ErrorDialog.h
View File

@ -7,17 +7,16 @@
* *
*/ */
#ifndef ERRORDIALOG_H #ifndef LIBCALAMARESUI_ERRORDIALOG_H
#define ERRORDIALOG_H #define LIBCALAMARESUI_ERRORDIALOG_H
#include <QDialog> #include <QDialog>
namespace Ui namespace Ui
{ {
class ErrorDialog; class ErrorDialog;
} }
class QDialogButtonBox;
namespace Calamares namespace Calamares
{ {
class ErrorDialog : public QDialog class ErrorDialog : public QDialog
@ -32,30 +31,46 @@ class ErrorDialog : public QDialog
public: public:
explicit ErrorDialog( QWidget* parent = nullptr ); explicit ErrorDialog( QWidget* parent = nullptr );
~ErrorDialog(); ~ErrorDialog() override;
/** @brief The heading (title) of the error dialog
*
* This is a short (one-line) title. It is human-readable, so should
* be translated at the time it is set.
*/
QString heading() const; QString heading() const;
QString informativeText() const;
QString details() const;
void setHeading( const QString& newHeading ); void setHeading( const QString& newHeading );
/** @brief The description of the problem
*
* Longer, human-readable, description of the problem. This text
* is word-wrapped as necessary.
*/
QString informativeText() const;
void setInformativeText( const QString& newInformativeText ); void setInformativeText( const QString& newInformativeText );
/** @brief Details of the problem
*
* This is generally command-output; it might not be translated
* when set. It should be considered "background to the informative
* text", or maybe "the reasons". Write the informative text for
* the end-user.
*/
QString details() const;
void setDetails( const QString& newDetails ); void setDetails( const QString& newDetails );
/** @brief Enable web-paste button
*
* The web-paste button can be configured at a global level,
* but each individual error dialog can be set separately.
*/
bool shouldOfferWebPaste() const; bool shouldOfferWebPaste() const;
void setShouldOfferWebPaste( bool newShouldOfferWebPaste ); void setShouldOfferWebPaste( bool newShouldOfferWebPaste );
signals: signals:
void headingChanged(); void headingChanged();
void informativeTextChanged(); void informativeTextChanged();
void detailsChanged(); void detailsChanged();
void shouldOfferWebPasteChanged(); void shouldOfferWebPasteChanged();
private: private:
@ -65,4 +80,4 @@ private:
}; // namespace Calamares }; // namespace Calamares
#endif // ERRORDIALOG_H #endif // LIBCALAMARESUI_ERRORDIALOG_H