mirror of
https://git.lyx.org/repos/lyx.git
synced 2024-09-22 16:04:07 +00:00
b83564d82c
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@27378 a592a061-630c-0410-9148-cb99ea01b6c8
124 lines
2.7 KiB
C++
124 lines
2.7 KiB
C++
// -*- C++ -*-
|
|
/**
|
|
* \file InsetBranch.h
|
|
* This file is part of LyX, the document processor.
|
|
* Licence details can be found in the file COPYING.
|
|
*
|
|
* \author Martin Vermeer
|
|
*
|
|
* Full author contact details are available in file CREDITS.
|
|
*/
|
|
|
|
#ifndef INSETBRANCH_H
|
|
#define INSETBRANCH_H
|
|
|
|
#include "InsetCollapsable.h"
|
|
|
|
|
|
namespace lyx {
|
|
|
|
class InsetBranchParams {
|
|
public:
|
|
///
|
|
explicit InsetBranchParams(docstring const & b = docstring())
|
|
: branch(b) {}
|
|
///
|
|
void write(std::ostream & os) const;
|
|
///
|
|
void read(Lexer & lex);
|
|
///
|
|
docstring branch;
|
|
};
|
|
|
|
|
|
/////////////////////////////////////////////////////////////////////////
|
|
//
|
|
// InsetBranch
|
|
//
|
|
/////////////////////////////////////////////////////////////////////////
|
|
|
|
/// The Branch inset for alternative, conditional output.
|
|
|
|
class InsetBranch : public InsetCollapsable
|
|
{
|
|
public:
|
|
///
|
|
InsetBranch(Buffer const &, InsetBranchParams const &);
|
|
///
|
|
~InsetBranch();
|
|
|
|
///
|
|
static std::string params2string(InsetBranchParams const &);
|
|
///
|
|
static void string2params(std::string const &, InsetBranchParams &);
|
|
|
|
private:
|
|
///
|
|
docstring editMessage() const;
|
|
///
|
|
InsetCode lyxCode() const { return BRANCH_CODE; }
|
|
///
|
|
void write(std::ostream &) const;
|
|
///
|
|
void read(Lexer & lex);
|
|
///
|
|
void setButtonLabel();
|
|
///
|
|
ColorCode backgroundColor() const;
|
|
///
|
|
bool showInsetDialog(BufferView *) const;
|
|
///
|
|
int latex(odocstream &, OutputParams const &) const;
|
|
///
|
|
int plaintext(odocstream &, OutputParams const &) const;
|
|
///
|
|
int docbook(odocstream &, OutputParams const &) const;
|
|
///
|
|
void tocString(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() 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(); }
|
|
///
|
|
bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
|
|
///
|
|
bool isMacroScope() const;
|
|
///
|
|
docstring toolTip(BufferView const & bv, int x, int y) const;
|
|
///
|
|
bool usePlainLayout() const { return false; }
|
|
///
|
|
void doDispatch(Cursor & cur, FuncRequest & cmd);
|
|
///
|
|
docstring name() const { return from_ascii("Branch"); }
|
|
///
|
|
Inset * clone() const { return new InsetBranch(*this); }
|
|
|
|
///
|
|
friend class InsetBranchParams;
|
|
///
|
|
InsetBranchParams params_;
|
|
};
|
|
|
|
} // namespace lyx
|
|
|
|
#endif
|