← Back to branch summary

~ubuntu-branches/ubuntu/hardy/codeblocks/hardy-backports

« back to all changes in this revision

Viewing changes to src/plugins/contrib/help_plugin/help_common.h

  • Committer: Bazaar Package Importer
  • Author(s): Michael Casadevall
  • Date: 2008-07-17 04:39:23 UTC
  • Revision ID: james.westby@ubuntu.com-20080717043923-gmsy5cwkdjswghkm
Tags: upstream-8.02
Import upstream version 8.02

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/plugins/contrib/help_plugin/help_common.h
 
1
#ifndef HELP_COMMON_H
 
2
#define HELP_COMMON_H
 
3
 
 
4
#include <wx/string.h>
 
5
#include <vector>
 
6
#include <utility>
 
7
 
 
8
using std::vector;
 
9
using std::pair;
 
10
 
 
11
class HelpCommon
 
12
{
 
13
  public:
 
14
 
 
15
    // Patch by Yorgos Pagles: Add keyword case choises
 
16
    enum StringCase {Preserve=0,UpperCase,LowerCase};
 
17
 
 
18
    struct HelpFileAttrib
 
19
    {
 
20
      wxString name;
 
21
      bool isExecutable;
 
22
      bool openEmbeddedViewer;
 
23
      bool readFromIni;
 
24
      // Patch by Yorgos Pagles: Add keyword case and default
 
25
      // keyword substitution attributes in Help file attributes
 
26
      StringCase keywordCase;
 
27
      wxString defaultKeyword;
 
28
 
 
29
      HelpFileAttrib() : isExecutable(false), openEmbeddedViewer(false), readFromIni(false) { }
 
30
    };
 
31
 
 
32
    typedef pair<wxString, HelpFileAttrib> wxStringPair;
 
33
    typedef vector<wxStringPair> HelpFilesVector;
 
34
 
 
35
  private:
 
36
    static int m_DefaultHelpIndex;
 
37
    static int m_NumReadFromIni;
 
38
 
 
39
  public:
 
40
    static int getDefaultHelpIndex();
 
41
    static void setDefaultHelpIndex(int index);
 
42
    static int getNumReadFromIni();
 
43
    static void setNumReadFromIni(int num);
 
44
    static void LoadHelpFilesVector(HelpFilesVector &vect);
 
45
    static void SaveHelpFilesVector(HelpFilesVector &vect);
 
46
 
 
47
        private:
 
48
          // Block instantiation
 
49
    HelpCommon();
 
50
    ~HelpCommon();
 
51
};
 
52
 
 
53
// Inline member functions
 
54
 
 
55
inline int HelpCommon::getDefaultHelpIndex()
 
56
{
 
57
        return m_DefaultHelpIndex;
 
58
}
 
59
 
 
60
inline void HelpCommon::setDefaultHelpIndex(int index)
 
61
{
 
62
        m_DefaultHelpIndex = index;
 
63
}
 
64
 
 
65
inline int HelpCommon::getNumReadFromIni()
 
66
{
 
67
        return m_NumReadFromIni;
 
68
}
 
69
 
 
70
inline void HelpCommon::setNumReadFromIni(int num)
 
71
{
 
72
        m_NumReadFromIni = num;
 
73
}
 
74
 
 
75
inline bool operator == (const HelpCommon::wxStringPair &str_pair, const wxString &value)
 
76
{
 
77
        return str_pair.first.CmpNoCase(value) == 0;
 
78
}
 
79
 
 
80
#endif // HELP_COMMON_H