Differential D29397 Diff 82079 src/widgets/thumbcreator.h

Changeset View

Standalone View

src/widgets/thumbcreator.h

Show All 14 Lines		1	/* This file is part of the KDE libraries
15	along with this library; see the file COPYING.LIB. If not, write to	15		along with this library; see the file COPYING.LIB. If not, write to
16	the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,	16		the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17	Boston, MA 02110-1301, USA.	17		Boston, MA 02110-1301, USA.
18	*/	18		*/
19		19
20	#ifndef _THUMBCREATOR_H_	20		#ifndef _THUMBCREATOR_H_
21	#define _THUMBCREATOR_H_	21		#define _THUMBCREATOR_H_
22		22
		23		#include <QtGlobal>
		24
23	#include "kiowidgets_export.h"	25		#include "kiowidgets_export.h"
24		26
25	class QString;	27		class QString;
26	class QImage;	28		class QImage;
27	class QWidget;	29		class QWidget;
28		30
29	/**	31		/**
30	* @class ThumbCreator thumbcreator.h <KIO/ThumbCreator>	32		* @class ThumbCreator thumbcreator.h <KIO/ThumbCreator>
▲ Show 20 Lines • Show All 97 Lines • ▼ Show 20 Line(s)		111	#endif
128	* above).	130		* above).
129	* @param height The requested preview height (see the note on scaling	131		* @param height The requested preview height (see the note on scaling
130	* above).	132		* above).
131	* @param img The QImage to store the preview in.	133		* @param img The QImage to store the preview in.
132	*	134		*
133	* @return @c true if a preview was successfully generated and store in @p	135		* @return @c true if a preview was successfully generated and store in @p
134	* img, @c false otherwise.	136		* img, @c false otherwise.
135	*/	137		*/
136	virtual bool create(const QString &path, int width, int height, QImage &img) = 0; // KF6 TODO: turn first arg into QUrl (see thumbnail/htmlcreator.cpp)	138		virtual bool create(const QString &path, int width, int height, QImage &img) = 0; // KF6 TODO: turn first arg into QUrl (see thumbnail/htmlcreator.cpp)
			broulikUnsubmitted Done You can't do that broulik: You can't do that
137		139
138	/**	140		/**
139	* Returns the flags for this plugin.	141		* Returns the flags for this plugin.
140	*	142		*
141	* @return XOR'd flags values.	143		* @return XOR'd flags values.
142	* @see Flags	144		* @see Flags
143	*/	145		*/
144	virtual Flags flags() const;	146		virtual Flags flags() const;
Show All 27 Lines
172		174
173	#if KIOWIDGETS_ENABLE_DEPRECATED_SINCE(5, 0)	175		#if KIOWIDGETS_ENABLE_DEPRECATED_SINCE(5, 0)
174	/**	176		/**
175	* @class ThumbCreatorV2 thumbcreator.h <KIO/ThumbCreator>	177		* @class ThumbCreatorV2 thumbcreator.h <KIO/ThumbCreator>
176	* @since 4.7	178		* @since 4.7
177	* @deprecated since 5.0, use ThumbCreator	179		* @deprecated since 5.0, use ThumbCreator
178	*/	180		*/
179	class KIOWIDGETS_DEPRECATED_VERSION(5, 0, "Use ThumbCreator")	181		class KIOWIDGETS_DEPRECATED_VERSION(5, 0, "Use ThumbCreator")
180	KIOWIDGETS_EXPORT ThumbCreatorV2 : public ThumbCreator	182		KIOWIDGETS_EXPORT ThumbCreatorV2 : public ThumbCreator
			dfaureUnsubmitted Done You need to do like we once did: define an interface that inherits from ThumbCreator. Call it V3.... In the job, use dynamic_cast to test whether the object provided by the kioslave supports the V3 interface or not. dfaure: You need to do like we once did: define an interface that inherits from ThumbCreator. Call it…
			mevenAuthorUnsubmitted Done I guess you mean in the thumbnail kio regarding instantiating Thumbcreator. Anyway it works locally. meven: I guess you mean in the thumbnail kio regarding instantiating Thumbcreator. Anyway it works…
181	{	183		{
182	public:	184		public:
183	virtual ~ThumbCreatorV2();	185		virtual ~ThumbCreatorV2();
184	};	186		};
185	#endif	187		#endif
186		188
		189		/**
		190		* @class ThumbCreatorV3 thumbcreator.h <KIO/ThumbCreator>
		191		* @since 5.71
			dfaureUnsubmitted Done 5.70 is tagged already dfaure: 5.70 is tagged already
			mevenAuthorUnsubmitted Not Done update meven: update
		192		*/
		193		class KIOWIDGETS_EXPORT ThumbCreatorV3 : public ThumbCreator
		194		{
		195		public:
		196		// TODO KF6 merge ThumbCreatorV3 to ThumbCreator
		197		virtual ~ThumbCreatorV3();
		198
		199		bool create(const QString &path, int width, int height, QImage &img) override;
		200
		201		/**
		202		* Creates a thumbnail.
		203		*
		204		* Note that this method should not do any scaling. The @p width and @p
		205		* height parameters are provided as hints for images that are generated
		206		* from non-image data (like text).
		207		*
		208		* @param path The path of the file to create a preview for. This is
		209		* always a local path.
		210		* @param width The requested preview width (see the note on scaling
		211		* above).
		212		* @param height The requested preview height (see the note on scaling
		213		* above).
		214		* @param img The QImage to store the preview in.
		215		* @param devicePixelRatio
			dfaureUnsubmitted Done docu? dfaure: docu?
			mevenAuthorUnsubmitted Not Done I wonder about moving qreal devicePixelRatio before img parameter meven: I wonder about moving qreal devicePixelRatio before img parameter
		216		*
		217		* @return @c true if a preview was successfully generated and store in @p
		218		* img, @c false otherwise.
		219		*/
		220		virtual bool createV3(const QString &path, int width, int height, QImage &img, qreal devicePixelRatio = 1.0) = 0;
		221		};
		222
		223
187	// KF6 TODO: rename this to something less generic	224		// KF6 TODO: rename this to something less generic
188	typedef ThumbCreator (newCreator)();	225		typedef ThumbCreator (newCreator)();
189		226
190	#endif	227		#endif