lyx_mirror/src/insets/InsetBranch.h
Jean-Marc Lasgouttes 92e71f01ee * Inset.h (producesOutput): new mvirtual method, returning true by
default
	* InsetNote.h (producesOutput): always return false.
	* InsetBranch.h (producesOutput):  returns true if the branch is 
	selected.

	* InsetBranch.cpp (updateLabels):
	* InsetNote.cpp (updateLabels): remove

	* InsetText.cpp (updateLabels): honor producesOutput().


git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@24475 a592a061-630c-0410-9148-cb99ea01b6c8
2008-04-23 10:55:51 +00:00

120 lines
2.6 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 textString(odocstream &) const;
///
void validate(LaTeXFeatures &) const;
///
InsetBranchParams const & params() const { return params_; }
///
void setParams(InsetBranchParams const & params) { params_ = params; }
/** \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 useEmptyLayout() 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