// -*- 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 "buffer.h"
-#include "support/filetools.h"
+#include <boost/scoped_ptr.hpp>
+
+class Buffer;
struct LaTeXFeatures;
// Created by AAS 970521
-/** Used to include files
- */
-class InsetInclude: public InsetCommand {
+/// for including tex/lyx files
+class InsetInclude: public InsetButton, boost::noncopyable {
public:
-#if 0
- ///
- InsetInclude(): InsetCommand("include")
- {
- flag = InsetInclude::INCLUDE;
- }
-#endif
+ /// the type of inclusion
+ enum Flags {
+ INCLUDE = 0, //<
+ VERB = 1, //<
+ INPUT = 2, //<
+ VERBAST = 3 //<
+ };
+
+ struct Params {
+ Params(InsetCommandParams const & cp = InsetCommandParams("input"),
+ Flags f = INPUT,
+ string const & name = string())
+ : cparams(cp), flag(f),
+ masterFilename_(name) {}
+
+ InsetCommandParams cparams;
+ Flags flag;
+ string masterFilename_;
+
+ ///
+ bool operator==(Params const &) const;
+ ///
+ bool operator!=(Params const &) const;
+ };
+
///
- InsetInclude(string const &, Buffer *);
+ InsetInclude(Params const &);
///
+ InsetInclude(InsetCommandParams const &, Buffer const &);
+
~InsetInclude();
- ///
- Inset * Clone() const;
+
///
- Inset::Code LyxCode() const { return Inset::INCLUDE_CODE; }
+ virtual dispatch_result localDispatch(FuncRequest const & cmd);
+
+ /// Override these InsetButton methods if Previewing
+ int ascent(BufferView *, LyXFont const &) const;
+ ///
+ int descent(BufferView *, LyXFont const &) const;
+ ///
+ int width(BufferView *, LyXFont const &) const;
+ ///
+ void draw(BufferView *, LyXFont const &, int, float &) 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;
+ ///
+ Inset::Code lyxCode() const { return Inset::INCLUDE_CODE; }
/// This returns the list of labels on the child buffer
- std::vector<string> getLabelList() const;
+ std::vector<string> const getLabelList() const;
/// This returns the list of bibkeys on the child buffer
- std::vector< std::pair<string,string> > getKeys() const;
- ///
- void Edit(BufferView *, int x, int y, unsigned int button);
+ void fillWithBibKeys(std::vector<std::pair<string,string> > & keys) const;
///
- EDITABLE Editable() 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 &);
- ///
- int Latex(Buffer const *, std::ostream &, bool fragile, bool free_spc) const;
- ///
- int Linuxdoc(Buffer const *, std::ostream &) const;
- ///
- int DocBook(Buffer const *, std::ostream &) const;
- ///
- void Validate(LaTeXFeatures &) const;
-
- /** Input inserts anything inside a paragraph.
- Display can give some visual feedback
- */
- bool display() const;
+ /// With lyx3 we won't overload these 3 methods
+ void write(Buffer const *, std::ostream &) const;
///
- string getScreenLabel() const;
+ void read(Buffer const *, LyXLex &);
///
- void setContents(string const & c);
- ///
- void setFilename(string const & n) { setContents(n); }
- ///
- string getMasterFilename() const { return master->fileName(); }
- ///
- string getFileName() const {
- return filename;
- }
- /// In "input" mode uses \input instead of \include.
- bool isInput() const { return flag == InsetInclude::INPUT; }
- /// If this is true, the child file shouldn't be loaded by lyx
- bool isNoLoad() const { return noload; }
-
- /** A verbatim file shouldn't be loaded by LyX
- * No need to generate LaTeX code of a verbatim file
- */
- bool isVerb() const;
- ///
- bool isVerbVisibleSpace() const {
- return flag == InsetInclude::VERBAST;
- }
- ///
- bool isInclude() const { return flag == InsetInclude::INCLUDE;}
- ///
- void setInput();
- ///
- void setNoLoad(bool);
- ///
- void setInclude();
- ///
- void setVerb();
- ///
- void setVisibleSpace(bool b);
- /// return true if the file is or got loaded.
- bool loadIfNeeded() const;
-private:
- ///
- enum Include_Flags {
- ///
- INCLUDE= 0,
- ///
- VERB = 1,
- ///
- INPUT = 2,
- ///
- VERBAST = 3
- };
-
+ int latex(Buffer const *, std::ostream &,
+ bool fragile, bool free_spc) const;
///
- bool noload;
+ int ascii(Buffer const *, std::ostream &, int linelen) const;
///
- int flag;
- ///
- Buffer * master;
+ int linuxdoc(Buffer const *, std::ostream &) const;
///
- string filename;
+ int docbook(Buffer const *, std::ostream &, bool mixcont) const;
///
- mutable string include_label;
-};
-
-
-inline
-bool InsetInclude::isVerb() const
-{
- return flag == InsetInclude::VERB || flag == InsetInclude::VERBAST;
-}
+ void validate(LaTeXFeatures &) const;
+ /// take up a whole row if we're not type INPUT
+ bool display() const;
-inline
-void InsetInclude::setInput()
-{
- if (!isInput()) {
- flag = InsetInclude::INPUT;
- setCmdName("input");
- }
-}
+ /// return true if the file is or got loaded.
+ bool loadIfNeeded() const;
+ ///
+ void addPreview(grfx::PreviewLoader &) const;
-inline
-void InsetInclude::setNoLoad(bool b)
-{
- noload = b;
-}
+private:
+ /// 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;
+
+ /// the parameters
+ 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_;
+};
-inline
-void InsetInclude::setInclude()
+inline bool InsetInclude::isVerbatim() const
{
- if (!isInclude()) {
- flag = InsetInclude::INCLUDE;
- setCmdName("include");
- }
+ return params_.flag == VERB || params_.flag == VERBAST;
}
+#include "mailinset.h"
-inline
-void InsetInclude::setVerb()
-{
- if (!isVerb()) {
- flag = InsetInclude::VERB;
- setCmdName("verbatiminput");
- }
-}
-
+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() const;
+ ///
+ static void string2params(string const &, InsetInclude::Params &);
+ ///
+ static string const params2string(InsetInclude::Params const &);
+private:
+ ///
+ static string const name_;
+ ///
+ InsetInclude & inset_;
+};
-inline
-void InsetInclude::setVisibleSpace(bool b)
-{
- if (b && flag == InsetInclude::VERB) {
- setCmdName("verbatiminput*");
- flag = InsetInclude::VERBAST;
- } else if (!b && flag == InsetInclude::VERBAST) {
- setCmdName("verbatiminput");
- flag = InsetInclude::VERB;
- }
-}
-#endif
+#endif // INSETINCLUDE_H
projects / lyx.git / blobdiff