// -*- C++ -*-
-/* This file is part of*
- * ======================================================
+/**
+ * \file insetinclude.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
*
- * LyX, The Document Processor
- *
- * Copyright 1997 LyX Team (this file was created this year)
+ * \author Lars Gullik Bjønnes
*
- * ====================================================== */
+ * Full author contact details are available in file CREDITS.
+ */
#ifndef INSET_INCLUDE_H
#define INSET_INCLUDE_H
-#ifdef __GNUG__
-#pragma interface
-#endif
-
-#include "insetcommand.h"
+#include "inset.h"
+#include "insetcommandparams.h"
+#include "render_button.h"
+#include <boost/scoped_ptr.hpp>
class Buffer;
+class Dimension;
struct LaTeXFeatures;
+class RenderMonitoredPreview;
-// Created by AAS 970521
-/** Used to include files
- */
-class InsetInclude: public InsetButton, boost::noncopyable {
+/// for including tex/lyx files
+class InsetInclude: public InsetOld {
public:
- /// the type of inclusion
- enum Flags {
- ///
- INCLUDE = 0,
- ///
- VERB = 1,
- ///
- INPUT = 2,
- ///
- VERBAST = 3
- };
-
- struct Params {
- Params(InsetCommandParams const & cp = InsetCommandParams(),
- Flags f = INCLUDE,
- bool nl = false,
- string const & name = string())
- : cparams(cp), flag(f), noload(nl),
- masterFilename_(name) {}
- InsetCommandParams cparams;
- Flags flag;
- bool noload;
- string masterFilename_;
-
- ///
- bool operator==(Params const &) const;
- ///
- bool operator!=(Params const &) const;
- };
-
- ///
- InsetInclude(Params const &);
- ///
- InsetInclude(InsetCommandParams const &, Buffer const &);
///
+ InsetInclude(InsetCommandParams const &);
+ InsetInclude(InsetInclude const &);
~InsetInclude();
- /// get the parameters
- Params const & params(void) const;
- /// set the parameters
- void set(Params const & params);
+ ///
+ virtual std::auto_ptr<InsetBase> clone() const;
+ /// Override these InsetButton methods if Previewing
+ void metrics(MetricsInfo & mi, Dimension & dim) const;
///
- virtual Inset * clone(Buffer const &, bool same_id = false) const;
+ void draw(PainterInfo & pi, int x, int y) const;
+ ///
+ virtual bool display() const { return true; }
+
+ /// get the parameters
+ InsetCommandParams const & params(void) const;
+
///
- Inset::Code lyxCode() const { return Inset::INCLUDE_CODE; }
- /// This returns the list of labels on the child buffer
- std::vector<string> const getLabelList() const;
- /// This returns the list of bibkeys on the child buffer
- std::vector< std::pair<string,string> > const getKeys() const;
+ InsetOld::Code lyxCode() const { return InsetOld::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<std::string> & list) const;
+ /** Fills \c keys
+ * \param buffer the Buffer containing this inset.
+ * \param keys the list of bibkeys in the child buffer.
+ */
///
- void edit(BufferView *, int x, int y, unsigned int button);
+ void fillWithBibKeys(Buffer const & buffer,
+ std::vector<std::pair<std::string,std::string> > & keys) const;
///
- void edit(BufferView * bv, bool front = true);
+ EDITABLE editable() const { return IS_EDITABLE; }
///
- EDITABLE editable() const
- {
- return IS_EDITABLE;
- }
- /// With lyx3 we won't overload these 3 methods
- void write(Buffer const *, std::ostream &) const;
+ void write(Buffer const &, std::ostream &) const;
///
- void read(Buffer const *, LyXLex &);
+ void read(Buffer const &, LyXLex &);
///
- int latex(Buffer const *, std::ostream &,
- bool fragile, bool free_spc) const;
+ int latex(Buffer const &, std::ostream &,
+ OutputParams const &) const;
///
- int ascii(Buffer const *, std::ostream &, int linelen) const;
+ int plaintext(Buffer const &, std::ostream &,
+ OutputParams const &) const;
///
- int linuxdoc(Buffer const *, std::ostream &) const;
+ int linuxdoc(Buffer const &, std::ostream &,
+ OutputParams const &) const;
///
- int docbook(Buffer const *, std::ostream &) const;
+ int docbook(Buffer const &, std::ostream &,
+ OutputParams const &) const;
///
void validate(LaTeXFeatures &) const;
-
- /** Input inserts anything inside a paragraph.
- Display can give some visual feedback
- */
- bool display() const;
-
- /// return the filename stub of the included file
- string const getRelFileBaseName() const;
-
- /// return true if the included file is not loaded
- bool isIncludeOnly() const;
-
- /// return true if the file is or got loaded.
- bool loadIfNeeded() const;
-
- /// hide a dialog if about
- SigC::Signal0<void> hideDialog;
+ ///
+ void addPreview(lyx::graphics::PreviewLoader &) const;
+protected:
+ ///
+ virtual
+ DispatchResult
+ priv_dispatch(FuncRequest const & cmd, idx_type &, pos_type &);
private:
+ /// Slot receiving a signal that the preview is ready to display.
+ void statusChanged() const;
+ /** 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 &);
/// get the text displayed on the button
- string const getScreenLabel(Buffer const *) const;
- /// is this a verbatim include ?
- bool isVerbatim() const;
- /// get the filename of the master buffer
- string const getMasterFilename() const;
- /// get the included file name
- string const getFileName() const;
+ std::string const getScreenLabel(Buffer const &) const;
+ ///
+ void write(std::ostream &) const;
+ ///
+ void read(LyXLex &);
/// the parameters
- Params params_;
- /// holds the entity name that defines the file location (SGML)
- string const include_label;
-};
+ InsetCommandParams params_;
+ /// holds the entity name that defines the file location (SGML)
+ std::string 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_;
+};
-inline bool InsetInclude::isVerbatim() const
-{
- return params_.flag == VERB || params_.flag == VERBAST;
-}
+#include "mailinset.h"
-inline bool InsetInclude::isIncludeOnly() const
-{
- return params_.flag == INCLUDE && params_.noload;
-}
+class InsetIncludeMailer : public MailInset {
+public:
+ ///
+ InsetIncludeMailer(InsetInclude & inset);
+ ///
+ virtual InsetBase & 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_;
+};
-#endif
+#endif // INSETINCLUDE_H
projects / lyx.git / blobdiff