LibreOffice Module vcl (master) 1
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
GraphicDescriptor Class Referencefinal

#include <graphicfilter.hxx>

Collaboration diagram for GraphicDescriptor:
[legend]

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
 
const std::optional< Size > & GetPreferredLogSize () const
 Returns the logic size, according to the map mode available via GetPreferredMapMode(). More...
 
const 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 ImpDetectWEBP (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
 
GraphicMetadata aMetadata
 
bool bOwnStream
 

Detailed Description

Definition at line 129 of file graphicfilter.hxx.

Constructor & Destructor Documentation

◆ GraphicDescriptor() [1/3]

GraphicDescriptor::GraphicDescriptor ( const GraphicDescriptor &  )
privatedelete

◆ GraphicDescriptor() [2/3]

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 30 of file graphicfilter2.cxx.

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

◆ GraphicDescriptor() [3/3]

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 38 of file graphicfilter2.cxx.

References aPathExt, aURL, and ImpConstruct().

◆ ~GraphicDescriptor()

GraphicDescriptor::~GraphicDescriptor ( )

Definition at line 51 of file graphicfilter2.cxx.

References bOwnStream, and pFileStm.

Member Function Documentation

◆ Detect()

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 57 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(), ImpDetectWEBP(), ImpDetectWMF(), ImpDetectXBM(), ImpDetectXPM(), pFileStm, and SvStream::SetEndian().

Referenced by vcl::PDFExtOutDevData::HasAdequateCompression(), unographic::GraphicDescriptor::implCreate(), and ImpGraphic::setPrepared().

◆ GetBitsPerPixel()

sal_uInt16 GraphicDescriptor::GetBitsPerPixel ( ) const
inline
Returns
bits/pixel or 0

Definition at line 212 of file graphicfilter.hxx.

References GraphicMetadata::mnBitsPerPixel.

Referenced by unographic::GraphicDescriptor::implCreate().

◆ GetFileFormat()

GraphicFileFormat GraphicDescriptor::GetFileFormat ( ) const
inline
Returns
the file format, GraphicFileFormat::NOT if no format was recognized

Definition at line 191 of file graphicfilter.hxx.

References GraphicMetadata::mnFormat.

Referenced by unographic::GraphicDescriptor::implCreate().

◆ GetImportFormatShortName()

OUString GraphicDescriptor::GetImportFormatShortName ( GraphicFileFormat  nFormat)
static
Returns
filter number that is needed by the GraphFilter to read this format

Definition at line 505 of file graphicfilter2.cxx.

References vcl::getImportFormatShortName().

◆ GetNumberOfImageComponents()

sal_uInt8 GraphicDescriptor::GetNumberOfImageComponents ( ) const
inline
Returns
number of color channels

Definition at line 215 of file graphicfilter.hxx.

References GraphicMetadata::mnNumberOfImageComponents.

Referenced by vcl::PDFExtOutDevData::HasAdequateCompression().

◆ GetPreferredLogSize()

const 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 203 of file graphicfilter.hxx.

References GraphicMetadata::maPreferredLogSize.

Referenced by ImpGraphic::setPrepared().

◆ GetPreferredMapMode()

const 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 209 of file graphicfilter.hxx.

References GraphicMetadata::maPreferredMapMode.

Referenced by ImpGraphic::setPrepared().

◆ GetSize_100TH_MM()

const Size & GraphicDescriptor::GetSize_100TH_MM ( ) const
inline
Returns
the logical graphic size in 1/100mm or 0 size

Definition at line 197 of file graphicfilter.hxx.

References GraphicMetadata::maLogSize.

Referenced by unographic::GraphicDescriptor::implCreate(), and ImpGraphic::setPrepared().

◆ GetSizePixel()

const Size & GraphicDescriptor::GetSizePixel ( ) const
inline
Returns
graphic size in pixels or 0 size

Definition at line 194 of file graphicfilter.hxx.

References GraphicMetadata::maPixSize.

Referenced by unographic::GraphicDescriptor::implCreate(), and ImpGraphic::setPrepared().

◆ ImpConstruct()

void GraphicDescriptor::ImpConstruct ( )
private

Definition at line 95 of file graphicfilter2.cxx.

References aMetadata, GraphicMetadata::mbIsAlpha, GraphicMetadata::mbIsTransparent, GraphicMetadata::mnBitsPerPixel, GraphicMetadata::mnFormat, GraphicMetadata::mnNumberOfImageComponents, GraphicMetadata::mnPlanes, and NOT.

Referenced by GraphicDescriptor().

◆ ImpDetectBMP()

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

Definition at line 105 of file graphicfilter2.cxx.

References aMetadata, aPathExt, vcl::GraphicFormatDetector::checkBMP(), vcl::GraphicFormatDetector::detect(), and vcl::GraphicFormatDetector::getMetadata().

Referenced by Detect().

◆ ImpDetectDXF()

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

Definition at line 433 of file graphicfilter2.cxx.

References aMetadata, aPathExt, vcl::GraphicFormatDetector::checkDXF(), vcl::GraphicFormatDetector::detect(), and vcl::GraphicFormatDetector::getMetadata().

Referenced by Detect().

◆ ImpDetectEMF()

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

Definition at line 478 of file graphicfilter2.cxx.

References aMetadata, aPathExt, vcl::GraphicFormatDetector::checkEMF(), vcl::GraphicFormatDetector::detect(), and vcl::GraphicFormatDetector::getMetadata().

Referenced by Detect().

◆ ImpDetectEPS()

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

Definition at line 424 of file graphicfilter2.cxx.

References aMetadata, aPathExt, vcl::GraphicFormatDetector::checkEPS(), vcl::GraphicFormatDetector::detect(), and vcl::GraphicFormatDetector::getMetadata().

Referenced by Detect().

◆ ImpDetectGIF()

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

Definition at line 114 of file graphicfilter2.cxx.

References aMetadata, aPathExt, vcl::GraphicFormatDetector::checkGIF(), vcl::GraphicFormatDetector::detect(), and vcl::GraphicFormatDetector::getMetadata().

Referenced by Detect().

◆ ImpDetectJPG()

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

Definition at line 149 of file graphicfilter2.cxx.

References aMap, aMetadata, SvStream::GetError(), SvStream::good(), ImpDetectJPG_GetNextMarker(), JPG, OutputDevice::LogicToLogic(), GraphicMetadata::maLogSize, GraphicMetadata::maPixSize, GraphicMetadata::mnBitsPerPixel, GraphicMetadata::mnFormat, GraphicMetadata::mnNumberOfImageComponents, GraphicMetadata::mnPlanes, nLength, SvStream::ReadInt32(), SvStream::ReadUChar(), SvStream::ReadUInt16(), SvStream::ReadUInt32(), SvStream::Seek(), SvStream::SeekRel(), SvStream::SetEndian(), SvStream::SetError(), Size::setHeight(), Size::setWidth(), and SvStream::Tell().

Referenced by Detect().

◆ ImpDetectMET()

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

Definition at line 442 of file graphicfilter2.cxx.

References aMetadata, aPathExt, vcl::GraphicFormatDetector::checkMET(), vcl::GraphicFormatDetector::detect(), and vcl::GraphicFormatDetector::getMetadata().

Referenced by Detect().

◆ ImpDetectPBM()

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

Definition at line 370 of file graphicfilter2.cxx.

References aMetadata, aPathExt, vcl::GraphicFormatDetector::checkPBM(), vcl::GraphicFormatDetector::detect(), and vcl::GraphicFormatDetector::getMetadata().

Referenced by Detect().

◆ ImpDetectPCD()

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

Definition at line 316 of file graphicfilter2.cxx.

References aMetadata, aPathExt, vcl::GraphicFormatDetector::checkPCD(), vcl::GraphicFormatDetector::detect(), and vcl::GraphicFormatDetector::getMetadata().

Referenced by Detect().

◆ ImpDetectPCT()

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

Definition at line 451 of file graphicfilter2.cxx.

References aMetadata, aPathExt, vcl::GraphicFormatDetector::checkPCT(), vcl::GraphicFormatDetector::detect(), and vcl::GraphicFormatDetector::getMetadata().

Referenced by Detect().

◆ ImpDetectPCX()

bool GraphicDescriptor::ImpDetectPCX ( SvStream &  rStm)
private

Definition at line 325 of file graphicfilter2.cxx.

References aMetadata, aPathExt, vcl::GraphicFormatDetector::checkPCX(), vcl::GraphicFormatDetector::detect(), and vcl::GraphicFormatDetector::getMetadata().

Referenced by Detect().

◆ ImpDetectPGM()

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

Definition at line 379 of file graphicfilter2.cxx.

References aMetadata, aPathExt, vcl::GraphicFormatDetector::checkPGM(), vcl::GraphicFormatDetector::detect(), and vcl::GraphicFormatDetector::getMetadata().

Referenced by Detect().

◆ ImpDetectPNG()

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

Definition at line 334 of file graphicfilter2.cxx.

References aMetadata, aPathExt, vcl::GraphicFormatDetector::checkPNG(), vcl::GraphicFormatDetector::detect(), and vcl::GraphicFormatDetector::getMetadata().

Referenced by Detect().

◆ ImpDetectPPM()

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

Definition at line 388 of file graphicfilter2.cxx.

References aMetadata, aPathExt, vcl::GraphicFormatDetector::checkPPM(), vcl::GraphicFormatDetector::detect(), and vcl::GraphicFormatDetector::getMetadata().

Referenced by Detect().

◆ ImpDetectPSD()

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

Definition at line 415 of file graphicfilter2.cxx.

References aMetadata, aPathExt, vcl::GraphicFormatDetector::checkPSD(), vcl::GraphicFormatDetector::detect(), and vcl::GraphicFormatDetector::getMetadata().

Referenced by Detect().

◆ ImpDetectRAS()

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

Definition at line 397 of file graphicfilter2.cxx.

References aMetadata, aPathExt, vcl::GraphicFormatDetector::checkRAS(), vcl::GraphicFormatDetector::detect(), and vcl::GraphicFormatDetector::getMetadata().

Referenced by Detect().

◆ ImpDetectSVG()

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

Definition at line 487 of file graphicfilter2.cxx.

References aMetadata, aPathExt, vcl::GraphicFormatDetector::checkSVG(), vcl::GraphicFormatDetector::detect(), and vcl::GraphicFormatDetector::getMetadata().

Referenced by Detect().

◆ ImpDetectSVM()

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

Definition at line 460 of file graphicfilter2.cxx.

References aMetadata, aPathExt, vcl::GraphicFormatDetector::checkSVM(), vcl::GraphicFormatDetector::detect(), and vcl::GraphicFormatDetector::getMetadata().

Referenced by Detect().

◆ ImpDetectTGA()

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

Definition at line 406 of file graphicfilter2.cxx.

References aMetadata, aPathExt, vcl::GraphicFormatDetector::checkTGA(), vcl::GraphicFormatDetector::detect(), and vcl::GraphicFormatDetector::getMetadata().

Referenced by Detect().

◆ ImpDetectTIF()

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

Definition at line 343 of file graphicfilter2.cxx.

References aMetadata, aPathExt, vcl::GraphicFormatDetector::checkTIF(), vcl::GraphicFormatDetector::detect(), and vcl::GraphicFormatDetector::getMetadata().

Referenced by Detect().

◆ ImpDetectWEBP()

bool GraphicDescriptor::ImpDetectWEBP ( SvStream &  rStm,
bool  bExtendedInfo 
)
private

Definition at line 496 of file graphicfilter2.cxx.

References aMetadata, aPathExt, vcl::GraphicFormatDetector::checkWEBP(), vcl::GraphicFormatDetector::detect(), and vcl::GraphicFormatDetector::getMetadata().

Referenced by Detect().

◆ ImpDetectWMF()

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

Definition at line 469 of file graphicfilter2.cxx.

References aMetadata, aPathExt, vcl::GraphicFormatDetector::checkWMF(), vcl::GraphicFormatDetector::detect(), and vcl::GraphicFormatDetector::getMetadata().

Referenced by Detect().

◆ ImpDetectXBM()

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

Definition at line 352 of file graphicfilter2.cxx.

References aMetadata, aPathExt, vcl::GraphicFormatDetector::checkXBM(), vcl::GraphicFormatDetector::detect(), and vcl::GraphicFormatDetector::getMetadata().

Referenced by Detect().

◆ ImpDetectXPM()

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

Definition at line 361 of file graphicfilter2.cxx.

References aMetadata, aPathExt, vcl::GraphicFormatDetector::checkXPM(), vcl::GraphicFormatDetector::detect(), and vcl::GraphicFormatDetector::getMetadata().

Referenced by Detect().

◆ IsAlpha()

bool GraphicDescriptor::IsAlpha ( ) const
inline
Returns
whether image supports alpha values for translucent colours

Definition at line 221 of file graphicfilter.hxx.

References GraphicMetadata::mbIsAlpha.

Referenced by ImpGraphic::setPrepared().

◆ IsTransparent()

bool GraphicDescriptor::IsTransparent ( ) const
inline
Returns
whether image supports transparency

Definition at line 218 of file graphicfilter.hxx.

References GraphicMetadata::mbIsTransparent.

Referenced by ImpGraphic::setPrepared().

◆ operator=()

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

References Detect.

Member Data Documentation

◆ aMetadata

GraphicMetadata GraphicDescriptor::aMetadata
private

Definition at line 133 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(), ImpDetectWEBP(), ImpDetectWMF(), ImpDetectXBM(), and ImpDetectXPM().

◆ aPathExt

OUString GraphicDescriptor::aPathExt
private

Definition at line 132 of file graphicfilter.hxx.

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

◆ bOwnStream

bool GraphicDescriptor::bOwnStream
private

Definition at line 134 of file graphicfilter.hxx.

Referenced by ~GraphicDescriptor().

◆ pFileStm

SvStream* GraphicDescriptor::pFileStm
private

Definition at line 131 of file graphicfilter.hxx.

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

The documentation for this class was generated from the following files:
Generated on Sun Jul 30 2023 04:36:17 for LibreOffice Module vcl (master) by doxygen 1.9.3