LoggingInterface.hh 4.72 KB
Newer Older
1
/*===========================================================================*\
Jan Möbius's avatar
Jan Möbius committed
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
*                                                                            *
*                              OpenFlipper                                   *
*      Copyright (C) 2001-2010 by Computer Graphics Group, RWTH Aachen       *
*                           www.openflipper.org                              *
*                                                                            *
*--------------------------------------------------------------------------- *
*  This file is part of OpenFlipper.                                         *
*                                                                            *
*  OpenFlipper is free software: you can redistribute it and/or modify       *
*  it under the terms of the GNU Lesser General Public License as            *
*  published by the Free Software Foundation, either version 3 of            *
*  the License, or (at your option) any later version with the               *
*  following exceptions:                                                     *
*                                                                            *
*  If other files instantiate templates or use macros                        *
*  or inline functions from this file, or you compile this file and          *
*  link it with other files to produce an executable, this file does         *
*  not by itself cause the resulting executable to be covered by the         *
*  GNU Lesser General Public License. This exception does not however        *
*  invalidate any other reasons why the executable file might be             *
*  covered by the GNU Lesser General Public License.                         *
*                                                                            *
*  OpenFlipper is distributed in the hope that it will be useful,            *
*  but WITHOUT ANY WARRANTY; without even the implied warranty of            *
*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the             *
*  GNU Lesser General Public License for more details.                       *
*                                                                            *
*  You should have received a copy of the GNU LesserGeneral Public           *
*  License along with OpenFlipper. If not,                                   *
*  see <http://www.gnu.org/licenses/>.                                       *
*                                                                            *
33
34
35
\*===========================================================================*/

/*===========================================================================*\
Jan Möbius's avatar
Jan Möbius committed
36
37
38
39
40
*                                                                            *
*   $Revision$                                                       *
*   $LastChangedBy$                                                *
*   $Date$                     *
*                                                                            *
41
\*===========================================================================*/
Jan Möbius's avatar
 
Jan Möbius committed
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65




//
// C++ Interface: LoggingInterface
//
// Description: 
//
//
// Author: Jan Moebius <jan_moebius@web.de>, (C) 2007
//

#ifndef LOGGINGINTERFACE_HH 
#define LOGGINGINTERFACE_HH 

/// Log types for Message Window 
enum Logtype { LOGOUT, LOGINFO , LOGWARN , LOGERR };

/** \brief Interface for all Plugins which do logging to the logging window of the framework
  * 
  * By emitting the given signals you can log information to the main logger window of the core.
  * To simplify debugging the core will prepend the plugin name to every log message. You dont
  * have to do this yourself!\n
66
67
68
  * The log message will either be black or will be colored depending on the Logtype you specified.
  *
  * Read our tutorials \ref ex2 and \ref ex3 for an example of how to use logging output.
Jan Möbius's avatar
 
Jan Möbius committed
69
70
71
72
73
74
75
76
 */ 
class LoggingInterface {
  
   signals :
      /** Send a log message to the mainwindow of the widget \n
       * @param _type Message type (LOGINFO,LOGOUT,LOGWARN,LOGERR)
       * @param _message Message to be displayed
       */
Dirk Wilden's avatar
Dirk Wilden committed
77
      virtual void log(Logtype /*_type*/, QString /*_message*/) = 0;
Jan Möbius's avatar
 
Jan Möbius committed
78
79
80
81
82
      
      /** Send a log message to the mainwindow of the widget \n
       * defaults to LOGOUT message type
       * @param _message Message to be displayed
       */
Dirk Wilden's avatar
Dirk Wilden committed
83
      virtual void log(QString /*_message*/) = 0;
Jan Möbius's avatar
 
Jan Möbius committed
84
85
86
87
88
      
   private slots:
     
      /** Through this slot you can receive all logging information emitted by OpenFlipper
       * or one of its plugins */
Dirk Wilden's avatar
Dirk Wilden committed
89
      virtual void logOutput( Logtype /*_type*/ , QString /*_message*/ ) {};
90
91
92
93
94

   public:

      /// Destructor
      virtual ~LoggingInterface() {};
Jan Möbius's avatar
 
Jan Möbius committed
95
96
97
98
99
};

Q_DECLARE_INTERFACE(LoggingInterface,"OpenFlipper.LoggingInterface/1.0")
      
#endif // LOGGINGINTERFACE_HH