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
26 #include "GraphicsTypes.h"
28 #include <boost/shared_ptr.hpp>
30 #include <boost/signals/signal0.hpp>
31 #include <boost/signals/signal1.hpp>
49 /// A list of supported formats.
50 typedef std::vector<string> FormatList;
51 /** This will be connected to a function that will return whichever
52 * derived class we desire.
54 static boost::signal0<ImagePtr> newImage;
56 /// Return the list of loadable formats.
57 static boost::signal0<FormatList> loadableFormats;
63 virtual GImage * clone() const = 0;
66 virtual Pixmap getPixmap() const = 0;
68 /// Get the image width
69 virtual unsigned int getWidth() const = 0;
71 /// Get the image height
72 virtual unsigned int getHeight() const = 0;
74 /** At the end of the loading or modification process, return the new
75 * image by emitting this signal */
76 typedef boost::signal1<void, bool> SignalType;
78 typedef boost::shared_ptr<SignalType> SignalTypePtr;
80 /// Start loading the image file.
81 virtual void load(string const & filename, SignalTypePtr) = 0;
83 /** Generate the pixmap.
84 * Uses the params to decide on color, grayscale etc.
85 * Returns true if the pixmap is created.
87 virtual bool setPixmap(GParams const & params) = 0;
89 /// Clip the image using params.
90 virtual void clip(GParams const & params) = 0;
92 /// Rotate the image using params.
93 virtual void rotate(GParams const & params) = 0;
95 /// Scale the image using params.
96 virtual void scale(GParams const & params) = 0;
99 /** Uses the params to ascertain the dimensions of the scaled image.
100 * Returned as make_pair(width, height).
101 * If something geso wrong, returns make_pair(getWidth(), getHeight())
103 std::pair<unsigned int, unsigned int>
104 getScaledDimensions(GParams const & params) const;
109 #endif // GRAPHICSIMAGE_H