qtredmine Namespace Reference

QtRedmine namespace. More...

Classes
class	Authenticator
	Authenticator interface. More...
struct	CustomField
	Structure representing a Redmine custom field. More...
struct	Enumeration
	Structure representing an enumeration. More...
struct	Issue
	Structure representing an issue. More...
struct	IssueStatus
	Structure representing an issue status. More...
struct	Item
	Structure representing a Redmine item. More...
class	KeyAuthenticator
	API key authenticator. More...
class	PasswordAuthenticator
	Basic login and password authenticator. More...
struct	Project
	Structure representing a project. More...
class	RedmineClient
	Redmine connection class. More...
struct	RedmineOptions
	Redmine options. More...
struct	RedmineResource
	Redmine resource. More...
class	SimpleRedmineClient
	Simple Redmine connection class. More...
struct	TimeEntry
	Structure representing a time entry. More...
struct	Tracker
	Structure representing a tracker. More...
struct	User
	Structure representing a user. More...

Typedefs
Redmine data containers
using	Items = QVector< Item >
	Item vector.
using	CustomFields = QVector< CustomField >
	Custom field vector.
using	Enumerations = QVector< Enumeration >
	Enumeration vector.
using	Issues = QVector< Issue >
	Issue vector.
using	IssueStatuses = QVector< IssueStatus >
	Issue statuses vector.
using	Projects = QVector< Project >
	Project vector.
using	TimeEntries = QVector< TimeEntry >
	TimeEntry vector.
using	Trackers = QVector< Tracker >
	Tracker vector.
using	Users = QVector< User >
	User vector.
Callbacks
using	SuccessCb = std::function< void(bool, int, RedmineError, QStringList)>
using	EnumerationsCb = std::function< void(Enumerations, RedmineError, QStringList)>
using	IssueCb = std::function< void(Issue, RedmineError, QStringList)>
using	IssuesCb = std::function< void(Issues, RedmineError, QStringList)>
using	IssueStatusesCb = std::function< void(IssueStatuses, RedmineError, QStringList)>
using	ProjectsCb = std::function< void(Projects, RedmineError, QStringList)>
using	TimeEntriesCb = std::function< void(TimeEntries, RedmineError, QStringList)>
using	TrackersCb = std::function< void(Trackers, RedmineError, QStringList)>
using	UserCb = std::function< void(User, RedmineError, QStringList)>
using	UsersCb = std::function< void(Users, RedmineError, QStringList)>

Enumerations
enum	RedmineError {   NO_ERROR, ERR_INCOMPLETE_DATA, ERR_NETWORK, ERR_NOT_SAVED,   ERR_TIME_ENTRY_TOO_SHORT, ERR_TIMEOUT }
	Redmine error codes.

Functions
QDebug	operator<< (QDebug debug, const Issue &item)
	QDebug stream operator for issues. More...

Detailed Description

QtRedmine namespace.

Typedef Documentation

using qtredmine::EnumerationsCb = typedef std::function<void(Enumerations, RedmineError, QStringList)>

Typedef for an enumerations callback function

Parameters

Enumerations	Vector of Redmine resources
RedmineError	Redmine error code
QStringList	Errors that Redmine returned

using qtredmine::IssueCb = typedef std::function<void(Issue, RedmineError, QStringList)>

Typedef for an issue callback function

Parameters

Issue	Redmine resource
RedmineError	Redmine error code
QStringList	Errors that Redmine returned

using qtredmine::IssuesCb = typedef std::function<void(Issues, RedmineError, QStringList)>

Typedef for an issues callback function

Parameters

Issues	Vector of Redmine resources
RedmineError	Redmine error code
QStringList	Errors that Redmine returned

using qtredmine::IssueStatusesCb = typedef std::function<void(IssueStatuses, RedmineError, QStringList)>

Typedef for an issue statuses callback function

Parameters

IssueStatuses	Vector of Redmine resources
RedmineError	Redmine error code
QStringList	Errors that Redmine returned

using qtredmine::ProjectsCb = typedef std::function<void(Projects, RedmineError, QStringList)>

Typedef for a projects callback function

Parameters

Projects	Vector of Redmine resources
RedmineError	Redmine error code
QStringList	Errors that Redmine returned

using qtredmine::SuccessCb = typedef std::function<void(bool, int, RedmineError, QStringList)>

Success callback

Parameters

bool	True if successful, false otherwise
int	ID of newly created Redmine item
RedmineError	Redmine error code
QStringList	Errors that Redmine returned

using qtredmine::TimeEntriesCb = typedef std::function<void(TimeEntries, RedmineError, QStringList)>

Typedef for a time entry callback function

Parameters

TimeEntry	Vector of Redmine resources
RedmineError	Redmine error code
QStringList	Errors that Redmine returned

using qtredmine::TrackersCb = typedef std::function<void(Trackers, RedmineError, QStringList)>

Typedef for a trackers callback function

Parameters

Trackers	Vector of Redmine resources
RedmineError	Redmine error code
QStringList	Errors that Redmine returned

using qtredmine::UserCb = typedef std::function<void(User, RedmineError, QStringList)>

Typedef for a user callback function

Parameters

User	Redmine resource
RedmineError	Redmine error code
QStringList	Errors that Redmine returned

using qtredmine::UsersCb = typedef std::function<void(Users, RedmineError, QStringList)>

Typedef for a users callback function

Parameters

Users	Vector of Redmine resources
RedmineError	Redmine error code
QStringList	Errors that Redmine returned

Function Documentation

QDebug qtredmine::operator<< ( QDebug  debug, const Issue &  item  )

inline

QDebug stream operator for issues.

Parameters

debug	QDebug object
item	Issue item

Returns

QDebug object