File indexing completed on 2024-04-14 03:54:32

 /*
     SPDX-FileCopyrightText: 2009 Aaron Seigo <aseigo@kde.org>
     SPDX-FileCopyrightText: 2023 Alexander Lohnau <alexander.lohnau@gmx.de>
 
     SPDX-License-Identifier: LGPL-2.0-or-later
 */
 
 #ifndef KRUNNER_RUNNERSYNTAX_H
 #define KRUNNER_RUNNERSYNTAX_H
 
 #include <QStringList>
 #include <memory>
 
 #include "krunner_export.h"
 
 namespace KRunner
 {
 class RunnerSyntaxPrivate;
 /**
  * @class RunnerSyntax runnersyntax.h <KRunner/RunnerSyntax>
  *
  * Represents a query prototype that the runner accepts. These can be
  * created and registered with AbstractRunner::addSyntax to
  * allow applications to show to the user what the runner is currently capable of doing.
  *
  * Lets say the runner has a trigger word and then the user can type anything after that. In that case you could use
  * ":q:" as a placeholder, which will get expanded to i18n("search term") and be put in brackets.
  * @code
    KRunner::RunnerSyntax syntax(QStringLiteral("sometriggerword :q:"), i18n("Description for this syntax"));
    addSyntax(syntax);
  * @endcode
  *
  * But if the query the user has to enter is sth. specific like a program,
  * url or file you should use a custom placeholder to make it easier to understand.
  * @code
    KRunner::RunnerSyntax syntax(QStringLiteral("sometriggereword <%1>").arg(i18n("program name"))), i18n("Description for this syntax"));
    addSyntax(syntax);
  * @endcode
  */
 class KRUNNER_EXPORT RunnerSyntax
 {
 public:
     /**
      * Constructs a RunnerSyntax with one example query
      *
      * @param exampleQuery See the class description for examples and placeholder conventions.
      * @param description A description of what the described syntax does from the user's point of view.
      */
     explicit inline RunnerSyntax(const QString &exampleQuery, const QString &description)
         : RunnerSyntax(QStringList(exampleQuery), description)
     {
     }
 
     /**
      * Constructs a RunnerSyntax with multiple example queries
      *
      * @param exampleQueries See the class description for examples and placeholder conventions.
      * @param description A description of what the described syntax does from the user's point of view.
      * This description should be true for all example queries. In case they differ, consider using multiple syntaxes.
      *
      * @since 5.106
      */
     explicit RunnerSyntax(const QStringList &exampleQueries, const QString &description);
 
     ~RunnerSyntax();
 
     /**
      * @return the example queries associated with this Syntax object
      */
     QStringList exampleQueries() const;
 
     /**
      * @return the user visible description of what the syntax does
      */
     QString description() const;
 
     /// @internal
     RunnerSyntax &operator=(const RunnerSyntax &rhs);
     /// @internal
     explicit RunnerSyntax(const RunnerSyntax &other);
 
 private:
     std::unique_ptr<RunnerSyntaxPrivate> d;
 };
 
 } // namespace KRunner
 
 #endif // multiple inclusion guard