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(LyXLex & 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         InsetBase::Code lyxCode() const { return InsetBase::BRANCH_CODE; }
  49         ///
  50         void write(Buffer const &, std::ostream &) const;
  51         ///
  52         void read(Buffer const & buf, LyXLex & lex);
  53         ///
  54         void setButtonLabel();
  55         ///
  56         bool showInsetDialog(BufferView *) const;
  57         ///
  58         int latex(Buffer const &, odocstream &, OutputParams const &) const;
  59         ///
  60         int docbook(Buffer const &, odocstream &,
  61                     OutputParams const & runparams) const;
  62         ///
  63         int plaintext(Buffer const &, odocstream &,
  64                   OutputParams const & runparams) const;
  65         ///
  66         void validate(LaTeXFeatures &) const;
  67         ///
  68         InsetBranchParams const & params() const { return params_; }
  69         ///
  70         void setParams(InsetBranchParams const & params) { params_ = params; }
  71
  72         /** \returns true if params_.branch is listed as 'selected' in
  73             \c buffer. This handles the case of child documents.
  74          */
  75         bool isBranchSelected(Buffer const & buffer) const;
  76         ///
  77         bool getStatus(LCursor &, FuncRequest const &, FuncStatus &) const;
  78
  79 protected:
  80         InsetBranch(InsetBranch const &);
  81         virtual void doDispatch(LCursor & cur, FuncRequest & cmd);
  82 private:
  83         friend class InsetBranchParams;
  84
  85         virtual std::auto_ptr<InsetBase> doClone() const;
  86
  87         /// used by the constructors
  88         void init();
  89         ///
  90         InsetBranchParams params_;
  91 };
  92
  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 } // namespace lyx
 117
 118 #endif