QT_END_NAMESPACE
class SendCoinsRecipient;
+/** Static utility functions used by the Bitcoin Qt UI.
+ */
class GUIUtil
{
public:
static void setupAddressWidget(QLineEdit *widget, QWidget *parent);
static void setupAmountWidget(QLineEdit *widget, QWidget *parent);
- // Parse "bitcoin:" URL into recipient object, return true on succesful parsing
- // See Bitcoin URL definition discussion here: https://bitcointalk.org/index.php?topic=33490.0
- static bool parseBitcoinURL(const QUrl *url, SendCoinsRecipient *out);
- static bool parseBitcoinURL(QString url, SendCoinsRecipient *out);
+ // Parse "bitcoin:" URI into recipient object, return true on succesful parsing
+ // See Bitcoin URI definition discussion here: https://bitcointalk.org/index.php?topic=33490.0
+ static bool parseBitcoinURI(const QUrl *, SendCoinsRecipient *out);
+ static bool parseBitcoinURI(QString uri, SendCoinsRecipient *out);
/** Get save file name, mimics QFileDialog::getSaveFileName, except that it appends a default suffix
when no suffix is provided by the user.
#endif
QT_END_NAMESPACE
-// Cross-platform desktop notification client
+/** Cross-platform desktop notification client. */
class Notificator: public QObject
{
Q_OBJECT
public:
- // Create a new notificator
- // Ownership of trayIcon is not transferred to this object
+ /** Create a new notificator.
+ @note Ownership of trayIcon is not transferred to this object.
+ */
Notificator(const QString &programName=QString(), QSystemTrayIcon *trayIcon=0, QWidget *parent=0);
~Notificator();
// Message class
enum Class
{
- Information,
- Warning,
- Critical,
+ Information, /**< Informational message */
+ Warning, /**< Notify user of potential problem */
+ Critical /**< An error occured */
};
public slots:
- /* Show notification message.
- *
- * cls: general message class
- * title: title shown with message
- * text: message content
- * icon: optional icon to show with message
- * millisTimeout: notification timeout in milliseconds (default 10 seconds)
+ /** Show notification message.
+ @param[in] cls general message class
+ @param[in] title title shown with message
+ @param[in] text message content
+ @param[in] icon optional icon to show with message
+ @param[in] millisTimeout notification timeout in milliseconds (defaults to 10 seconds)
+ @note Platform implementations are free to ignore any of the provided fields except for \a text.
*/
void notify(Class cls, const QString &title, const QString &text,
const QIcon &icon = QIcon(), int millisTimeout = 10000);
private:
QWidget *parent;
enum Mode {
- None,
- Freedesktop, // Use DBus org.freedesktop.Notifications
- QSystemTray, // Use QSystemTray::showMessage
- Growl12, // Use the Growl 1.2 notification system (Mac only)
- Growl13 // Use the Growl 1.3 notification system (Mac only)
+ None, /**< Ignore informational notifications, and show a modal pop-up dialog for Critical notifications. */
+ Freedesktop, /**< Use DBus org.freedesktop.Notifications */
+ QSystemTray, /**< Use QSystemTray::showMessage */
- Growl /**< Use the Growl notification system (Mac only) */
++ Growl12, /**< Use the Growl 1.2 notification system (Mac only) */
++ Growl13 /**< Use the Growl 1.3 notification system (Mac only) */
};
QString programName;
Mode mode;
class QUrl;
QT_END_NAMESPACE
+/** Dialog for sending bitcoins */
class SendCoinsDialog : public QDialog
{
Q_OBJECT
void setModel(WalletModel *model);
- // Qt messes up the tab chain by default in some cases (issue http://bugreports.qt.nokia.com/browse/QTBUG-10907)
- // Hence we have to set it up manually
+ /** Set up the tab chain manually, as Qt messes up the tab chain by default in some cases (issue http://bugreports.qt.nokia.com/browse/QTBUG-10907).
+ */
QWidget *setupTabChain(QWidget *prev);
void pasteEntry(const SendCoinsRecipient &rv);
- void handleURL(const QUrl *url);
- void handleURL(const QString &url);
+ void handleURI(const QUrl *uri);
+ void handleURI(const QString &uri);
public slots:
void clear();