KPixmapSequence

KPixmapSequence Class Reference

#include <KPixmapSequence>

Public Member Functions

 KPixmapSequence ()
 
 KPixmapSequence (const KPixmapSequence &other)
 
 KPixmapSequence (const QPixmap &pixmap, const QSize &frameSize=QSize())
 
 KPixmapSequence (const QString &fullPath, int size)
 
 ~KPixmapSequence ()
 
QPixmap frameAt (int index) const
 
int frameCount () const
 
QSize frameSize () const
 
bool isEmpty () const
 
bool isValid () const
 
KPixmapSequenceoperator= (const KPixmapSequence &other)
 

Detailed Description

Loads and gives access to the frames of a typical multi-row pixmap as often used for spinners.

KPixmapSequence is implicitly shared. Copying is fast.

Author
Aurélien Gâteau agate[email protected][email protected][email protected]de.or[email protected]g
Sebastian Trueg trueg[email protected]@kde[email protected].org
Since
4.4

Definition at line 31 of file kpixmapsequence.h.

Constructor & Destructor Documentation

KPixmapSequence::KPixmapSequence ( )

Create an empty sequence.

Definition at line 53 of file kpixmapsequence.cpp.

KPixmapSequence::KPixmapSequence ( const KPixmapSequence other)

Copy constructor.

Definition at line 58 of file kpixmapsequence.cpp.

KPixmapSequence::KPixmapSequence ( const QPixmap pixmap,
const QSize frameSize = QSize() 
)
explicit

Create a sequence from a pixmap.

Parameters
pixmapPixmap to load
frameSizeThe size of the frames to load. The width of the file has to be a multiple of the frame width; the same is true for the height. If an invalid size is specified the file is considered to be one column of square frames.

Definition at line 63 of file kpixmapsequence.cpp.

KPixmapSequence::KPixmapSequence ( const QString fullPath,
int  size 
)

Create a sequence from an icon name.

Parameters
fullPathThe full path of the icon
sizeThe icon/frame size

Definition at line 69 of file kpixmapsequence.cpp.

KPixmapSequence::~KPixmapSequence ( )

Destructor.

Definition at line 75 of file kpixmapsequence.cpp.

Member Function Documentation

QPixmap KPixmapSequence::frameAt ( int  index) const

Retrieve the frame at index.

Parameters
indexThe index of the frame in question starting at 0.

Definition at line 109 of file kpixmapsequence.cpp.

int KPixmapSequence::frameCount ( ) const

The number of frames in this sequence.

Definition at line 104 of file kpixmapsequence.cpp.

QSize KPixmapSequence::frameSize ( ) const
Returns
The size of an individual frame in the sequence.

Definition at line 95 of file kpixmapsequence.cpp.

bool KPixmapSequence::isEmpty ( ) const
Returns
true if no sequence was loaded successfully.
See also
isValid

Definition at line 90 of file kpixmapsequence.cpp.

bool KPixmapSequence::isValid ( ) const
Returns
true if a sequence was loaded successfully.
See also
isEmpty

Definition at line 85 of file kpixmapsequence.cpp.

KPixmapSequence & KPixmapSequence::operator= ( const KPixmapSequence other)

Create a copy of other.

The data is implicitly shared.

Definition at line 79 of file kpixmapsequence.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Sat Sep 19 2020 22:44:05 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.