mirror of
https://git.lyx.org/repos/lyx.git
synced 2024-09-22 16:04:07 +00:00
75999ba650
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@23468 a592a061-630c-0410-9148-cb99ea01b6c8
140 lines
4.1 KiB
C++
140 lines
4.1 KiB
C++
// -*- C++ -*-
|
|
/**
|
|
* \file InsetInclude.h
|
|
* This file is part of LyX, the document processor.
|
|
* Licence details can be found in the file COPYING.
|
|
*
|
|
* \author Lars Gullik Bjønnes
|
|
* \author Richard Heck (conversion to InsetCommand)
|
|
*
|
|
* Full author contact details are available in file CREDITS.
|
|
*/
|
|
|
|
#ifndef INSET_INCLUDE_H
|
|
#define INSET_INCLUDE_H
|
|
|
|
#include "BiblioInfo.h"
|
|
#include "InsetCommand.h"
|
|
#include "InsetCommandParams.h"
|
|
#include "RenderButton.h"
|
|
#include "MailInset.h"
|
|
#include "Counters.h"
|
|
#include "EmbeddedFiles.h"
|
|
|
|
#include <boost/scoped_ptr.hpp>
|
|
|
|
namespace lyx {
|
|
|
|
class Buffer;
|
|
class Dimension;
|
|
class LaTeXFeatures;
|
|
class RenderMonitoredPreview;
|
|
|
|
/// for including tex/lyx files
|
|
class InsetInclude : public InsetCommand {
|
|
public:
|
|
///
|
|
InsetInclude(InsetCommandParams const &);
|
|
|
|
/// Override these InsetButton methods if Previewing
|
|
void metrics(MetricsInfo & mi, Dimension & dim) const;
|
|
///
|
|
void draw(PainterInfo & pi, int x, int y) const;
|
|
///
|
|
DisplayType display() const;
|
|
///
|
|
InsetCode lyxCode() const { return INCLUDE_CODE; }
|
|
/** Fills \c list
|
|
* \param buffer the Buffer containing this inset.
|
|
* \param list the list of labels in the child buffer.
|
|
*/
|
|
void getLabelList(std::vector<docstring> & list) const;
|
|
/** Fills \c keys
|
|
* \param buffer the Buffer containing this inset.
|
|
* \param keys the list of bibkeys in the child buffer.
|
|
* \param it not used here
|
|
*/
|
|
void fillWithBibKeys(BiblioInfo & keys, InsetIterator const & it) const;
|
|
|
|
/** Update the cache with all bibfiles in use of the child buffer
|
|
* (including bibfiles of grandchild documents).
|
|
* Does nothing if the child document is not loaded to prevent
|
|
* automatic loading of all child documents upon loading the master.
|
|
* \param buffer the Buffer containing this inset.
|
|
*/
|
|
void updateBibfilesCache();
|
|
/** Return the cache with all bibfiles in use of the child buffer
|
|
* (including bibfiles of grandchild documents).
|
|
* Return an empty vector if the child doc is not loaded.
|
|
* \param buffer the Buffer containing this inset.
|
|
*/
|
|
EmbeddedFileList const &
|
|
getBibfilesCache(Buffer const & buffer) const;
|
|
///
|
|
EDITABLE editable() const { return IS_EDITABLE; }
|
|
///
|
|
int latex(odocstream &, OutputParams const &) const;
|
|
///
|
|
int plaintext(odocstream &, OutputParams const &) const;
|
|
///
|
|
int docbook(odocstream &, OutputParams const &) const;
|
|
///
|
|
void validate(LaTeXFeatures &) const;
|
|
///
|
|
void addPreview(graphics::PreviewLoader &) const;
|
|
///
|
|
void addToToc(ParConstIterator const &) const;
|
|
///
|
|
void updateLabels(ParIterator const &);
|
|
/// child document can be embedded
|
|
void registerEmbeddedFiles(EmbeddedFileList &) const;
|
|
///
|
|
void updateEmbeddedFile(EmbeddedFile const & file);
|
|
///
|
|
static ParamInfo const & findInfo(std::string const &);
|
|
///
|
|
static std::string defaultCommand() { return "include"; };
|
|
///
|
|
static bool isCompatibleCommand(std::string const & s);
|
|
protected:
|
|
InsetInclude(InsetInclude const &);
|
|
///
|
|
void doDispatch(Cursor & cur, FuncRequest & cmd);
|
|
private:
|
|
Inset * clone() const { return new InsetInclude(*this); }
|
|
|
|
/** Slot receiving a signal that the external file has changed
|
|
* and the preview should be regenerated.
|
|
*/
|
|
void fileChanged() const;
|
|
|
|
/// set the parameters
|
|
void setParams(InsetCommandParams const & params);
|
|
/// get the text displayed on the button
|
|
docstring screenLabel() const;
|
|
/// holds the entity name that defines the file location (SGML)
|
|
docstring const include_label;
|
|
|
|
/// The pointer never changes although *preview_'s contents may.
|
|
boost::scoped_ptr<RenderMonitoredPreview> const preview_;
|
|
|
|
/// cache
|
|
mutable bool set_label_;
|
|
mutable RenderButton button_;
|
|
mutable docstring listings_label_;
|
|
};
|
|
|
|
/// return the child buffer if the file is a LyX doc and is loaded
|
|
Buffer * getChildBuffer(Buffer const & buffer, InsetCommandParams const & params);
|
|
|
|
/// return loaded Buffer or zero if the file loading did not proceed.
|
|
Buffer * loadIfNeeded(Buffer const & parent, InsetCommandParams const & params);
|
|
|
|
///
|
|
void resetParentBuffer(Buffer const * parent, InsetCommandParams const & params,
|
|
bool close_it);
|
|
|
|
} // namespace lyx
|
|
|
|
#endif // INSETINCLUDE_H
|