• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdelibs-4.14.38 API Reference
  • KDE Home
  • Contact Us
 

Plasma

  • plasma
runnersyntax.cpp
Go to the documentation of this file.
1/*
2 * Copyright 2009 Aaron Seigo <aseigo@kde.org>
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU Library General Public License as
6 * published by the Free Software Foundation; either version 2, or
7 * (at your option) any later version.
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details
13 *
14 * You should have received a copy of the GNU Library General Public
15 * License along with this program; if not, write to the
16 * Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 */
19
20#include "runnersyntax.h"
21
22#include <klocalizedstring.h>
23
24namespace Plasma
25{
26
27class RunnerSyntaxPrivate
28{
29public:
30 RunnerSyntaxPrivate(const QString &s, const QString &d)
31 : description(d)
32 {
33 exampleQueries.append(s);
34 }
35
36 QStringList exampleQueries;
37 QString description;
38 QString termDescription;
39};
40
41RunnerSyntax::RunnerSyntax(const QString &exampleQuery, const QString &description)
42 : d(new RunnerSyntaxPrivate(exampleQuery, description))
43{
44}
45
46RunnerSyntax::RunnerSyntax(const RunnerSyntax &other)
47 : d(new RunnerSyntaxPrivate(*other.d))
48{
49}
50
51RunnerSyntax::~RunnerSyntax()
52{
53 delete d;
54}
55
56RunnerSyntax &RunnerSyntax::operator=(const RunnerSyntax &rhs)
57{
58 *d = *rhs.d;
59 return *this;
60}
61
62void RunnerSyntax::addExampleQuery(const QString &exampleQuery)
63{
64 d->exampleQueries.append(exampleQuery);
65}
66
67QStringList RunnerSyntax::exampleQueries() const
68{
69 return d->exampleQueries;
70}
71
72QStringList RunnerSyntax::exampleQueriesWithTermDescription() const
73{
74 QStringList queries;
75 const QString termDesc('<' + searchTermDescription() + '>');
76 foreach (QString query, d->exampleQueries) {
77 queries << query.replace(":q:", termDesc);
78 }
79
80 return queries;
81}
82
83void RunnerSyntax::setDescription(const QString &description)
84{
85 d->description = description;
86}
87
88QString RunnerSyntax::description() const
89{
90 QString description = d->description;
91 description.replace(":q:", '<' + searchTermDescription() + '>');
92 return description;
93}
94
95void RunnerSyntax::setSearchTermDescription(const QString &description)
96{
97 d->termDescription = description;
98}
99
100QString RunnerSyntax::searchTermDescription() const
101{
102 if (d->termDescription.isEmpty()) {
103 return i18n("search term");
104 }
105
106 return d->termDescription;
107}
108
109} // Plasma namespace
110
Plasma::RunnerSyntax
Definition: runnersyntax.h:41
Plasma::RunnerSyntax::description
QString description() const
Definition: runnersyntax.cpp:88
Plasma::RunnerSyntax::searchTermDescription
QString searchTermDescription() const
Definition: runnersyntax.cpp:100
Plasma
Namespace for everything in libplasma.
Definition: abstractdialogmanager.cpp:25
runnersyntax.h
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon Feb 20 2023 00:00:00 by doxygen 1.9.6 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

Plasma

Skip menu "Plasma"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdelibs-4.14.38 API Reference

Skip menu "kdelibs-4.14.38 API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal