|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.trolltech.qt.QSignalEmitter
com.trolltech.qt.QtJambiObject
com.trolltech.qt.gui.QIcon
public class QIcon
The QIcon
class provides scalable icons in different modes and states. A QIcon
can generate smaller, larger, active, and disabled pixmaps from the set of pixmaps it is given. Such pixmaps are used by Qt widgets to show an icon representing a particular action.
The simplest use of QIcon
is to create one from a QPixmap
file or resource, and then use it, allowing Qt to work out all the required icon styles and sizes. For example:
QToolButton button = new QToolButton(); button.setIcon(new QIcon("open.xpm"));To undo a
QIcon
, simply set a null icon in its place: button.setIcon(null);Use the
QImageReader::supportedImageFormats()
and QImageWriter::supportedImageFormats()
functions to retrieve a complete list of the supported file formats. When you retrieve a pixmap using pixmap(QSize
, Mode, State), and no pixmap for this given size, mode and state has been added with addFile()
or addPixmap()
, then QIcon
will generate one on the fly. This pixmap generation happens in a QIconEngineV2
. The default engine scales pixmaps down if required, but never up, and it uses the current style to calculate a disabled appearance. By using custom icon engines, you can customize every aspect of generated icons. With QIconEnginePluginV2
it is possible to register different icon engines for different file suffixes, making it possible for third parties to provide additional icon engines to those included with Qt.
Note: Since Qt 4.2, an icon engine that supports SVG is included.Making Classes that Use QIcon
If you write your own widgets that have an option to set a small pixmap, consider allowing a QIcon
to be set for that pixmap. The Qt class QToolButton
is an example of such a widget.
Provide a method to set a QIcon
, and when you draw the icon, choose whichever pixmap is appropriate for the current state of your widget. For example:
void drawIcon(QPainter ainter, QPoint pos) { QPixmap pixmap = icon.pixmap(new QSize(22, 22), isEnabled() ? QIcon.Mode.Normal : QIcon.Mode.Disabled, isOn() ? QIcon.State.On : QIcon.State.Off); painter.drawPixmap(pos, pixmap); }You might also make use of the Active mode, perhaps making your widget Active when the mouse is over the widget (see
QWidget::enterEvent()
), while the mouse is pressed pending the release that will activate the function, or when it is the currently selected item. If the widget can be toggled, the "On" mode might be used to draw a different icon.
Nested Class Summary | |
---|---|
static class |
QIcon.Mode
|
static class |
QIcon.State
This enum describes the state of a window. |
Nested classes/interfaces inherited from class com.trolltech.qt.QSignalEmitter |
---|
QSignalEmitter.Signal0, QSignalEmitter.Signal1, QSignalEmitter.Signal2, QSignalEmitter.Signal3, QSignalEmitter.Signal4, QSignalEmitter.Signal5, QSignalEmitter.Signal6, QSignalEmitter.Signal7, QSignalEmitter.Signal8, QSignalEmitter.Signal9 |
Constructor Summary | |
---|---|
QIcon()
Constructs a null icon. |
|
QIcon(QIcon other)
Constructs a copy of other. |
|
QIcon(QIconEngine engine)
Creates an icon with a specific icon engine. |
|
QIcon(QIconEngineV2 engine)
Creates an icon with a specific icon engine. |
|
QIcon(QPixmap pixmap)
Constructs an icon from a pixmap. |
|
QIcon(java.lang.String fileName)
Constructs an icon from the file with the given fileName. |
Method Summary | |
---|---|
QSize |
actualSize(QSize size)
Returns the actual size of the icon for the requested size, mode, and state. |
QSize |
actualSize(QSize size,
QIcon.Mode mode)
Returns the actual size of the icon for the requested size, mode, and state. |
QSize |
actualSize(QSize size,
QIcon.Mode mode,
QIcon.State state)
Returns the actual size of the icon for the requested size, mode, and state. |
void |
addFile(java.lang.String fileName)
Adds an image from the file with the given fileName to the icon, as a specialization for size, mode and state. |
void |
addFile(java.lang.String fileName,
QSize size)
Adds an image from the file with the given fileName to the icon, as a specialization for size, mode and state. |
void |
addFile(java.lang.String fileName,
QSize size,
QIcon.Mode mode)
Adds an image from the file with the given fileName to the icon, as a specialization for size, mode and state. |
void |
addFile(java.lang.String fileName,
QSize size,
QIcon.Mode mode,
QIcon.State state)
Adds an image from the file with the given fileName to the icon, as a specialization for size, mode and state. |
void |
addPixmap(QPixmap pixmap)
Adds pixmap to the icon, as a specialization for mode and state. |
void |
addPixmap(QPixmap pixmap,
QIcon.Mode mode)
Adds pixmap to the icon, as a specialization for mode and state. |
void |
addPixmap(QPixmap pixmap,
QIcon.Mode mode,
QIcon.State state)
Adds pixmap to the icon, as a specialization for mode and state. |
long |
cacheKey()
Returns a number that identifies the contents of this QIcon object. |
QIcon |
clone()
This method is reimplemented for internal reasons |
static QIcon |
fromNativePointer(QNativePointer nativePointer)
|
boolean |
isNull()
Returns true if the icon is empty; otherwise returns false. |
static QNativePointer |
nativePointerArray(QIcon[] array)
|
void |
paint(QPainter painter,
int x,
int y,
int w,
int h)
Paints the icon into the rectangle QRect (x, y, w, h). |
void |
paint(QPainter painter,
int x,
int y,
int w,
int h,
Qt.Alignment alignment)
Paints the icon into the rectangle QRect (x, y, w, h). |
void |
paint(QPainter painter,
int x,
int y,
int w,
int h,
Qt.Alignment alignment,
QIcon.Mode mode)
Paints the icon into the rectangle QRect (x, y, w, h). |
void |
paint(QPainter painter,
int x,
int y,
int w,
int h,
Qt.Alignment alignment,
QIcon.Mode mode,
QIcon.State state)
Paints the icon into the rectangle QRect (x, y, w, h). |
void |
paint(QPainter painter,
QRect rect)
Uses the painter to paint the icon with specified alignment, required mode, and state into the rectangle rect. |
void |
paint(QPainter painter,
QRect rect,
Qt.Alignment alignment)
Uses the painter to paint the icon with specified alignment, required mode, and state into the rectangle rect. |
void |
paint(QPainter painter,
QRect rect,
Qt.Alignment alignment,
QIcon.Mode mode)
Uses the painter to paint the icon with specified alignment, required mode, and state into the rectangle rect. |
void |
paint(QPainter painter,
QRect rect,
Qt.Alignment alignment,
QIcon.Mode mode,
QIcon.State state)
Uses the painter to paint the icon with specified alignment, required mode, and state into the rectangle rect. |
QPixmap |
pixmap(int extent)
Returns a pixmap of size QSize (extent, extent). |
QPixmap |
pixmap(int w,
int h)
Returns a pixmap of size QSize (w, h). |
QPixmap |
pixmap(int w,
int h,
QIcon.Mode mode)
Returns a pixmap of size QSize (w, h). |
QPixmap |
pixmap(int w,
int h,
QIcon.Mode mode,
QIcon.State state)
Returns a pixmap of size QSize (w, h). |
QPixmap |
pixmap(int extent,
QIcon.Mode mode)
Returns a pixmap of size QSize (extent, extent). |
QPixmap |
pixmap(int extent,
QIcon.Mode mode,
QIcon.State state)
Returns a pixmap of size QSize (extent, extent). |
QPixmap |
pixmap(QSize size)
Returns a pixmap with the requested size, mode, and state, generating one if necessary. |
QPixmap |
pixmap(QSize size,
QIcon.Mode mode)
Returns a pixmap with the requested size, mode, and state, generating one if necessary. |
QPixmap |
pixmap(QSize size,
QIcon.Mode mode,
QIcon.State state)
Returns a pixmap with the requested size, mode, and state, generating one if necessary. |
void |
readFrom(QDataStream arg__1)
|
void |
writeTo(QDataStream arg__1)
|
Methods inherited from class com.trolltech.qt.QtJambiObject |
---|
dispose, disposed, equals, finalize, reassignNativeResources, tr, tr, tr |
Methods inherited from class com.trolltech.qt.QSignalEmitter |
---|
blockSignals, disconnect, disconnect, signalsBlocked, signalSender, thread |
Methods inherited from class java.lang.Object |
---|
getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.trolltech.qt.QtJambiInterface |
---|
disableGarbageCollection, nativeId, nativePointer, reenableGarbageCollection, setJavaOwnership |
Constructor Detail |
---|
public QIcon()
public QIcon(QIconEngine engine)
public QIcon(QIconEngineV2 engine)
public QIcon(QIcon other)
public QIcon(QPixmap pixmap)
public QIcon(java.lang.String fileName)
If fileName contains a relative path (e.g. the filename only) the relevant file must be found relative to the runtime working directory.
The file name can be either refer to an actual file on disk or to one of the application's embedded resources. See the Resource System overview for details on how to embed images and other resource files in the application's executable.
Use the QImageReader::supportedImageFormats()
and QImageWriter::supportedImageFormats()
functions to retrieve a complete list of the supported file formats.
Method Detail |
---|
public final QSize actualSize(QSize size, QIcon.Mode mode)
pixmap()
, and paint()
.
public final QSize actualSize(QSize size)
pixmap()
, and paint()
.
public final QSize actualSize(QSize size, QIcon.Mode mode, QIcon.State state)
pixmap()
, and paint()
.
public final void addFile(java.lang.String fileName, QSize size, QIcon.Mode mode)
If fileName contains a relative path (e.g. the filename only) the relevant file must be found relative to the runtime working directory.
The file name can be either refer to an actual file on disk or to one of the application's embedded resources. See the Resource System overview for details on how to embed images and other resource files in the application's executable.
Use the QImageReader::supportedImageFormats()
and QImageWriter::supportedImageFormats()
functions to retrieve a complete list of the supported file formats.
addPixmap()
.
public final void addFile(java.lang.String fileName, QSize size)
If fileName contains a relative path (e.g. the filename only) the relevant file must be found relative to the runtime working directory.
The file name can be either refer to an actual file on disk or to one of the application's embedded resources. See the Resource System overview for details on how to embed images and other resource files in the application's executable.
Use the QImageReader::supportedImageFormats()
and QImageWriter::supportedImageFormats()
functions to retrieve a complete list of the supported file formats.
addPixmap()
.
public final void addFile(java.lang.String fileName)
If fileName contains a relative path (e.g. the filename only) the relevant file must be found relative to the runtime working directory.
The file name can be either refer to an actual file on disk or to one of the application's embedded resources. See the Resource System overview for details on how to embed images and other resource files in the application's executable.
Use the QImageReader::supportedImageFormats()
and QImageWriter::supportedImageFormats()
functions to retrieve a complete list of the supported file formats.
addPixmap()
.
public final void addFile(java.lang.String fileName, QSize size, QIcon.Mode mode, QIcon.State state)
If fileName contains a relative path (e.g. the filename only) the relevant file must be found relative to the runtime working directory.
The file name can be either refer to an actual file on disk or to one of the application's embedded resources. See the Resource System overview for details on how to embed images and other resource files in the application's executable.
Use the QImageReader::supportedImageFormats()
and QImageWriter::supportedImageFormats()
functions to retrieve a complete list of the supported file formats.
addPixmap()
.
public final void addPixmap(QPixmap pixmap, QIcon.Mode mode)
Custom icon engines are free to ignore additionally added pixmaps.
addFile()
.
public final void addPixmap(QPixmap pixmap)
Custom icon engines are free to ignore additionally added pixmaps.
addFile()
.
public final void addPixmap(QPixmap pixmap, QIcon.Mode mode, QIcon.State state)
Custom icon engines are free to ignore additionally added pixmaps.
addFile()
.
public final long cacheKey()
QIcon
object. Distinct QIcon
objects can have the same key if they refer to the same contents. The cacheKey()
will change when the icon is altered via addPixmap()
or addFile()
.
Cache keys are mostly useful in conjunction with caching.
QPixmap::cacheKey()
.
public final boolean isNull()
An icon is empty if it has neither a pixmap nor a filename.
Note: Even a non-null icon might not be able to create valid pixmaps, eg. if the file does not exist or cannot be read.
public final void writeTo(QDataStream arg__1)
public final void readFrom(QDataStream arg__1)
public final void paint(QPainter painter, QRect rect, Qt.Alignment alignment, QIcon.Mode mode)
actualSize()
, and pixmap()
.
public final void paint(QPainter painter, QRect rect, Qt.Alignment alignment)
actualSize()
, and pixmap()
.
public final void paint(QPainter painter, QRect rect)
actualSize()
, and pixmap()
.
public final void paint(QPainter painter, QRect rect, Qt.Alignment alignment, QIcon.Mode mode, QIcon.State state)
actualSize()
, and pixmap()
.
public final void paint(QPainter painter, int x, int y, int w, int h, Qt.Alignment alignment, QIcon.Mode mode)
QRect
(x, y, w, h).
public final void paint(QPainter painter, int x, int y, int w, int h, Qt.Alignment alignment)
QRect
(x, y, w, h).
public final void paint(QPainter painter, int x, int y, int w, int h)
QRect
(x, y, w, h).
public final void paint(QPainter painter, int x, int y, int w, int h, Qt.Alignment alignment, QIcon.Mode mode, QIcon.State state)
QRect
(x, y, w, h).
public final QPixmap pixmap(QSize size, QIcon.Mode mode)
actualSize()
, and paint()
.
public final QPixmap pixmap(QSize size)
actualSize()
, and paint()
.
public final QPixmap pixmap(QSize size, QIcon.Mode mode, QIcon.State state)
actualSize()
, and paint()
.
public final QPixmap pixmap(int extent, QIcon.Mode mode)
QSize
(extent, extent). The pixmap might be smaller than requested, but never larger.
public final QPixmap pixmap(int extent)
QSize
(extent, extent). The pixmap might be smaller than requested, but never larger.
public final QPixmap pixmap(int extent, QIcon.Mode mode, QIcon.State state)
QSize
(extent, extent). The pixmap might be smaller than requested, but never larger.
public final QPixmap pixmap(int w, int h, QIcon.Mode mode)
QSize
(w, h). The pixmap might be smaller than requested, but never larger.
public final QPixmap pixmap(int w, int h)
QSize
(w, h). The pixmap might be smaller than requested, but never larger.
public final QPixmap pixmap(int w, int h, QIcon.Mode mode, QIcon.State state)
QSize
(w, h). The pixmap might be smaller than requested, but never larger.
public static QIcon fromNativePointer(QNativePointer nativePointer)
public static QNativePointer nativePointerArray(QIcon[] array)
public QIcon clone()
clone
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |