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         /// Copy constructor
  41         InsetBranch(InsetBranch const &);
  42         ///
  43         ~InsetBranch();
  44         ///
  45         virtual std::auto_ptr<InsetBase> clone() const;
  46         ///
  47         std::string const editMessage() const;
  48         ///
  49         InsetOld::Code lyxCode() const { return InsetOld::BRANCH_CODE; }
  50         ///
  51         void write(Buffer const &, std::ostream &) const;
  52         ///
  53         void read(Buffer const & buf, LyXLex & lex);
  54         ///
  55         void setButtonLabel();
  56         ///
  57         bool showInsetDialog(BufferView *) const;
  58         ///
  59         int latex(Buffer const &, std::ostream &,
  60                         OutputParams const &) const;
  61         ///
  62         int linuxdoc(Buffer const &, std::ostream &,
  63                      OutputParams const &) const;
  64         ///
  65         int docbook(Buffer const &, std::ostream &,
  66                     OutputParams const & runparams) const;
  67         ///
  68         int plaintext(Buffer const &, std::ostream &,
  69                   OutputParams const & runparams) 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 branchlist.
  79          */
  80         bool isBranchSelected(BranchList const & branchlist) const;
  81
  82 protected:
  83         ///
  84         virtual
  85         DispatchResult
  86         priv_dispatch(FuncRequest const &, idx_type &, pos_type &);
  87 private:
  88         friend class InsetBranchParams;
  89
  90         /// used by the constructors
  91         void init();
  92         ///
  93         InsetBranchParams params_;
  94 };
  95
  96 #include "mailinset.h"
  97
  98 class InsetBranchMailer : public MailInset {
  99 public:
 100         ///
 101         InsetBranchMailer(InsetBranch & inset);
 102         ///
 103         virtual InsetBase & inset() const { return inset_; }
 104         ///
 105         virtual std::string const & name() const { return name_; }
 106         ///
 107         virtual std::string const inset2string(Buffer const &) const;
 108         ///
 109         static std::string const params2string(InsetBranchParams const &);
 110         ///
 111         static void string2params(std::string const &, InsetBranchParams &);
 112
 113 private:
 114         ///
 115         static std::string const name_;
 116         ///
 117         InsetBranch & inset_;
 118 };
 119
 120
 121
 122 #endif