X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetBranch.h;h=b608fd19cc1a7a509331095e908eeee5dfed3f5f;hb=d6f1915684328c6e3fe61c6eef8846b5cabec334;hp=37d79973716b9dc485ce921dc8795257a810bdf8;hpb=39e79d8602920eefe36e898c9f415afb979521b2;p=lyx.git diff --git a/src/insets/InsetBranch.h b/src/insets/InsetBranch.h index 37d7997371..b608fd19cc 100644 --- a/src/insets/InsetBranch.h +++ b/src/insets/InsetBranch.h @@ -13,15 +13,13 @@ #define INSETBRANCH_H #include "InsetCollapsable.h" -#include "MailInset.h" namespace lyx { -class Buffer; - class InsetBranchParams { public: + /// explicit InsetBranchParams(docstring const & b = docstring()) : branch(b) {} /// @@ -33,87 +31,91 @@ public: }; -/** The Branch inset for alternative, conditional output. +///////////////////////////////////////////////////////////////////////// +// +// InsetBranch +// +///////////////////////////////////////////////////////////////////////// -*/ -class InsetBranch : public InsetCollapsable { +/// The Branch inset for alternative, conditional output. + +class InsetBranch : public InsetCollapsable +{ public: /// - InsetBranch(BufferParams const &, InsetBranchParams const &); + InsetBranch(Buffer const &, InsetBranchParams const &); /// ~InsetBranch(); + /// - virtual docstring const editMessage() const; + static std::string params2string(InsetBranchParams const &); + /// + static void string2params(std::string const &, InsetBranchParams &); + +private: /// - InsetBase::Code lyxCode() const { return InsetBase::BRANCH_CODE; } + docstring editMessage() const; /// - void write(Buffer const &, std::ostream &) const; + InsetCode lyxCode() const { return BRANCH_CODE; } /// - void read(Buffer const & buf, Lexer & lex); + void write(std::ostream &) const; + /// + void read(Lexer & lex); /// void setButtonLabel(); /// + ColorCode backgroundColor() const; + /// bool showInsetDialog(BufferView *) const; /// - int latex(Buffer const &, odocstream &, - OutputParams const &) const; + int latex(odocstream &, OutputParams const &) const; /// - int plaintext(Buffer const &, odocstream &, - OutputParams const &) const; + int plaintext(odocstream &, OutputParams const &) const; /// - int docbook(Buffer const &, odocstream &, - OutputParams const &) const; + int docbook(odocstream &, OutputParams const &) const; /// - void textString(Buffer const & buf, odocstream &) const; + void textString(odocstream &) const; /// void validate(LaTeXFeatures &) const; /// + void addToToc(DocIterator const &); + /// InsetBranchParams const & params() const { return params_; } /// void setParams(InsetBranchParams const & params) { params_ = params; } + /// + virtual bool usePlainLayout() { return false; } /** \returns true if params_.branch is listed as 'selected' in \c buffer. This handles the case of child documents. */ - bool isBranchSelected(Buffer const & buffer) const; - /// - bool getStatus(LCursor &, FuncRequest const &, FuncStatus &) const; - -protected: - InsetBranch(InsetBranch const &); - virtual void doDispatch(LCursor & cur, FuncRequest & cmd); -private: - friend class InsetBranchParams; - - virtual std::auto_ptr doClone() const; - - /// used by the constructors - void init(); + bool isBranchSelected() const; + /*! + * Is the content of this inset part of the output document? + * + * Note that Branch insets are only considered part of the + * document when they are selected. + */ + bool producesOutput() const { return isBranchSelected(); } /// - InsetBranchParams params_; -}; - - -class InsetBranchMailer : public MailInset { -public: + bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const; /// - InsetBranchMailer(InsetBranch & inset); + bool isMacroScope() const; /// - virtual InsetBase & inset() const { return inset_; } + docstring toolTip(BufferView const & bv, int x, int y) const; /// - virtual std::string const & name() const { return name_; } + bool usePlainLayout() const { return false; } /// - virtual std::string const inset2string(Buffer const &) const; + void doDispatch(Cursor & cur, FuncRequest & cmd); /// - static std::string const params2string(InsetBranchParams const &); + docstring name() const { return from_ascii("Branch"); } /// - static void string2params(std::string const &, InsetBranchParams &); + Inset * clone() const { return new InsetBranch(*this); } -private: /// - static std::string const name_; + friend class InsetBranchParams; /// - InsetBranch & inset_; + InsetBranchParams params_; }; } // namespace lyx