src/insets/InsetBranch.h

   1 // -*- C++ -*-
   2 /**
   3  * \file InsetBranch.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Martin Vermeer
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef INSETBRANCH_H
  13 #define INSETBRANCH_H
  14
  15 #include "InsetCollapsable.h"
  16 #include "MailInset.h"
  17
  18
  19 namespace lyx {
  20
  21 class Buffer;
  22
  23 class InsetBranchParams {
  24 public:
  25         explicit InsetBranchParams(docstring const & b = docstring())
  26                 : branch(b) {}
  27         ///
  28         void write(std::ostream & os) const;
  29         ///
  30         void read(Lexer & lex);
  31         ///
  32         docstring branch;
  33 };
  34
  35
  36 /** The Branch inset for alternative, conditional output.
  37
  38 */
  39 class InsetBranch : public InsetCollapsable {
  40 public:
  41         ///
  42         InsetBranch(BufferParams const &, InsetBranchParams const &);
  43         ///
  44         ~InsetBranch();
  45         ///
  46         virtual docstring const editMessage() const;
  47         ///
  48         InsetCode lyxCode() const { return BRANCH_CODE; }
  49         ///
  50         void write(Buffer const &, std::ostream &) const;
  51         ///
  52         void read(Buffer const & buf, Lexer & lex);
  53         ///
  54         void setButtonLabel();
  55         ///
  56         virtual ColorCode backgroundColor() const;
  57         ///
  58         bool showInsetDialog(BufferView *) const;
  59         ///
  60         int latex(Buffer const &, odocstream &,
  61                   OutputParams const &) const;
  62         ///
  63         int plaintext(Buffer const &, odocstream &,
  64                       OutputParams const &) const;
  65         ///
  66         int docbook(Buffer const &, odocstream &,
  67                     OutputParams const &) const;
  68         ///
  69         void textString(Buffer const & buf, odocstream &) const;
  70         ///
  71         void validate(LaTeXFeatures &) const;
  72         ///
  73         InsetBranchParams const & params() const { return params_; }
  74         ///
  75         void setParams(InsetBranchParams const & params) { params_ = params; }
  76
  77         /** \returns true if params_.branch is listed as 'selected' in
  78             \c buffer. This handles the case of child documents.
  79          */
  80         bool isBranchSelected(Buffer const & buffer) const;
  81         ///
  82         bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
  83         ///
  84         virtual void updateLabels(Buffer const &, ParIterator const &);
  85         ///
  86         bool isMacroScope(Buffer const & buf) const;
  87         ///
  88         docstring toolTip(BufferView const & bv, int x, int y) const;
  89 protected:
  90         ///
  91         InsetBranch(InsetBranch const &);
  92         ///
  93         virtual void doDispatch(Cursor & cur, FuncRequest & cmd);
  94         ///
  95         docstring name() const { return from_ascii("Branch"); }
  96 private:
  97         friend class InsetBranchParams;
  98
  99         virtual Inset * clone() const;
 100
 101         ///
 102         InsetBranchParams params_;
 103 };
 104
 105
 106 class InsetBranchMailer : public MailInset {
 107 public:
 108         ///
 109         InsetBranchMailer(InsetBranch & inset);
 110         ///
 111         virtual Inset & inset() const { return inset_; }
 112         ///
 113         virtual std::string const & name() const { return name_; }
 114         ///
 115         virtual std::string const inset2string(Buffer const &) const;
 116         ///
 117         static std::string const params2string(InsetBranchParams const &);
 118         ///
 119         static void string2params(std::string const &, InsetBranchParams &);
 120
 121 private:
 122         ///
 123         static std::string const name_;
 124         ///
 125         InsetBranch & inset_;
 126 };
 127
 128 } // namespace lyx
 129
 130 #endif