File: CaretTips.h

package info (click to toggle)
caret 5.6.4~dfsg.1-3
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd, wheezy
  • size: 31,904 kB
  • ctags: 28,901
  • sloc: cpp: 378,050; python: 6,718; ansic: 5,507; makefile: 333; sh: 46
file content (76 lines) | stat: -rw-r--r-- 1,851 bytes parent folder | download | duplicates (2)
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

#ifndef __CARET_TIPS_H__
#define __CARET_TIPS_H__

/*LICENSE_START*/
/*
 *  Copyright 1995-2002 Washington University School of Medicine
 *
 *  http://brainmap.wustl.edu
 *
 *  This file is part of CARET.
 *
 *  CARET is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  CARET 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 General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with CARET; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */
/*LICENSE_END*/

#include <QString>
#include <vector>

/// a class for storing tips on how to use Caret
class CaretTips {
   public:
      // constructor
      CaretTips();
      
      // destructor
      ~CaretTips();
      
      // get the number of Caret tips
      int getNumberOfCaretTips() const;
      
      // get a tip
      void getTip(const int tipNumber,
                  QString& tipText,
                  QString& helpPage) const;
      
   protected:

      /// a tip
      class Tip {
         public:
            // constructor
            Tip(const QString& tipIn, const QString& helpPageIn = "");
            
            // destructor
            ~Tip();
            
            /// the tip
            QString tip;
            
            /// the help page
            QString helpPage;
      };
            
      /// the tips
      std::vector<Tip> tips;
      

      
};

#endif // __CARET_TIPS_H__