GraphicDescriptor Class Reference

#include <graphicfilter.hxx>

Collaboration diagram for GraphicDescriptor:

Public Member Functions
	GraphicDescriptor (const INetURLObject &rPath)
	Ctor to set a filename. More...
	GraphicDescriptor (SvStream &rInStream, const OUString *pPath)
	Ctor using a stream. More...
	~GraphicDescriptor ()
bool	Detect (bool bExtendedInfo=false)
	starts the detection More...
GraphicFileFormat	GetFileFormat () const
const Size &	GetSizePixel () const
const Size &	GetSize_100TH_MM () const
std::optional< Size >	GetPreferredLogSize () const
	Returns the logic size, according to the map mode available via GetPreferredMapMode(). More...
std::optional< MapMode >	GetPreferredMapMode () const
	If available, this returns the map mode the graphic prefers, which may be other than pixel or 100th mm. More...
sal_uInt16	GetBitsPerPixel () const
sal_uInt8	GetNumberOfImageComponents () const
bool	IsTransparent () const
bool	IsAlpha () const

Static Public Member Functions
static OUString	GetImportFormatShortName (GraphicFileFormat nFormat)

Private Member Functions
void	ImpConstruct ()
bool	ImpDetectBMP (SvStream &rStm, bool bExtendedInfo)
bool	ImpDetectGIF (SvStream &rStm, bool bExtendedInfo)
bool	ImpDetectJPG (SvStream &rStm, bool bExtendedInfo)
bool	ImpDetectPCD (SvStream &rStm, bool bExtendedInfo)
bool	ImpDetectPCX (SvStream &rStm)
bool	ImpDetectPNG (SvStream &rStm, bool bExtendedInfo)
bool	ImpDetectTIF (SvStream &rStm, bool bExtendedInfo)
bool	ImpDetectXBM (SvStream &rStm, bool bExtendedInfo)
bool	ImpDetectXPM (SvStream &rStm, bool bExtendedInfo)
bool	ImpDetectPBM (SvStream &rStm, bool bExtendedInfo)
bool	ImpDetectPGM (SvStream &rStm, bool bExtendedInfo)
bool	ImpDetectPPM (SvStream &rStm, bool bExtendedInfo)
bool	ImpDetectRAS (SvStream &rStm, bool bExtendedInfo)
bool	ImpDetectTGA (SvStream &rStm, bool bExtendedInfo)
bool	ImpDetectPSD (SvStream &rStm, bool bExtendedInfo)
bool	ImpDetectEPS (SvStream &rStm, bool bExtendedInfo)
bool	ImpDetectDXF (SvStream &rStm, bool bExtendedInfo)
bool	ImpDetectMET (SvStream &rStm, bool bExtendedInfo)
bool	ImpDetectPCT (SvStream &rStm, bool bExtendedInfo)
bool	ImpDetectSVM (SvStream &rStm, bool bExtendedInfo)
bool	ImpDetectWMF (SvStream &rStm, bool bExtendedInfo)
bool	ImpDetectEMF (SvStream &rStm, bool bExtendedInfo)
bool	ImpDetectSVG (SvStream &rStm, bool bExtendedInfo)
	GraphicDescriptor (const GraphicDescriptor &)=delete
GraphicDescriptor &	operator= (const GraphicDescriptor &)=delete

Private Attributes
SvStream *	pFileStm
OUString	aPathExt
Size	aPixSize
Size	aLogSize
std::optional< Size >	maPreferredLogSize
std::optional< MapMode >	maPreferredMapMode
sal_uInt16	nBitsPerPixel
sal_uInt16	nPlanes
GraphicFileFormat	nFormat
bool	bOwnStream
sal_uInt8	mnNumberOfImageComponents
bool	bIsTransparent
bool	bIsAlpha

Detailed Description

Definition at line 152 of file graphicfilter.hxx.

Constructor & Destructor Documentation

GraphicDescriptor::GraphicDescriptor ( const GraphicDescriptor &  )

privatedelete

GraphicDescriptor::GraphicDescriptor

(

const INetURLObject &

rPath

)

Ctor to set a filename.

Detect() must be called to identify the file If the file has no unique header (Mtf's), the format is determined from the extension

Definition at line 32 of file graphicfilter2.cxx.

References CreateStream(), ImpConstruct(), NONE, and READ.

GraphicDescriptor::GraphicDescriptor	(	SvStream &	rInStream,
		const OUString *	pPath
	)

Ctor using a stream.

Detect() must be called to identify the file As some formats (Mtf's) do not have a unique header, it makes sense to supply the file name (incl. ext.), so that the format can be derived from the extension

Definition at line 40 of file graphicfilter2.cxx.

References aPathExt, aURL, INetURLObject::GetFileExtension(), and ImpConstruct().

GraphicDescriptor::~GraphicDescriptor

(

)

Definition at line 53 of file graphicfilter2.cxx.

References bOwnStream, and pFileStm.

Member Function Documentation

bool GraphicDescriptor::Detect

(

bool

bExtendedInfo = false

)

starts the detection

if bExtendedInfo == true the file header is used to derive as many properties as possible (size, color, etc.)

Definition at line 59 of file graphicfilter2.cxx.

References SvStream::GetEndian(), SvStream::GetError(), ImpDetectBMP(), ImpDetectDXF(), ImpDetectEMF(), ImpDetectEPS(), ImpDetectGIF(), ImpDetectJPG(), ImpDetectMET(), ImpDetectPBM(), ImpDetectPCD(), ImpDetectPCT(), ImpDetectPCX(), ImpDetectPGM(), ImpDetectPNG(), ImpDetectPPM(), ImpDetectPSD(), ImpDetectRAS(), ImpDetectSVG(), ImpDetectSVM(), ImpDetectTGA(), ImpDetectTIF(), ImpDetectWMF(), ImpDetectXBM(), ImpDetectXPM(), pFileStm, and SvStream::SetEndian().

Referenced by ImpGraphic::setPrepared().

sal_uInt16 GraphicDescriptor::GetBitsPerPixel ( ) const

inline

Returns

bits/pixel or 0

Definition at line 244 of file graphicfilter.hxx.

GraphicFileFormat GraphicDescriptor::GetFileFormat ( ) const

inline

Returns

the file format, GraphicFileFormat::NOT if no format was recognized

Definition at line 223 of file graphicfilter.hxx.

OUString GraphicDescriptor::GetImportFormatShortName ( GraphicFileFormat  nFormat )

static

Returns

filter number that is needed by the GraphFilter to read this format

Definition at line 1145 of file graphicfilter2.cxx.

References BMP, DXF, EMF, EPS, GIF, JPG, MET, PBM, PCD, PCT, PCX, PGM, PNG, PPM, PSD, RAS, SVG, SVM, TGA, TIF, WMF, XBM, and XPM.

sal_uInt8 GraphicDescriptor::GetNumberOfImageComponents ( ) const

inline

Returns

number of color channels

Definition at line 247 of file graphicfilter.hxx.

std::optional<Size> GraphicDescriptor::GetPreferredLogSize ( ) const

inline

Returns the logic size, according to the map mode available via GetPreferredMapMode().

Prefer this size over GetSize_100TH_MM().

Definition at line 235 of file graphicfilter.hxx.

Referenced by ImpGraphic::setPrepared().

std::optional<MapMode> GraphicDescriptor::GetPreferredMapMode ( ) const

inline

If available, this returns the map mode the graphic prefers, which may be other than pixel or 100th mm.

Prefer this map mode over just assuming MapUnit::Map100thMM.

Definition at line 241 of file graphicfilter.hxx.

Referenced by ImpGraphic::setPrepared().

const Size& GraphicDescriptor::GetSize_100TH_MM ( ) const

inline

Returns

the logical graphic size in 1/100mm or 0 size

Definition at line 229 of file graphicfilter.hxx.

Referenced by ImpGraphic::setPrepared().

const Size& GraphicDescriptor::GetSizePixel ( ) const

inline

Returns

graphic size in pixels or 0 size

Definition at line 226 of file graphicfilter.hxx.

Referenced by ImpGraphic::setPrepared().

void GraphicDescriptor::ImpConstruct ( )

private

Definition at line 96 of file graphicfilter2.cxx.

References bIsAlpha, bIsTransparent, mnNumberOfImageComponents, nBitsPerPixel, nFormat, NOT, and nPlanes.

Referenced by GraphicDescriptor().

bool GraphicDescriptor::ImpDetectBMP ( SvStream &  rStm, bool  bExtendedInfo  )

private

Definition at line 106 of file graphicfilter2.cxx.

References aLogSize, aPixSize, BMP, Size::getHeight(), Size::getWidth(), Size::Height(), maPreferredLogSize, maPreferredMapMode, nBitsPerPixel, nFormat, NOT, nPlanes, Point, SvStream::ReadUInt16(), SvStream::ReadUInt32(), SvStream::Seek(), SvStream::SeekRel(), SvStream::SetEndian(), Size::setHeight(), Size::setWidth(), SvStream::Tell(), and Size::Width().

Referenced by Detect().

bool GraphicDescriptor::ImpDetectDXF ( SvStream &  rStm, bool  bExtendedInfo  )

private

Definition at line 964 of file graphicfilter2.cxx.

References aPathExt, DXF, and nFormat.

Referenced by Detect().

bool GraphicDescriptor::ImpDetectEMF ( SvStream &  rStm, bool  bExtendedInfo  )

private

Definition at line 1087 of file graphicfilter2.cxx.

References aLogSize, aPixSize, EMF, nFormat, SvStream::ReadInt32(), SvStream::ReadUInt32(), SvStream::Seek(), SvStream::SetEndian(), Size::setHeight(), Size::setWidth(), and SvStream::Tell().

Referenced by Detect().

bool GraphicDescriptor::ImpDetectEPS ( SvStream &  rStm, bool  bExtendedInfo  )

private

Definition at line 940 of file graphicfilter2.cxx.

References aPathExt, EPS, ImplSearchEntry(), nFormat, SvStream::ReadBytes(), SvStream::ReadUInt32(), SvStream::Seek(), SvStream::SeekRel(), SvStream::SetEndian(), and SvStream::Tell().

Referenced by Detect().

bool GraphicDescriptor::ImpDetectGIF ( SvStream &  rStm, bool  bExtendedInfo  )

private

Definition at line 196 of file graphicfilter2.cxx.

References aPixSize, GIF, nBitsPerPixel, nFormat, SvStream::ReadUChar(), SvStream::ReadUInt16(), SvStream::ReadUInt32(), SvStream::Seek(), SvStream::SetEndian(), Size::setHeight(), Size::setWidth(), and SvStream::Tell().

Referenced by Detect().

bool GraphicDescriptor::ImpDetectJPG ( SvStream &  rStm, bool  bExtendedInfo  )

private

Definition at line 263 of file graphicfilter2.cxx.

References aLogSize, aMap, aPixSize, SvStream::GetError(), MapMode::GetMapUnit(), SvStream::good(), ImpDetectJPG_GetNextMarker(), JPG, OutputDevice::LogicToLogic(), mnNumberOfImageComponents, nBitsPerPixel, nFormat, nLength, nPlanes, SvStream::ReadInt32(), SvStream::ReadUChar(), SvStream::ReadUInt16(), SvStream::ReadUInt32(), SvStream::Seek(), SvStream::SeekRel(), SvStream::SetEndian(), SvStream::SetError(), Size::setHeight(), MapMode::SetMapUnit(), MapMode::SetScaleX(), MapMode::SetScaleY(), Size::setWidth(), and SvStream::Tell().

Referenced by Detect().

bool GraphicDescriptor::ImpDetectMET ( SvStream &  rStm, bool  bExtendedInfo  )

private

Definition at line 973 of file graphicfilter2.cxx.

References aPathExt, MET, and nFormat.

Referenced by Detect().

bool GraphicDescriptor::ImpDetectPBM ( SvStream &  rStm, bool  bExtendedInfo  )

private

Definition at line 794 of file graphicfilter2.cxx.

References aPathExt, nFormat, PBM, SvStream::ReadUChar(), SvStream::Seek(), and SvStream::Tell().

Referenced by Detect().

bool GraphicDescriptor::ImpDetectPCD ( SvStream &  rStm, bool  bExtendedInfo  )

private

Definition at line 430 of file graphicfilter2.cxx.

References nFormat, PCD, SvStream::ReadUChar(), SvStream::ReadUInt16(), SvStream::ReadUInt32(), SvStream::Seek(), SvStream::SeekRel(), SvStream::SetEndian(), and SvStream::Tell().

Referenced by Detect().

bool GraphicDescriptor::ImpDetectPCT ( SvStream &  rStm, bool  bExtendedInfo  )

private

Definition at line 982 of file graphicfilter2.cxx.

References aPathExt, isPCT(), nFormat, PCT, SvStream::remainingSize(), SvStream::Seek(), and SvStream::Tell().

Referenced by Detect().

bool GraphicDescriptor::ImpDetectPCX ( SvStream &  rStm )

private

Definition at line 457 of file graphicfilter2.cxx.

References aLogSize, aMap, aPixSize, OutputDevice::LogicToLogic(), nBitsPerPixel, nFormat, nPlanes, PCX, Point, SvStream::ReadUChar(), SvStream::ReadUInt16(), SvStream::Seek(), SvStream::SeekRel(), SvStream::SetEndian(), Size::setHeight(), Size::setWidth(), and SvStream::Tell().

Referenced by Detect().

bool GraphicDescriptor::ImpDetectPGM ( SvStream &  rStm, bool  bExtendedInfo  )

private

Definition at line 817 of file graphicfilter2.cxx.

References aPathExt, nFormat, PGM, SvStream::ReadUChar(), SvStream::Seek(), and SvStream::Tell().

Referenced by Detect().

bool GraphicDescriptor::ImpDetectPNG ( SvStream &  rStm, bool  bExtendedInfo  )

private

Definition at line 534 of file graphicfilter2.cxx.

References aLogSize, aPixSize, bIsAlpha, bIsTransparent, SvStream::good(), Size::Height(), nBitsPerPixel, nFormat, nPlanes, PNG, SvStream::ReadUChar(), SvStream::ReadUInt32(), SvStream::Seek(), SvStream::SeekRel(), SvStream::SetEndian(), Size::setHeight(), Size::setWidth(), SvStream::Tell(), and Size::Width().

Referenced by Detect().

bool GraphicDescriptor::ImpDetectPPM ( SvStream &  rStm, bool  bExtendedInfo  )

private

Definition at line 839 of file graphicfilter2.cxx.

References aPathExt, nFormat, PPM, SvStream::ReadUChar(), SvStream::Seek(), and SvStream::Tell().

Referenced by Detect().

bool GraphicDescriptor::ImpDetectPSD ( SvStream &  rStm, bool  bExtendedInfo  )

private

Definition at line 886 of file graphicfilter2.cxx.

References aPixSize, nBitsPerPixel, nFormat, nVersion, PSD, SvStream::ReadUInt16(), SvStream::ReadUInt32(), SvStream::Seek(), SvStream::SeekRel(), SvStream::SetEndian(), Size::setHeight(), Size::setWidth(), and SvStream::Tell().

Referenced by Detect().

bool GraphicDescriptor::ImpDetectRAS ( SvStream &  rStm, bool  bExtendedInfo  )

private

Definition at line 861 of file graphicfilter2.cxx.

References nFormat, RAS, SvStream::ReadUInt32(), SvStream::Seek(), SvStream::SetEndian(), and SvStream::Tell().

Referenced by Detect().

bool GraphicDescriptor::ImpDetectSVG ( SvStream &  rStm, bool  bExtendedInfo  )

private

Definition at line 1136 of file graphicfilter2.cxx.

References aPathExt, nFormat, and SVG.

Referenced by Detect().

bool GraphicDescriptor::ImpDetectSVM ( SvStream &  rStm, bool  bExtendedInfo  )

private

Definition at line 1002 of file graphicfilter2.cxx.

References aLogSize, OutputDevice::LogicToLogic(), nFormat, TypeSerializer::readMapMode(), tools::GenericTypeSerializer::readSize(), SvStream::ReadUChar(), SvStream::ReadUInt16(), SvStream::ReadUInt32(), SvStream::Seek(), SvStream::SeekRel(), SvStream::SetEndian(), Size::setHeight(), Size::setWidth(), SVM, and SvStream::Tell().

Referenced by Detect().

bool GraphicDescriptor::ImpDetectTGA ( SvStream &  rStm, bool  bExtendedInfo  )

private

Definition at line 877 of file graphicfilter2.cxx.

References aPathExt, nFormat, and TGA.

Referenced by Detect().

bool GraphicDescriptor::ImpDetectTIF ( SvStream &  rStm, bool  bExtendedInfo  )

private

Definition at line 647 of file graphicfilter2.cxx.

References aPixSize, DATA_SIZE, nBitsPerPixel, nCount, nFormat, SvStream::ReadUChar(), SvStream::ReadUInt16(), SvStream::ReadUInt32(), SvStream::Seek(), SvStream::SeekRel(), SvStream::SetEndian(), Size::setHeight(), Size::setWidth(), SvStream::Tell(), and TIF.

Referenced by Detect().

bool GraphicDescriptor::ImpDetectWMF ( SvStream &  rStm, bool  bExtendedInfo  )

private

Definition at line 1078 of file graphicfilter2.cxx.

References aPathExt, nFormat, and WMF.

Referenced by Detect().

bool GraphicDescriptor::ImpDetectXBM ( SvStream &  rStm, bool  bExtendedInfo  )

private

Definition at line 776 of file graphicfilter2.cxx.

References aPathExt, nFormat, and XBM.

Referenced by Detect().

bool GraphicDescriptor::ImpDetectXPM ( SvStream &  rStm, bool  bExtendedInfo  )

private

Definition at line 785 of file graphicfilter2.cxx.

References aPathExt, nFormat, and XPM.

Referenced by Detect().

bool GraphicDescriptor::IsAlpha ( ) const

inline

Returns

whether image supports alpha values for translucent colours

Definition at line 253 of file graphicfilter.hxx.

Referenced by ImpGraphic::setPrepared().

bool GraphicDescriptor::IsTransparent ( ) const

inline

Returns

whether image supports transparency

Definition at line 250 of file graphicfilter.hxx.

Referenced by ImpGraphic::setPrepared().

GraphicDescriptor& GraphicDescriptor::operator= ( const GraphicDescriptor &  )

privatedelete

Member Data Documentation

Size GraphicDescriptor::aLogSize

private

Definition at line 158 of file graphicfilter.hxx.

Referenced by ImpDetectBMP(), ImpDetectEMF(), ImpDetectJPG(), ImpDetectPCX(), ImpDetectPNG(), and ImpDetectSVM().

OUString GraphicDescriptor::aPathExt

private

Definition at line 156 of file graphicfilter.hxx.

Referenced by GraphicDescriptor(), ImpDetectDXF(), ImpDetectEPS(), ImpDetectMET(), ImpDetectPBM(), ImpDetectPCT(), ImpDetectPGM(), ImpDetectPPM(), ImpDetectSVG(), ImpDetectTGA(), ImpDetectWMF(), ImpDetectXBM(), and ImpDetectXPM().

Size GraphicDescriptor::aPixSize

private

Definition at line 157 of file graphicfilter.hxx.

Referenced by ImpDetectBMP(), ImpDetectEMF(), ImpDetectGIF(), ImpDetectJPG(), ImpDetectPCX(), ImpDetectPNG(), ImpDetectPSD(), and ImpDetectTIF().

bool GraphicDescriptor::bIsAlpha

private

Definition at line 167 of file graphicfilter.hxx.

Referenced by ImpConstruct(), and ImpDetectPNG().

bool GraphicDescriptor::bIsTransparent

private

Definition at line 166 of file graphicfilter.hxx.

Referenced by ImpConstruct(), and ImpDetectPNG().

bool GraphicDescriptor::bOwnStream

private

Definition at line 164 of file graphicfilter.hxx.

Referenced by ~GraphicDescriptor().

std::optional<Size> GraphicDescriptor::maPreferredLogSize

private

Definition at line 159 of file graphicfilter.hxx.

Referenced by ImpDetectBMP().

std::optional<MapMode> GraphicDescriptor::maPreferredMapMode

private

Definition at line 160 of file graphicfilter.hxx.

Referenced by ImpDetectBMP().

sal_uInt8 GraphicDescriptor::mnNumberOfImageComponents

private

Definition at line 165 of file graphicfilter.hxx.

Referenced by ImpConstruct(), and ImpDetectJPG().

sal_uInt16 GraphicDescriptor::nBitsPerPixel

private

Definition at line 161 of file graphicfilter.hxx.

Referenced by ImpConstruct(), ImpDetectBMP(), ImpDetectGIF(), ImpDetectJPG(), ImpDetectPCX(), ImpDetectPNG(), ImpDetectPSD(), and ImpDetectTIF().

GraphicFileFormat GraphicDescriptor::nFormat

private

Definition at line 163 of file graphicfilter.hxx.

Referenced by ImpConstruct(), ImpDetectBMP(), ImpDetectDXF(), ImpDetectEMF(), ImpDetectEPS(), ImpDetectGIF(), ImpDetectJPG(), ImpDetectMET(), ImpDetectPBM(), ImpDetectPCD(), ImpDetectPCT(), ImpDetectPCX(), ImpDetectPGM(), ImpDetectPNG(), ImpDetectPPM(), ImpDetectPSD(), ImpDetectRAS(), ImpDetectSVG(), ImpDetectSVM(), ImpDetectTGA(), ImpDetectTIF(), ImpDetectWMF(), ImpDetectXBM(), and ImpDetectXPM().

sal_uInt16 GraphicDescriptor::nPlanes

private

Definition at line 162 of file graphicfilter.hxx.

Referenced by ImpConstruct(), ImpDetectBMP(), ImpDetectJPG(), ImpDetectPCX(), and ImpDetectPNG().

SvStream* GraphicDescriptor::pFileStm

private

Definition at line 154 of file graphicfilter.hxx.

Referenced by Detect(), and ~GraphicDescriptor().

---

The documentation for this class was generated from the following files:

• graphicfilter.hxx
• graphicfilter2.cxx