summaryrefslogtreecommitdiffstats
path: root/src/mimetypes/qserviceaction.cpp
blob: ba75c8ab411c7b1dd385e5a9ed517023e7a6fdcc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
#include "qserviceaction.h"

#include "qserviceaction_p.h"

// ------------------------------------------------------------------------------------------------

/*!
    \typedef QServiceActionName
    \brief ID of service actions on MIME types, e.g. "open", "edit", "share", "call", "message"

    A service action that is supposed to be applied on a specified MIME type, e.g. "view", "edit", "share-facebook". The default action ("") corrsponds to view and play.
 */

// ------------------------------------------------------------------------------------------------

/*!
    \class QServiceAction
    \brief QServiceAction describes the behaviour and information about a specific action on a MIME type.
 */

// ------------------------------------------------------------------------------------------------

/*!
    \fn QServiceAction::QServiceAction();
    \brief Initializes the attributes with default values that indicate an invalid service action.
 */
QServiceAction::QServiceAction() :
        d_ptr(new QServiceActionPrivate(QServiceActionName(), QString(), QString()))
{}

// ------------------------------------------------------------------------------------------------

/*!
    \fn QServiceAction::QServiceAction(const QServiceActionName &theName,
                                     const QString &theDisplayName,
                                     const QString &theIconUrl);
    \brief Initializes the attributes with the specified values
    \a theName The ID of the action
    \a theDisplayName The description of the action to be displayed on user interfaces
    \a theIconUrl The file name of an icon image that represents the action
 */
QServiceAction::QServiceAction(const QServiceActionName &theName,
                             const QString &theDisplayName,
                             const QString &theIconUrl) :
        d_ptr(new QServiceActionPrivate(theName, theDisplayName, theIconUrl))
{
}

// ------------------------------------------------------------------------------------------------

/*!
    \fn QServiceAction::QServiceAction(const QServiceAction &other);
    \brief Initializes the attributes with the data of another action.
    \a other The other action the data of which is copied
 */
QServiceAction::QServiceAction(const QServiceAction &other) :
        d_ptr(new QServiceActionPrivate(*other.d_ptr))
{}

// ------------------------------------------------------------------------------------------------

/*!
    \fn const QServiceAction &QServiceAction::operator=(const QServiceAction &other);
    \brief Assigns the data of another action.
    \a other The other action the data of which is assigned
 */
QServiceAction &QServiceAction::operator=(const QServiceAction &other)
{
    *d_ptr = *other.d_ptr;

    return *this;
}

// ------------------------------------------------------------------------------------------------

/*!
    \fn QServiceAction::~QServiceAction();
    \brief Frees the d_ptr.
 */
QServiceAction::~QServiceAction()
{}

// ------------------------------------------------------------------------------------------------

/*!
    \fn bool QServiceAction::operator==(const QServiceAction &other) const;
    \brief Tests for equality with another action
    \a other The other action that is to be compared with
    Returns if the other action is equal.
 */
bool QServiceAction::operator==(const QServiceAction &other) const
{
    return *d_ptr == *other.d_ptr;
}

// ------------------------------------------------------------------------------------------------

/*!
    \fn bool QServiceAction::operator!=(const QServiceAction &other) const;
    \brief Tests for non-equality with another action
    \a other The other action that is to be compared with
    Returns if the other action is not equal.
 */

// ------------------------------------------------------------------------------------------------

/*!
    \fn bool QServiceAction::isValid() const;
    \brief Checks if the object contains a valid action.
    Returns the result of the check.
 */
bool QServiceAction::isValid() const
{
    return !d_ptr->m_Name.isEmpty() &&
           !d_ptr->m_Text.isEmpty() &&
           !d_ptr->m_IconUrl.isEmpty();
}

// ------------------------------------------------------------------------------------------------

/*!
    \fn const QServiceActionName &QServiceAction::name() const;
    \brief Returns the ID of the action.
 */
const QServiceActionName &QServiceAction::name() const
{
    return d_ptr->m_Name;
}

// ------------------------------------------------------------------------------------------------

/*!
    \fn QString QServiceAction::displayName() const
    \brief Returns a description of the action to be displayed on user interfaces.

    The returned text is return in English language. For other languages it is the caller's
    responsibility to get the text translated.
 */
QString QServiceAction::displayName() const
{
    return d_ptr->m_Text;
}

// ------------------------------------------------------------------------------------------------

/*!
    \fn QString QServiceAction::iconUrl() const;
    \brief Returns the file name of an icon image that represents the action.

    Returns an empty string if no icon file has been specified during the registration of the
    action.
 */
QString QServiceAction::iconUrl() const
{
    return d_ptr->m_IconUrl;
}