* 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.
*/
#define INSET_INCLUDE_H
#include "BiblioInfo.h"
-#include "Inset.h"
+#include "InsetCommand.h"
#include "InsetCommandParams.h"
#include "RenderButton.h"
#include "MailInset.h"
#include "Counters.h"
#include "EmbeddedFiles.h"
-#include "support/FileName.h"
-
#include <boost/scoped_ptr.hpp>
namespace lyx {
class LaTeXFeatures;
class RenderMonitoredPreview;
-
/// for including tex/lyx files
-class InsetInclude : public Inset {
+class InsetInclude : public InsetCommand {
public:
///
InsetInclude(InsetCommandParams const &);
- ~InsetInclude();
/// Override these InsetButton methods if Previewing
- bool metrics(MetricsInfo & mi, Dimension & dim) const;
+ void metrics(MetricsInfo & mi, Dimension & dim) const;
///
void draw(PainterInfo & pi, int x, int y) const;
///
- virtual DisplayType display() const;
-
- /// get the parameters
- InsetCommandParams const & params() const;
-
+ DisplayType display() const;
///
- Inset::Code lyxCode() const { return Inset::INCLUDE_CODE; }
+ 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(Buffer const & buffer,
- std::vector<docstring> & list) const;
+ 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
*/
- virtual void fillWithBibKeys(Buffer const & buffer,
- BiblioInfo & keys, InsetIterator const & it) const;
+ 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).
* automatic loading of all child documents upon loading the master.
* \param buffer the Buffer containing this inset.
*/
- void updateBibfilesCache(Buffer const & buffer);
+ 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.
*/
- std::vector<support::FileName> const &
- getBibfilesCache(Buffer const & buffer) const;
+ EmbeddedFileList const &
+ getBibfilesCache(Buffer const & buffer) const;
///
EDITABLE editable() const { return IS_EDITABLE; }
///
- void write(Buffer const &, std::ostream &) const;
+ int latex(odocstream &, OutputParams const &) const;
///
- void read(Buffer const &, Lexer &);
+ int plaintext(odocstream &, OutputParams const &) const;
///
- int latex(Buffer const &, odocstream &,
- OutputParams const &) const;
- ///
- int plaintext(Buffer const &, odocstream &,
- OutputParams const &) const;
- ///
- int docbook(Buffer const &, odocstream &,
- OutputParams const &) const;
+ int docbook(odocstream &, OutputParams const &) const;
///
void validate(LaTeXFeatures &) const;
///
void addPreview(graphics::PreviewLoader &) const;
///
- void addToToc(TocList &, Buffer const &, ParConstIterator const &) const;
+ void addToToc(ParConstIterator const &) const;
///
- bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
- ///
- void updateLabels(Buffer const & buffer, ParIterator const &);
+ void updateLabels(ParIterator const &);
/// child document can be embedded
- void registerEmbeddedFiles(Buffer const &, EmbeddedFiles &,
- ParConstIterator const &) const;
+ 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 &);
///
- virtual void doDispatch(Cursor & cur, FuncRequest & cmd);
+ void doDispatch(Cursor & cur, FuncRequest & cmd);
private:
- virtual Inset * clone() const;
+ 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;
- friend class InsetIncludeMailer;
-
/// set the parameters
- void set(InsetCommandParams const & params, Buffer const &);
+ void setParams(InsetCommandParams const & params);
/// get the text displayed on the button
- docstring const getScreenLabel(Buffer const &) const;
- ///
- void write(std::ostream &) const;
- ///
- void read(Lexer &);
-
- /// the parameters
- InsetCommandParams params_;
+ docstring screenLabel() const;
/// holds the entity name that defines the file location (SGML)
docstring const include_label;
mutable docstring listings_label_;
};
-
-class InsetIncludeMailer : public MailInset {
-public:
- ///
- InsetIncludeMailer(InsetInclude & inset);
- ///
- virtual Inset & inset() const { return inset_; }
- ///
- virtual std::string const & name() const { return name_; }
- ///
- virtual std::string const inset2string(Buffer const &) const;
- ///
- static void string2params(std::string const &, InsetCommandParams &);
- ///
- static std::string const params2string(InsetCommandParams const &);
-private:
- ///
- static std::string const name_;
- ///
- InsetInclude & inset_;
-};
-
+/// 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
projects / lyx.git / blobdiff