4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Martin Vermeer
9 * Full author contact details are available in file CREDITS.
15 #include "insetcollapsable.h"
16 #include "mailinset.h"
23 class InsetBranchParams {
25 explicit InsetBranchParams(docstring const & b = docstring())
28 void write(std::ostream & os) const;
30 void read(LyXLex & lex);
36 /** The Branch inset for alternative, conditional output.
39 class InsetBranch : public InsetCollapsable {
42 InsetBranch(BufferParams const &, InsetBranchParams const &);
46 virtual docstring const editMessage() const;
48 InsetBase::Code lyxCode() const { return InsetBase::BRANCH_CODE; }
50 void write(Buffer const &, std::ostream &) const;
52 void read(Buffer const & buf, LyXLex & lex);
54 void setButtonLabel();
56 bool showInsetDialog(BufferView *) const;
58 int latex(Buffer const &, odocstream &, OutputParams const &) const;
60 int docbook(Buffer const &, odocstream &,
61 OutputParams const & runparams) const;
63 int plaintext(Buffer const &, odocstream &,
64 OutputParams const & runparams) const;
66 void textString(Buffer const & buf, odocstream &) const;
68 void validate(LaTeXFeatures &) const;
70 InsetBranchParams const & params() const { return params_; }
72 void setParams(InsetBranchParams const & params) { params_ = params; }
74 /** \returns true if params_.branch is listed as 'selected' in
75 \c buffer. This handles the case of child documents.
77 bool isBranchSelected(Buffer const & buffer) const;
79 bool getStatus(LCursor &, FuncRequest const &, FuncStatus &) const;
82 InsetBranch(InsetBranch const &);
83 virtual void doDispatch(LCursor & cur, FuncRequest & cmd);
85 friend class InsetBranchParams;
87 virtual std::auto_ptr<InsetBase> doClone() const;
89 /// used by the constructors
92 InsetBranchParams params_;
96 class InsetBranchMailer : public MailInset {
99 InsetBranchMailer(InsetBranch & inset);
101 virtual InsetBase & inset() const { return inset_; }
103 virtual std::string const & name() const { return name_; }
105 virtual std::string const inset2string(Buffer const &) const;
107 static std::string const params2string(InsetBranchParams const &);
109 static void string2params(std::string const &, InsetBranchParams &);
113 static std::string const name_;
115 InsetBranch & inset_;