Class QfChangelogContents

ClassList > QfChangelogContents

More...

• #include <qfchangelogcontents.h>

Inherits the following classes: QObject

Public Types

Type	Name
enum	Status Changelog contents status.

Public Properties

Type	Name
property QString	markdown Holds the current changelog contents formatted as markdown.
property Status	status Holds the current changelog contents status.

Public Signals

Type	Name
signal void	markdownChanged Emitted when the markdown contents has been changed.
signal void	statusChanged Emitted when the status has been changed.

Public Functions

Type	Name
	QfChangelogContents (QObject * parent=nullptr) Constructor.
QString	markdown () Returns the current changelog contents formatted as markdown. Null string if no changelog.
Q_INVOKABLE void	request ()
Status	status () Returns the current changelog contents status.

Detailed Description

Obtain the QField changelog contents from the GitHub releases API.

Public Types Documentation

enum Status

Changelog contents status.

enum QfChangelogContents::Status {
    IdleStatus,
    LoadingStatus,
    SuccessStatus,
    ErrorStatus
};

---

Public Properties Documentation

property markdown [1/2]

Holds the current changelog contents formatted as markdown.

QString QfChangelogContents::markdown;

---

property status [1/2]

Holds the current changelog contents status.

QfChangelogContents::Status QfChangelogContents::status;

---

Public Signals Documentation

signal markdownChanged

Emitted when the markdown contents has been changed.

void QfChangelogContents::markdownChanged;

---

signal statusChanged

Emitted when the status has been changed.

void QfChangelogContents::statusChanged;

---

Public Functions Documentation

function QfChangelogContents

Constructor.

explicit QfChangelogContents::QfChangelogContents (
    QObject * parent=nullptr
) 

---

function markdown [2/2]

Returns the current changelog contents formatted as markdown. Null string if no changelog.

QString QfChangelogContents::markdown () 

---

function request

Q_INVOKABLE void QfChangelogContents::request () 

Initiates a HTTP request to obtain the changelog contents.

See also: markdownChanged()

See also: statusChanged()

---

function status [2/2]

Returns the current changelog contents status.

Status QfChangelogContents::status () 

---

---

The documentation for this class was generated from the following file src/app/qfchangelogcontents.h