binaries/src/clustalw/src/Help.h

   1 /**
   2  * Author: Andreas Wilm
   3  *
   4  * Copyright (c) 2007 Des Higgins, Julie Thompson and Toby Gibson.
   5  */
   6 /**
   7  * This is the clustalw help class which replaces the old help file
   8  *
   9  */
  10 #ifndef HELP_H
  11 #define HELP_H
  12
  13
  14
  15 #include <string>
  16 #include <iostream>
  17 using namespace std;
  18
  19 typedef struct {
  20     string marker;
  21     string title;
  22     string content;
  23 } section;
  24
  25 class Help {
  26
  27 public:
  28     /* Functions */
  29     Help();
  30     ~Help();
  31     string GetSection(string marker);
  32     string GetSection(char marker);
  33     string GetSectionTitle(string marker);
  34     string GetSectionTitle(char marker);
  35     vector<string> ListSectionMarkers();
  36     /* Attributes */
  37
  38 private:
  39     /* Functions */
  40     /* Attributes */
  41     vector<section> sections;
  42 };
  43
  44 #endif