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(std::string const & b = std::string())
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 validate(LaTeXFeatures &) const;
68 InsetBranchParams const & params() const { return params_; }
70 void setParams(InsetBranchParams const & params) { params_ = params; }
72 /** \returns true if params_.branch is listed as 'selected' in
73 \c buffer. This handles the case of child documents.
75 bool isBranchSelected(Buffer const & buffer) const;
77 bool getStatus(LCursor &, FuncRequest const &, FuncStatus &) const;
80 InsetBranch(InsetBranch const &);
81 virtual void doDispatch(LCursor & cur, FuncRequest & cmd);
83 friend class InsetBranchParams;
85 virtual std::auto_ptr<InsetBase> doClone() const;
87 /// used by the constructors
90 InsetBranchParams params_;
94 class InsetBranchMailer : public MailInset {
97 InsetBranchMailer(InsetBranch & inset);
99 virtual InsetBase & inset() const { return inset_; }
101 virtual std::string const & name() const { return name_; }
103 virtual std::string const inset2string(Buffer const &) const;
105 static std::string const params2string(InsetBranchParams const &);
107 static void string2params(std::string const &, InsetBranchParams &);
111 static std::string const name_;
113 InsetBranch & inset_;