// -*- C++ -*-
-/* This file is part of
- * ======================================================
- *
- * LyX, The Document Processor
- *
- * Copyright 1995 Matthias Ettrich
- * Copyright 1995-2001 the LyX Team.
+/**
+ * \file insetgraphics.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
*
- * ====================================================== */
+ * \author Baruch Even
+ * \author Herbert Voss
+ *
+ * Full author contact details are available in file CREDITS
+ */
#ifndef INSET_GRAPHICS_H
#define INSET_GRAPHICS_H
-
-#ifdef __GNUG__
-#pragma interface
-#endif
-
-#include "insets/lyxinset.h"
+#include "insets/inset.h"
#include "insets/insetgraphicsParams.h"
-#include "graphics/GraphicsCacheItem.h"
-#include <boost/smart_ptr.hpp>
-
-#include "LaTeXFeatures.h"
-// We need a signal here to hide an active dialog when we are deleted.
-#include "sigc++/signal_system.h"
+#include <boost/signals/trackable.hpp>
+#include <boost/scoped_ptr.hpp>
class Dialogs;
-class LyXImage;
+class LaTeXFeatures;
///
-class InsetGraphics : public Inset, public SigC::Object {
+class InsetGraphics : public Inset, public boost::signals::trackable {
public:
///
InsetGraphics();
///
+ InsetGraphics(InsetGraphics const &, string const & filepath,
+ bool same_id = false);
+ ///
~InsetGraphics();
///
+ virtual dispatch_result localDispatch(FuncRequest const & cmd);
+ ///
int ascent(BufferView *, LyXFont const &) const;
///
int descent(BufferView *, LyXFont const &) const;
///
int width(BufferView *, LyXFont const &) const;
///
- bool display() const { return true; }
- ///
- void draw(BufferView *, LyXFont const &, int, float &, bool) const;
- ///
- void Edit(BufferView *, int, int, unsigned int);
+ void draw(BufferView *, LyXFont const &, int, float &) const;
///
- EDITABLE Editable() const;
+ EDITABLE editable() const;
///
- void Write(Buffer const *, std::ostream &) const;
+ void write(Buffer const *, std::ostream &) const;
///
- void Read(Buffer const *, LyXLex & lex);
+ void read(Buffer const *, LyXLex & lex);
/** returns the number of rows (\n's) of generated tex code.
#fragile == true# means, that the inset should take care about
fragile commands by adding a #\protect# before.
*/
- int Latex(Buffer const *, std::ostream &,
- bool fragile, bool free_spc) const;
+ int latex(Buffer const *, std::ostream &,
+ bool fragile, bool free_spc) const;
///
- int Ascii(Buffer const *, std::ostream &, int linelen) const;
+ int ascii(Buffer const *, std::ostream &, int linelen) const;
///
- int Linuxdoc(Buffer const *, std::ostream &) const;
+ int linuxdoc(Buffer const *, std::ostream &) const;
///
- int DocBook(Buffer const *, std::ostream &) const;
+ int docbook(Buffer const *, std::ostream &, bool mixcont) const;
/** Tell LyX what the latex features you need i.e. what latex packages
you need to be included.
*/
- void Validate(LaTeXFeatures & features) const;
+ void validate(LaTeXFeatures & features) const;
/// returns LyX code associated with the inset. Used for TOC, ...)
- Inset::Code LyxCode() const { return Inset::GRAPHICS_CODE; }
+ Inset::Code lyxCode() const { return Inset::GRAPHICS_CODE; }
///
- Inset * Clone(Buffer const &) const;
+ virtual Inset * clone(Buffer const &, bool same_id = false) const;
/** Set the inset parameters, used by the GUIndependent dialog.
Return true of new params are different from what was so far.
*/
- bool setParams(InsetGraphicsParams const & params);
+ bool setParams(InsetGraphicsParams const & params,
+ string const & filepath);
/// Get the inset parameters, used by the GUIndependent dialog.
- InsetGraphicsParams getParams() const;
-
- /** This signal is connected by our dialog and called when the inset
- is deleted.
- */
- SigC::Signal0<void> hideDialog;
+ InsetGraphicsParams const & params() const;
private:
- /// Update the inset after parameter change.
- void updateInset() const;
+ /// Returns the cached BufferView.
+ BufferView * view() const;
+
+ ///
+ friend class InsetGraphicsMailer;
+
+ /// Is the image ready to draw, or should we display a message instead?
+ bool imageIsDrawable() const;
+
+ /** This method is connected to cache_->statusChanged, so we are
+ informed when the image has been loaded.
+ */
+ void statusChanged();
+
+ /// Read the inset native format
+ void readInsetGraphics(LyXLex & lex);
+
/// Get the status message, depends on the image loading status.
- char const * statusMessage() const;
+ string const statusMessage() const;
/// Create the options for the latex command.
string const createLatexOptions() const;
/// Convert the file if needed, and return the location of the file.
string const prepareFile(Buffer const * buf) const;
- /// The graphics cache handle.
- mutable boost::shared_ptr<GraphicsCacheItem> cacheHandle;
+ ///
+ InsetGraphicsParams params_;
+
+ /// holds the entity name that defines the graphics location (SGML).
+ string const graphic_label;
+
+ /// The cached variables
+ class Cache;
+ friend class Cache;
+ /// The pointer never changes although *cache_'s contents may.
+ boost::scoped_ptr<Cache> const cache_;
+};
+
- /// is the pixmap initialized?
- mutable bool imageLoaded;
+#include "mailinset.h"
- InsetGraphicsParams params;
+class InsetGraphicsMailer : public MailInset {
+public:
+ ///
+ InsetGraphicsMailer(InsetGraphics & inset);
+ ///
+ virtual InsetBase & inset() const { return inset_; }
+ ///
+ virtual string const & name() const { return name_; }
+ ///
+ virtual string const inset2string() const;
+ ///
+ static void string2params(string const &, InsetGraphicsParams &);
+ ///
+ static string const params2string(InsetGraphicsParams const &);
+private:
+ ///
+ static string const name_;
+ ///
+ InsetGraphics & inset_;
};
-#endif
+#endif