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
  16 #include "insetcollapsable.h"
  17
  18 class BranchList;
  19
  20
  21 struct InsetBranchParams {
  22         explicit InsetBranchParams(std::string const & b = std::string())
  23                 : branch(b) {}
  24         ///
  25         void write(std::ostream & os) const;
  26         ///
  27         void read(LyXLex & lex);
  28         ///
  29         std::string branch;
  30 };
  31
  32
  33 /** The Branch inset for alternative, conditional output.
  34
  35 */
  36 class InsetBranch : public InsetCollapsable {
  37 public:
  38         ///
  39         InsetBranch(BufferParams const &, InsetBranchParams const &);
  40         ///
  41         ~InsetBranch();
  42         ///
  43         std::string const editMessage() const;
  44         ///
  45         InsetOld::Code lyxCode() const { return InsetOld::BRANCH_CODE; }
  46         ///
  47         void write(Buffer const &, std::ostream &) const;
  48         ///
  49         void read(Buffer const & buf, LyXLex & lex);
  50         ///
  51         void setButtonLabel();
  52         ///
  53         bool showInsetDialog(BufferView *) const;
  54         ///
  55         int latex(Buffer const &, std::ostream &,
  56                         OutputParams const &) const;
  57         ///
  58         int linuxdoc(Buffer const &, std::ostream &,
  59                      OutputParams const &) const;
  60         ///
  61         int docbook(Buffer const &, std::ostream &,
  62                     OutputParams const & runparams) const;
  63         ///
  64         int plaintext(Buffer const &, std::ostream &,
  65                   OutputParams const & runparams) const;
  66         ///
  67         void validate(LaTeXFeatures &) const;
  68         ///
  69         InsetBranchParams const & params() const { return params_; }
  70         ///
  71         void setParams(InsetBranchParams const & params) { params_ = params; }
  72
  73         /** \returns true if params_.branch is listed as 'selected' in
  74             \c branchlist.
  75          */
  76         bool isBranchSelected(BranchList const & branchlist) const;
  77
  78 protected:
  79         InsetBranch(InsetBranch const &);
  80         virtual void doDispatch(LCursor & cur, FuncRequest & cmd);
  81 private:
  82         friend class InsetBranchParams;
  83
  84         virtual std::auto_ptr<InsetBase> doClone() const;
  85
  86         /// used by the constructors
  87         void init();
  88         ///
  89         InsetBranchParams params_;
  90 };
  91
  92 #include "mailinset.h"
  93
  94 class InsetBranchMailer : public MailInset {
  95 public:
  96         ///
  97         InsetBranchMailer(InsetBranch & inset);
  98         ///
  99         virtual InsetBase & inset() const { return inset_; }
 100         ///
 101         virtual std::string const & name() const { return name_; }
 102         ///
 103         virtual std::string const inset2string(Buffer const &) const;
 104         ///
 105         static std::string const params2string(InsetBranchParams const &);
 106         ///
 107         static void string2params(std::string const &, InsetBranchParams &);
 108
 109 private:
 110         ///
 111         static std::string const name_;
 112         ///
 113         InsetBranch & inset_;
 114 };
 115
 116
 117
 118 #endif