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(Lexer & 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, Lexer & lex);
54 void setButtonLabel();
56 bool showInsetDialog(BufferView *) const;
58 int latex(Buffer const &, odocstream &,
59 OutputParams const &) const;
61 int plaintext(Buffer const &, odocstream &,
62 OutputParams const &) const;
64 int docbook(Buffer const &, odocstream &,
65 OutputParams const &) const;
67 void textString(Buffer const & buf, odocstream &) const;
69 void validate(LaTeXFeatures &) const;
71 InsetBranchParams const & params() const { return params_; }
73 void setParams(InsetBranchParams const & params) { params_ = params; }
75 /** \returns true if params_.branch is listed as 'selected' in
76 \c buffer. This handles the case of child documents.
78 bool isBranchSelected(Buffer const & buffer) const;
80 bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
84 InsetBranch(InsetBranch const &);
86 virtual void doDispatch(Cursor & cur, FuncRequest & cmd);
88 docstring getInsetName() const { return from_ascii("Branch"); }
90 friend class InsetBranchParams;
92 virtual std::auto_ptr<InsetBase> doClone() const;
94 /// used by the constructors
97 InsetBranchParams params_;
101 class InsetBranchMailer : public MailInset {
104 InsetBranchMailer(InsetBranch & inset);
106 virtual InsetBase & inset() const { return inset_; }
108 virtual std::string const & name() const { return name_; }
110 virtual std::string const inset2string(Buffer const &) const;
112 static std::string const params2string(InsetBranchParams const &);
114 static void string2params(std::string const &, InsetBranchParams &);
118 static std::string const name_;
120 InsetBranch & inset_;