3 * \file GraphicsImage.h
4 * Copyright 2002 the LyX Team
5 * Read the file COPYING
7 * \author Baruch Even <baruch.even@writeme.com>
8 * \author Angus Leeming <a.leeming@ic.ac.uk>
10 * An abstract base class for the images themselves.
11 * Allows the user to retrieve the pixmap, once loaded and to issue commands
14 * The signals newImage and loadableFormats are connected to the approriate
15 * derived classes elsewhere, allowing the graphics cache to access them
16 * without knowing anything about their instantiation.
18 * The loading process can be asynchronous, but cropping, rotating and
19 * scaling block execution.
22 #ifndef GRAPHICSIMAGE_H
23 #define GRAPHICSIMAGE_H
25 #include "GraphicsTypes.h"
27 #include <boost/smart_ptr.hpp>
28 #include <sigc++/signal_system.h>
44 /// A list of supported formats.
45 typedef std::vector<string> FormatList;
46 /** This will be connected to a function that will return whichever
47 * derived class we desire.
49 static SigC::Signal0<ImagePtr> newImage;
51 /// Return the list of loadable formats.
52 static SigC::Signal0<FormatList> loadableFormats;
58 virtual GImage * clone() const = 0;
61 virtual Pixmap getPixmap() const = 0;
63 /// Get the image width
64 virtual unsigned int getWidth() const = 0;
66 /// Get the image height
67 virtual unsigned int getHeight() const = 0;
69 /** At the end of the loading or modification process, return the new
70 * image by emitting this signal */
71 typedef SigC::Signal1<void, bool> SignalType;
73 typedef boost::shared_ptr<SignalType> SignalTypePtr;
75 /// Start loading the image file.
76 virtual void load(string const & filename, SignalTypePtr) = 0;
78 /** Generate the pixmap.
79 * Uses the params to decide on color, grayscale etc.
80 * Returns true if the pixmap is created.
82 virtual bool setPixmap(GParams const & params) = 0;
84 /// Clip the image using params.
85 virtual void clip(GParams const & params) = 0;
87 /// Rotate the image using params.
88 virtual void rotate(GParams const & params) = 0;
90 /// Scale the image using params.
91 virtual void scale(GParams const & params) = 0;
94 /** Uses the params to ascertain the dimensions of the scaled image.
95 * Returned as make_pair(width, height).
96 * If something geso wrong, returns make_pair(getWidth(), getHeight())
98 std::pair<unsigned int, unsigned int>
99 getScaledDimensions(GParams const & params) const;
104 #endif // GRAPHICSIMAGE_H