File: MessagePrinter.h

package info (click to toggle)
kodi 2%3A20.1%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 143,820 kB
  • sloc: cpp: 664,925; xml: 68,398; ansic: 37,223; python: 6,903; sh: 4,209; javascript: 2,325; makefile: 1,754; perl: 969; java: 513; cs: 390; objc: 340
file content (43 lines) | stat: -rw-r--r-- 1,142 bytes parent folder | download | duplicates (4)
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
/*
 *  Copyright (C) 2005-2018 Team Kodi
 *  This file is part of Kodi - https://kodi.tv
 *
 *  SPDX-License-Identifier: GPL-2.0-or-later
 *  See LICENSES/README.md for more information.
 */

#pragma once

#include <string>
#include <utility>
#include <vector>

class CMessagePrinter
{
public:

  /*! \brief Display a normal message to the user during startup
  *
  * \param[in] message  message to display
  */
  static void DisplayMessage(const std::string& message);

  /*! \brief Display a warning message to the user during startup
  *
  * \param[in] warning   warning to display
  */
  static void DisplayWarning(const std::string& warning);

  /*! \brief Display an error message to the user during startup
  *
  * \param[in] error  error to display
  */
  static void DisplayError(const std::string& error);

  /*! \brief Display the help message with command line options available
  *
  * \param[in] help  List of commands and explanations,
                     help.push_back(std::make_pair("--help", "this displays the help))
  */
  static void DisplayHelpMessage(const std::vector<std::pair<std::string, std::string>>& help);
};