1999-09-27 18:44:28 +00:00
|
|
|
|
// -*- C++ -*-
|
2002-09-09 17:32:53 +00:00
|
|
|
|
/**
|
2007-04-25 01:24:38 +00:00
|
|
|
|
* \file InsetInclude.h
|
2002-09-09 17:32:53 +00:00
|
|
|
|
* This file is part of LyX, the document processor.
|
|
|
|
|
* Licence details can be found in the file COPYING.
|
1999-09-27 18:44:28 +00:00
|
|
|
|
*
|
2002-09-25 14:26:13 +00:00
|
|
|
|
* \author Lars Gullik Bj<EFBFBD>nnes
|
2007-10-23 18:51:04 +00:00
|
|
|
|
* \author Richard Heck (conversion to InsetCommand)
|
2002-09-25 14:26:13 +00:00
|
|
|
|
*
|
2003-08-23 00:17:00 +00:00
|
|
|
|
* Full author contact details are available in file CREDITS.
|
2002-09-09 17:32:53 +00:00
|
|
|
|
*/
|
1999-09-27 18:44:28 +00:00
|
|
|
|
|
1999-10-02 16:21:10 +00:00
|
|
|
|
#ifndef INSET_INCLUDE_H
|
|
|
|
|
#define INSET_INCLUDE_H
|
1999-09-27 18:44:28 +00:00
|
|
|
|
|
2007-10-23 15:02:15 +00:00
|
|
|
|
#include "InsetCommand.h"
|
2008-03-27 22:26:24 +00:00
|
|
|
|
|
|
|
|
|
#include "BiblioInfo.h"
|
|
|
|
|
#include "Counters.h"
|
2007-04-25 01:24:38 +00:00
|
|
|
|
#include "InsetCommandParams.h"
|
|
|
|
|
#include "RenderButton.h"
|
2008-04-19 15:52:35 +00:00
|
|
|
|
|
|
|
|
|
#include "support/FileNameList.h"
|
2006-10-21 00:16:43 +00:00
|
|
|
|
|
2002-08-01 17:28:59 +00:00
|
|
|
|
#include <boost/scoped_ptr.hpp>
|
2003-06-12 08:52:36 +00:00
|
|
|
|
|
2006-10-21 00:16:43 +00:00
|
|
|
|
namespace lyx {
|
|
|
|
|
|
2000-07-27 08:55:59 +00:00
|
|
|
|
class Buffer;
|
2003-09-07 01:45:40 +00:00
|
|
|
|
class Dimension;
|
2008-03-07 13:33:33 +00:00
|
|
|
|
class InsetLabel;
|
2005-01-19 15:03:31 +00:00
|
|
|
|
class LaTeXFeatures;
|
2003-10-10 21:08:55 +00:00
|
|
|
|
class RenderMonitoredPreview;
|
1999-09-27 18:44:28 +00:00
|
|
|
|
|
2002-09-09 17:32:53 +00:00
|
|
|
|
/// for including tex/lyx files
|
2007-10-23 15:02:15 +00:00
|
|
|
|
class InsetInclude : public InsetCommand {
|
1999-09-27 18:44:28 +00:00
|
|
|
|
public:
|
2001-03-14 10:57:39 +00:00
|
|
|
|
///
|
2003-09-19 10:16:33 +00:00
|
|
|
|
InsetInclude(InsetCommandParams const &);
|
2008-03-06 20:58:59 +00:00
|
|
|
|
~InsetInclude();
|
2001-03-14 10:57:39 +00:00
|
|
|
|
|
2008-03-07 13:33:33 +00:00
|
|
|
|
void setBuffer(Buffer & buffer);
|
2008-03-11 09:04:09 +00:00
|
|
|
|
bool isLabeled() const { return true; }
|
2008-03-07 13:33:33 +00:00
|
|
|
|
|
2002-08-01 17:28:59 +00:00
|
|
|
|
/// Override these InsetButton methods if Previewing
|
2007-09-21 20:39:47 +00:00
|
|
|
|
void metrics(MetricsInfo & mi, Dimension & dim) const;
|
2002-08-01 17:28:59 +00:00
|
|
|
|
///
|
2003-05-30 06:48:24 +00:00
|
|
|
|
void draw(PainterInfo & pi, int x, int y) const;
|
2003-10-21 13:04:14 +00:00
|
|
|
|
///
|
2008-03-05 00:21:05 +00:00
|
|
|
|
DisplayType display() const;
|
2003-05-26 09:13:55 +00:00
|
|
|
|
///
|
2007-10-13 09:04:52 +00:00
|
|
|
|
InsetCode lyxCode() const { return INCLUDE_CODE; }
|
2003-09-18 20:18:39 +00:00
|
|
|
|
/** Fills \c keys
|
|
|
|
|
* \param buffer the Buffer containing this inset.
|
|
|
|
|
* \param keys the list of bibkeys in the child buffer.
|
2007-08-16 01:59:20 +00:00
|
|
|
|
* \param it not used here
|
2003-09-18 20:18:39 +00:00
|
|
|
|
*/
|
2008-02-27 20:43:16 +00:00
|
|
|
|
void fillWithBibKeys(BiblioInfo & keys, InsetIterator const & it) const;
|
2007-08-16 01:59:20 +00:00
|
|
|
|
|
2006-04-15 11:46:17 +00:00
|
|
|
|
/** Update the cache with all bibfiles in use of the child buffer
|
|
|
|
|
* (including bibfiles of grandchild documents).
|
2006-05-19 07:21:43 +00:00
|
|
|
|
* Does nothing if the child document is not loaded to prevent
|
|
|
|
|
* automatic loading of all child documents upon loading the master.
|
2006-04-15 11:46:17 +00:00
|
|
|
|
* \param buffer the Buffer containing this inset.
|
|
|
|
|
*/
|
2008-02-27 20:43:16 +00:00
|
|
|
|
void updateBibfilesCache();
|
2006-04-15 11:46:17 +00:00
|
|
|
|
/** Return the cache with all bibfiles in use of the child buffer
|
|
|
|
|
* (including bibfiles of grandchild documents).
|
2006-05-19 07:21:43 +00:00
|
|
|
|
* Return an empty vector if the child doc is not loaded.
|
2006-04-15 11:46:17 +00:00
|
|
|
|
* \param buffer the Buffer containing this inset.
|
|
|
|
|
*/
|
2008-04-19 15:52:35 +00:00
|
|
|
|
support::FileNameList const &
|
2007-10-23 15:02:15 +00:00
|
|
|
|
getBibfilesCache(Buffer const & buffer) const;
|
1999-09-27 18:44:28 +00:00
|
|
|
|
///
|
2003-09-19 10:16:33 +00:00
|
|
|
|
EDITABLE editable() const { return IS_EDITABLE; }
|
2001-07-20 14:18:48 +00:00
|
|
|
|
///
|
2008-02-27 20:43:16 +00:00
|
|
|
|
int latex(odocstream &, OutputParams const &) const;
|
1999-09-27 18:44:28 +00:00
|
|
|
|
///
|
2008-02-27 20:43:16 +00:00
|
|
|
|
int plaintext(odocstream &, OutputParams const &) const;
|
2000-12-28 16:22:28 +00:00
|
|
|
|
///
|
2008-02-27 20:43:16 +00:00
|
|
|
|
int docbook(odocstream &, OutputParams const &) const;
|
2000-07-01 12:54:45 +00:00
|
|
|
|
///
|
2001-06-28 10:25:20 +00:00
|
|
|
|
void validate(LaTeXFeatures &) const;
|
2002-08-01 17:28:59 +00:00
|
|
|
|
///
|
2006-10-21 00:16:43 +00:00
|
|
|
|
void addPreview(graphics::PreviewLoader &) const;
|
2005-04-22 08:57:22 +00:00
|
|
|
|
///
|
2008-02-27 20:43:16 +00:00
|
|
|
|
void addToToc(ParConstIterator const &) const;
|
2006-11-13 16:53:49 +00:00
|
|
|
|
///
|
2008-02-27 20:43:16 +00:00
|
|
|
|
void updateLabels(ParIterator const &);
|
2008-01-08 16:35:43 +00:00
|
|
|
|
///
|
2008-02-23 22:01:02 +00:00
|
|
|
|
static ParamInfo const & findInfo(std::string const &);
|
2007-10-25 04:13:56 +00:00
|
|
|
|
///
|
2008-03-27 22:26:24 +00:00
|
|
|
|
static std::string defaultCommand() { return "include"; }
|
2007-10-25 04:13:56 +00:00
|
|
|
|
///
|
|
|
|
|
static bool isCompatibleCommand(std::string const & s);
|
2008-04-27 15:49:15 +00:00
|
|
|
|
///
|
|
|
|
|
docstring contextMenu(BufferView const & bv, int x, int y) const;
|
2003-10-17 18:01:15 +00:00
|
|
|
|
protected:
|
2004-11-23 23:04:52 +00:00
|
|
|
|
InsetInclude(InsetInclude const &);
|
2003-10-17 18:01:15 +00:00
|
|
|
|
///
|
2008-02-27 20:43:16 +00:00
|
|
|
|
void doDispatch(Cursor & cur, FuncRequest & cmd);
|
2008-04-27 18:03:21 +00:00
|
|
|
|
///
|
|
|
|
|
bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
|
1999-09-27 18:44:28 +00:00
|
|
|
|
private:
|
2008-03-05 00:21:05 +00:00
|
|
|
|
Inset * clone() const { return new InsetInclude(*this); }
|
2004-11-23 23:04:52 +00:00
|
|
|
|
|
2003-10-10 21:08:55 +00:00
|
|
|
|
/** Slot receiving a signal that the external file has changed
|
|
|
|
|
* and the preview should be regenerated.
|
|
|
|
|
*/
|
|
|
|
|
void fileChanged() const;
|
|
|
|
|
|
2008-04-27 18:03:21 +00:00
|
|
|
|
/// launch external application
|
|
|
|
|
void editIncluded(std::string const & file);
|
2003-09-19 10:16:33 +00:00
|
|
|
|
/// set the parameters
|
2008-02-27 20:43:16 +00:00
|
|
|
|
void setParams(InsetCommandParams const & params);
|
2003-09-19 10:16:33 +00:00
|
|
|
|
/// get the text displayed on the button
|
2008-02-27 20:43:16 +00:00
|
|
|
|
docstring screenLabel() const;
|
2002-03-21 17:09:55 +00:00
|
|
|
|
/// holds the entity name that defines the file location (SGML)
|
2006-10-21 19:40:29 +00:00
|
|
|
|
docstring const include_label;
|
2002-08-01 17:28:59 +00:00
|
|
|
|
|
|
|
|
|
/// The pointer never changes although *preview_'s contents may.
|
2003-10-10 21:08:55 +00:00
|
|
|
|
boost::scoped_ptr<RenderMonitoredPreview> const preview_;
|
2003-06-02 10:03:27 +00:00
|
|
|
|
|
|
|
|
|
/// cache
|
2003-06-12 08:52:36 +00:00
|
|
|
|
mutable bool set_label_;
|
2003-10-10 21:08:55 +00:00
|
|
|
|
mutable RenderButton button_;
|
2007-08-12 21:43:58 +00:00
|
|
|
|
mutable docstring listings_label_;
|
2008-03-07 13:33:33 +00:00
|
|
|
|
InsetLabel * label_;
|
1999-09-27 18:44:28 +00:00
|
|
|
|
};
|
|
|
|
|
|
2007-08-13 19:40:54 +00:00
|
|
|
|
/// return loaded Buffer or zero if the file loading did not proceed.
|
|
|
|
|
Buffer * loadIfNeeded(Buffer const & parent, InsetCommandParams const & params);
|
2006-10-21 00:16:43 +00:00
|
|
|
|
|
|
|
|
|
} // namespace lyx
|
|
|
|
|
|
2008-03-27 22:26:24 +00:00
|
|
|
|
#endif // INSET_INCLUDE_H
|