// -*- 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
+ * \author Lars Gullik Bjønnes
*
- * Copyright 1997 LyX Team (this file was created this year)
- *
- * ====================================================== */
+ * 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 "dimension.h"
+#include "renderers.h"
+#include <boost/scoped_ptr.hpp>
+
class Buffer;
struct LaTeXFeatures;
// 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
+ INCLUDE = 0, //<
+ VERB = 1, //<
+ INPUT = 2, //<
+ VERBAST = 3 //<
};
struct Params {
- Params(InsetCommandParams const & cp = InsetCommandParams(),
- Flags f = INCLUDE,
- bool nl = false,
+ Params(InsetCommandParams const & cp = InsetCommandParams("input"),
+ Flags f = INPUT,
string const & name = string())
- : cparams(cp), flag(f), noload(nl),
+ : cparams(cp), flag(f),
masterFilename_(name) {}
+
InsetCommandParams cparams;
Flags flag;
- bool noload;
string masterFilename_;
///
///
InsetInclude(Params const &);
- ///
InsetInclude(InsetCommandParams const &, Buffer const &);
- ///
+ InsetInclude(InsetInclude const &);
+
~InsetInclude();
+ ///
+ virtual dispatch_result localDispatch(FuncRequest const & cmd);
+
+ /// Override these InsetButton methods if Previewing
+ void metrics(MetricsInfo & mi, Dimension & dim) const;
+ ///
+ void draw(PainterInfo & pi, int x, int y) const;
+ ///
+ virtual BufferView * view() const;
+
/// get the parameters
Params const & params(void) const;
/// set the parameters
void set(Params const & params);
///
- virtual Inset * clone(Buffer const &, bool same_id = false) const;
+ virtual std::auto_ptr<InsetBase> clone() const;
///
- Inset::Code lyxCode() const { return Inset::INCLUDE_CODE; }
+ InsetOld::Code lyxCode() const { return InsetOld::INCLUDE_CODE; }
/// This returns the list of labels on the child buffer
- std::vector<string> const getLabelList() const;
+ void getLabelList(std::vector<string> &) const;
/// This returns the list of bibkeys on the child buffer
- std::vector< std::pair<string,string> > const getKeys() const;
- ///
- void edit(BufferView *, int x, int y, unsigned int button);
- ///
- void edit(BufferView * bv, bool front = true);
+ void fillWithBibKeys(std::vector<std::pair<string,string> > & keys) const;
///
EDITABLE editable() const
{
return IS_EDITABLE;
}
- /// With lyx3 we won't overload these 3 methods
- void write(Buffer const *, std::ostream &) const;
///
- void read(Buffer const *, LyXLex &);
+ void write(Buffer const &, std::ostream &) const;
///
- int latex(Buffer const *, std::ostream &,
- bool fragile, bool free_spc) const;
+ void read(Buffer const &, LyXLex &);
///
- int ascii(Buffer const *, std::ostream &, int linelen) const;
+ int latex(Buffer const &, std::ostream &,
+ LatexRunParams const &) const;
///
- int linuxdoc(Buffer const *, std::ostream &) const;
+ int ascii(Buffer const &, std::ostream &, int linelen) const;
///
- int docbook(Buffer const *, std::ostream &) const;
+ int linuxdoc(Buffer const &, std::ostream &) const;
+ ///
+ int docbook(Buffer const &, std::ostream &, bool mixcont) 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;
+
private:
+ friend class InsetIncludeMailer;
+
+ ///
+ void write(std::ostream &) const;
+ ///
+ void read(LyXLex &);
/// get the text displayed on the button
- string const getScreenLabel(Buffer const *) const;
+ string const getScreenLabel(Buffer const &) const;
/// is this a verbatim include ?
bool isVerbatim() const;
/// get the filename of the master buffer
Params params_;
/// holds the entity name that defines the file location (SGML)
string const include_label;
+
+ /// Use the Pimpl idiom to hide the internals of the previewer.
+ class PreviewImpl;
+ friend class PreviewImpl;
+ /// The pointer never changes although *preview_'s contents may.
+ boost::scoped_ptr<PreviewImpl> const preview_;
+
+ /// cache
+ mutable bool set_label_;
+ mutable ButtonRenderer button_;
+ mutable unsigned int center_indent_;
};
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 string const & name() const { return name_; }
+ ///
+ virtual string const inset2string(Buffer const &) const;
+ ///
+ static void string2params(string const &, InsetInclude::Params &);
+ ///
+ static string const params2string(InsetInclude::Params const &);
+private:
+ ///
+ static string const name_;
+ ///
+ InsetInclude & inset_;
+};
-#endif
+#endif // INSETINCLUDE_H
projects / lyx.git / blobdiff