2000-02-29 02:19:17 +00:00
|
|
|
// -*- C++ -*-
|
2002-09-25 14:26:13 +00:00
|
|
|
/**
|
|
|
|
* \file insetgraphics.h
|
|
|
|
* This file is part of LyX, the document processor.
|
|
|
|
* Licence details can be found in the file COPYING.
|
2000-02-29 02:19:17 +00:00
|
|
|
*
|
2002-01-29 09:26:24 +00:00
|
|
|
* \author Baruch Even
|
2002-09-25 14:26:13 +00:00
|
|
|
* \author Herbert Voss
|
|
|
|
*
|
2003-08-23 00:17:00 +00:00
|
|
|
* Full author contact details are available in file CREDITS.
|
2002-09-25 14:26:13 +00:00
|
|
|
*/
|
2000-02-29 02:19:17 +00:00
|
|
|
|
|
|
|
#ifndef INSET_GRAPHICS_H
|
|
|
|
#define INSET_GRAPHICS_H
|
|
|
|
|
2003-06-02 10:03:27 +00:00
|
|
|
#include "inset.h"
|
|
|
|
#include "insetgraphicsParams.h"
|
2002-05-29 16:21:03 +00:00
|
|
|
|
2002-06-26 16:57:59 +00:00
|
|
|
#include <boost/scoped_ptr.hpp>
|
2003-06-03 17:49:09 +00:00
|
|
|
#include <boost/signals/trackable.hpp>
|
|
|
|
|
2002-06-25 15:59:10 +00:00
|
|
|
|
2000-07-31 12:30:10 +00:00
|
|
|
class Dialogs;
|
2003-06-12 08:52:36 +00:00
|
|
|
class GraphicRenderer;
|
2002-02-27 09:59:52 +00:00
|
|
|
class LaTeXFeatures;
|
2000-03-09 23:58:55 +00:00
|
|
|
|
2000-02-29 02:19:17 +00:00
|
|
|
///
|
2003-07-25 21:20:24 +00:00
|
|
|
class InsetGraphics : public InsetOld, public boost::signals::trackable {
|
2000-02-29 02:19:17 +00:00
|
|
|
public:
|
2000-03-09 23:58:55 +00:00
|
|
|
///
|
|
|
|
InsetGraphics();
|
2000-08-14 09:44:53 +00:00
|
|
|
///
|
2003-06-03 15:10:14 +00:00
|
|
|
InsetGraphics(InsetGraphics const &);
|
2003-05-26 09:13:55 +00:00
|
|
|
///
|
2000-08-14 09:44:53 +00:00
|
|
|
~InsetGraphics();
|
2000-02-29 02:19:17 +00:00
|
|
|
///
|
2003-04-24 20:02:49 +00:00
|
|
|
virtual dispatch_result localDispatch(FuncRequest const & cmd);
|
2003-03-07 18:44:57 +00:00
|
|
|
///
|
2003-06-02 10:03:27 +00:00
|
|
|
void metrics(MetricsInfo &, Dimension &) const;
|
2000-02-29 02:19:17 +00:00
|
|
|
///
|
2003-05-30 06:48:24 +00:00
|
|
|
void draw(PainterInfo & pi, int x, int y) const;
|
2000-02-29 02:19:17 +00:00
|
|
|
///
|
2001-06-28 10:25:20 +00:00
|
|
|
EDITABLE editable() const;
|
2000-02-29 02:19:17 +00:00
|
|
|
///
|
2003-08-28 07:41:31 +00:00
|
|
|
void write(Buffer const &, std::ostream &) const;
|
2000-02-29 02:19:17 +00:00
|
|
|
///
|
2003-08-28 07:41:31 +00:00
|
|
|
void read(Buffer const &, LyXLex & lex);
|
2000-07-31 12:30:10 +00:00
|
|
|
|
2000-02-29 02:19:17 +00:00
|
|
|
/** returns the number of rows (\n's) of generated tex code.
|
2000-09-14 17:53:12 +00:00
|
|
|
#fragile == true# means, that the inset should take care about
|
|
|
|
fragile commands by adding a #\protect# before.
|
2000-02-29 02:19:17 +00:00
|
|
|
*/
|
2003-08-28 07:41:31 +00:00
|
|
|
int latex(Buffer const &, std::ostream &,
|
2003-05-23 08:59:47 +00:00
|
|
|
LatexRunParams const &) const;
|
2000-03-06 02:42:40 +00:00
|
|
|
///
|
2003-08-28 07:41:31 +00:00
|
|
|
int ascii(Buffer const &, std::ostream &, int linelen) const;
|
2000-04-24 20:58:23 +00:00
|
|
|
///
|
2003-08-28 07:41:31 +00:00
|
|
|
int linuxdoc(Buffer const &, std::ostream &) const;
|
2000-03-06 02:42:40 +00:00
|
|
|
///
|
2003-08-28 07:41:31 +00:00
|
|
|
int docbook(Buffer const &, std::ostream &, bool mixcont) const;
|
2000-03-09 23:58:55 +00:00
|
|
|
|
2000-07-31 12:30:10 +00:00
|
|
|
/** Tell LyX what the latex features you need i.e. what latex packages
|
2000-09-14 17:53:12 +00:00
|
|
|
you need to be included.
|
|
|
|
*/
|
2001-06-28 10:25:20 +00:00
|
|
|
void validate(LaTeXFeatures & features) const;
|
2000-02-29 02:19:17 +00:00
|
|
|
|
|
|
|
/// returns LyX code associated with the inset. Used for TOC, ...)
|
2003-07-25 21:20:24 +00:00
|
|
|
InsetOld::Code lyxCode() const { return InsetOld::GRAPHICS_CODE; }
|
2000-08-14 09:44:53 +00:00
|
|
|
|
2000-02-29 02:19:17 +00:00
|
|
|
///
|
2003-07-25 17:11:25 +00:00
|
|
|
virtual std::auto_ptr<InsetBase> clone() const;
|
2000-07-31 12:30:10 +00:00
|
|
|
|
2000-09-14 17:53:12 +00:00
|
|
|
/** Set the inset parameters, used by the GUIndependent dialog.
|
|
|
|
Return true of new params are different from what was so far.
|
|
|
|
*/
|
2003-06-03 15:10:14 +00:00
|
|
|
bool setParams(InsetGraphicsParams const & params);
|
2000-07-31 12:30:10 +00:00
|
|
|
|
2000-08-14 09:44:53 +00:00
|
|
|
/// Get the inset parameters, used by the GUIndependent dialog.
|
2002-02-27 09:59:52 +00:00
|
|
|
InsetGraphicsParams const & params() const;
|
2000-07-31 12:30:10 +00:00
|
|
|
|
2000-02-29 02:19:17 +00:00
|
|
|
private:
|
2003-03-07 18:44:57 +00:00
|
|
|
///
|
|
|
|
friend class InsetGraphicsMailer;
|
|
|
|
|
2003-06-03 17:49:09 +00:00
|
|
|
/** This method is connected to the graphics loader, so we are
|
|
|
|
* informed when the image has been loaded.
|
2002-06-25 15:59:10 +00:00
|
|
|
*/
|
|
|
|
void statusChanged();
|
2002-02-27 09:59:52 +00:00
|
|
|
|
2001-07-28 12:24:16 +00:00
|
|
|
/// Read the inset native format
|
2003-06-03 15:10:14 +00:00
|
|
|
void readInsetGraphics(LyXLex & lex, string const & bufpath);
|
2002-03-21 17:09:55 +00:00
|
|
|
|
2000-10-12 10:46:06 +00:00
|
|
|
/// Get the status message, depends on the image loading status.
|
2001-05-31 02:23:46 +00:00
|
|
|
string const statusMessage() const;
|
2001-02-08 13:06:55 +00:00
|
|
|
/// Create the options for the latex command.
|
|
|
|
string const createLatexOptions() const;
|
|
|
|
/// Convert the file if needed, and return the location of the file.
|
2003-08-28 07:41:31 +00:00
|
|
|
string const prepareFile(Buffer const & buf, LatexRunParams const &) const;
|
2002-02-27 09:59:52 +00:00
|
|
|
|
|
|
|
///
|
|
|
|
InsetGraphicsParams params_;
|
|
|
|
|
2002-02-20 09:04:56 +00:00
|
|
|
/// holds the entity name that defines the graphics location (SGML).
|
|
|
|
string const graphic_label;
|
2002-02-27 09:59:52 +00:00
|
|
|
|
2003-06-03 17:49:09 +00:00
|
|
|
/// The thing that actually draws the image on LyX's screen.
|
2003-06-12 08:52:36 +00:00
|
|
|
boost::scoped_ptr<GraphicRenderer> const graphic_;
|
2000-02-29 02:19:17 +00:00
|
|
|
};
|
|
|
|
|
2003-03-07 18:44:57 +00:00
|
|
|
|
|
|
|
#include "mailinset.h"
|
|
|
|
|
|
|
|
class InsetGraphicsMailer : public MailInset {
|
|
|
|
public:
|
|
|
|
///
|
|
|
|
InsetGraphicsMailer(InsetGraphics & inset);
|
|
|
|
///
|
2003-03-10 13:33:39 +00:00
|
|
|
virtual InsetBase & inset() const { return inset_; }
|
2003-03-07 18:44:57 +00:00
|
|
|
///
|
|
|
|
virtual string const & name() const { return name_; }
|
|
|
|
///
|
2003-07-23 09:54:21 +00:00
|
|
|
virtual string const inset2string(Buffer const &) const;
|
2003-03-07 18:44:57 +00:00
|
|
|
///
|
2003-07-21 21:51:17 +00:00
|
|
|
static void string2params(string const & data,
|
2003-07-23 09:54:21 +00:00
|
|
|
Buffer const & buffer,
|
2003-07-21 21:51:17 +00:00
|
|
|
InsetGraphicsParams &);
|
2003-03-07 18:44:57 +00:00
|
|
|
///
|
2003-07-21 21:51:17 +00:00
|
|
|
static string const params2string(InsetGraphicsParams const &,
|
2003-07-23 09:54:21 +00:00
|
|
|
Buffer const &);
|
2003-03-07 18:44:57 +00:00
|
|
|
private:
|
|
|
|
///
|
|
|
|
static string const name_;
|
|
|
|
///
|
|
|
|
InsetGraphics & inset_;
|
|
|
|
};
|
|
|
|
|
2002-03-21 17:09:55 +00:00
|
|
|
#endif
|