* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
- * \author Lars Gullik Bjønnes
+ * \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 BiblioInfo;
class Buffer;
class Dimension;
+class InsetCommandParams;
+class InsetLabel;
class LaTeXFeatures;
class RenderMonitoredPreview;
+namespace support {
+ class FileNameList;
+}
+
/// 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;
+ InsetInclude(Buffer * buf, InsetCommandParams const &);
///
- virtual DisplayType display() const;
+ ~InsetInclude();
+
///
- 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;
- /** 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 setChildBuffer(Buffer * buffer);
+ /// \return the child buffer if the file is a LyX doc and could be loaded
+ Buffer * getChildBuffer() 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(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.
*/
- EmbeddedFileList const &
- getBibfilesCache(Buffer const & buffer) const;
+ support::FileNameList const &
+ getBibfilesCache() const;
+
+ ///
+ void updateCommand();
+
+ /// \name Public functions inherited from Inset class
+ //@{
///
- EDITABLE editable() const { return IS_EDITABLE; }
+ void setBuffer(Buffer & buffer);
///
- int latex(Buffer const &, odocstream &,
- OutputParams const &) const;
+ bool isLabeled() const { return true; }
+ /// Override these InsetButton methods if Previewing
+ void metrics(MetricsInfo & mi, Dimension & dim) const;
///
- int plaintext(Buffer const &, odocstream &,
- OutputParams const &) const;
+ void draw(PainterInfo & pi, int x, int y) const;
///
- int docbook(Buffer const &, odocstream &,
- OutputParams const &) const;
+ DisplayType display() const;
+ ///
+ InsetCode lyxCode() const { return INCLUDE_CODE; }
+ /** Fills \c key
+ * \param keys the list of bibkeys in the child buffer.
+ * \param it not used here
+ */
+ void fillWithBibKeys(BiblioInfo & keys, InsetIterator const & it) const;
+ ///
+ bool hasSettings() const { return true; }
+ ///
+ int latex(odocstream &, OutputParams const &) const;
+ ///
+ int plaintext(odocstream &, OutputParams const &) const;
+ ///
+ int docbook(odocstream &, OutputParams const &) const;
+ ///
+ docstring xhtml(XHTMLStream &, OutputParams const &) const;
///
void validate(LaTeXFeatures &) const;
///
- void addPreview(graphics::PreviewLoader &) const;
+ void addPreview(DocIterator const &, graphics::PreviewLoader &) const;
///
- void addToToc(TocList &, Buffer const &, ParConstIterator const &) const;
+ void addToToc(DocIterator const &);
///
- void updateLabels(Buffer const & buffer, ParIterator const &);
- /// child document can be embedded
- void registerEmbeddedFiles(Buffer const &, EmbeddedFileList &) const;
+ void updateBuffer(ParIterator const &, UpdateType);
///
- void updateEmbeddedFile(Buffer const & buf, EmbeddedFile const & file);
+ docstring contextMenu(BufferView const & bv, int x, int y) const;
+ //@}
+
+ /// \name Static public methods obligated for InsetCommand derived classes
+ //@{
///
- static CommandInfo const * findInfo(std::string const &);
+ static ParamInfo const & findInfo(std::string const &);
///
- static std::string defaultCommand() { return "include"; };
+ static std::string defaultCommand() { return "include"; }
///
static bool isCompatibleCommand(std::string const & s);
+ //@}
+
protected:
- InsetInclude(InsetInclude const &);
///
- virtual void doDispatch(Cursor & cur, FuncRequest & cmd);
-private:
- virtual Inset * clone() const;
+ InsetInclude(InsetInclude const &);
+private:
/** Slot receiving a signal that the external file has changed
* and the preview should be regenerated.
*/
void fileChanged() const;
+ /// \return loaded Buffer or zero if the file loading did not proceed.
+ Buffer * loadIfNeeded() const;
+ /// launch external application
+ void editIncluded(std::string const & file);
+ ///
+ bool isChildIncluded() const;
+ /// \name Private functions inherited from Inset class
+ //@{
+ Inset * clone() const { return new InsetInclude(*this); }
+ ///
+ void doDispatch(Cursor & cur, FuncRequest & cmd);
+ ///
+ bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
+ //@}
+
+ /// \name Private functions inherited from InsetCommand class
+ //@{
/// set the parameters
- void set(InsetCommandParams const & params, Buffer const &);
+ // FIXME:InsetCommmand::setParams is not virtual
+ void setParams(InsetCommandParams const & params);
/// get the text displayed on the button
- docstring const getScreenLabel(Buffer const &) const;
+ 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_;
+ ///
+ mutable bool failedtoload_;
/// cache
mutable bool set_label_;
mutable RenderButton button_;
mutable docstring listings_label_;
+ InsetLabel * label_;
+ mutable Buffer * child_buffer_;
};
-/// 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
+#endif // INSET_INCLUDE_H
projects / lyx.git / blobdiff