lyx_mirror/src/insets/insetgraphics.h
Lars Gullik Bjønnes 99d1627a47 dont use pragma impementation and interface anymore
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@6138 a592a061-630c-0410-9148-cb99ea01b6c8
2003-02-13 16:53:15 +00:00

129 lines
3.5 KiB
C++

// -*- C++ -*-
/**
* \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
#include "insets/inset.h"
#include "insets/insetgraphicsParams.h"
// We need a signal here to hide an active dialog when we are deleted.
#include <boost/signals/signal0.hpp>
#include <boost/signals/trackable.hpp>
#include <boost/scoped_ptr.hpp>
class Dialogs;
class LaTeXFeatures;
///
class InsetGraphics : public Inset, public boost::signals::trackable {
public:
///
InsetGraphics();
///
InsetGraphics(InsetGraphics const &, string const & filepath,
bool same_id = false);
///
~InsetGraphics();
///
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 &, bool) const;
///
void edit(BufferView *, int, int, mouse_button::state);
///
void edit(BufferView * bv, bool front = true);
///
EDITABLE editable() const;
///
void write(Buffer const *, std::ostream &) const;
///
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 ascii(Buffer const *, std::ostream &, int linelen) const;
///
int linuxdoc(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;
/// returns LyX code associated with the inset. Used for TOC, ...)
Inset::Code lyxCode() const { return Inset::GRAPHICS_CODE; }
///
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,
string const & filepath);
/// Get the inset parameters, used by the GUIndependent dialog.
InsetGraphicsParams const & params() const;
/** This signal is connected by our dialog and called when the inset
is deleted.
*/
boost::signal0<void> hideDialog;
private:
/// 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.
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;
///
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_;
};
#endif