1/**************************************************************************** 2** 3** Copyright (C) 2015 The Qt Company Ltd. 4** Contact: http://www.qt.io/licensing/ 5** 6** This file is part of the documentation of the Qt Toolkit. 7** 8** $QT_BEGIN_LICENSE:FDL$ 9** Commercial License Usage 10** Licensees holding valid commercial Qt licenses may use this file in 11** accordance with the commercial license agreement provided with the 12** Software or, alternatively, in accordance with the terms contained in 13** a written agreement between you and The Qt Company. For licensing terms 14** and conditions see http://www.qt.io/terms-conditions. For further 15** information use the contact form at http://www.qt.io/contact-us. 16** 17** GNU Free Documentation License Usage 18** Alternatively, this file may be used under the terms of the GNU Free 19** Documentation License version 1.3 as published by the Free Software 20** Foundation and appearing in the file included in the packaging of 21** this file. Please review the following information to ensure 22** the GNU Free Documentation License version 1.3 requirements 23** will be met: http://www.gnu.org/copyleft/fdl.html. 24** $QT_END_LICENSE$ 25** 26****************************************************************************/ 27 28/*! 29 \class QDesignerIconCacheInterface 30 \brief The QDesignerIconCacheInterface class provides an interface to \QD's icon cache. 31 \inmodule QtDesigner 32 \internal 33*/ 34 35/*! 36 \fn QDesignerIconCacheInterface::QDesignerIconCacheInterface(QObject *parent) 37 38 Constructs a new interface with the given \a parent. 39*/ 40 41/*! 42 \fn QIcon QDesignerIconCacheInterface::nameToIcon(const QString &filePath, const QString &qrcPath) 43 44 Returns the icon associated with the name specified by \a filePath in the resource 45 file specified by \a qrcPath. 46 47 If \a qrcPath refers to a valid resource file, the name used for the file path is a path 48 within those resources; otherwise the file path refers to a local file. 49 50 \sa {The Qt Resource System}, nameToPixmap() 51*/ 52 53/*! 54 \fn QPixmap QDesignerIconCacheInterface::nameToPixmap(const QString &filePath, const QString &qrcPath) 55 56 Returns the pixmap associated with the name specified by \a filePath in the resource 57 file specified by \a qrcPath. 58 59 If \a qrcPath refers to a valid resource file, the name used for the file path is a path 60 within those resources; otherwise the file path refers to a local file. 61 62 \sa {The Qt Resource System}, nameToIcon() 63*/ 64 65/*! 66 \fn QString QDesignerIconCacheInterface::iconToFilePath(const QIcon &icon) const 67 68 Returns the file path associated with the given \a icon. The file path is a path within 69 an application resources. 70*/ 71 72/*! 73 \fn QString QDesignerIconCacheInterface::iconToQrcPath(const QIcon &icon) const 74 75 Returns the path to the resource file that refers to the specified \a icon. The resource 76 path refers to a local file. 77*/ 78 79/*! 80 \fn QString QDesignerIconCacheInterface::pixmapToFilePath(const QPixmap &pixmap) const 81 82 Returns the file path associated with the given \a pixmap. The file path is a path within 83 an application resources. 84*/ 85 86/*! 87 \fn QString QDesignerIconCacheInterface::pixmapToQrcPath(const QPixmap &pixmap) const 88 89 Returns the path to the resource file that refers to the specified \a pixmap. The resource 90 path refers to a local file. 91*/ 92 93/*! 94 \fn QList<QPixmap> QDesignerIconCacheInterface::pixmapList() const 95 96 Returns a list of pixmaps for the icons provided by the icon cache. 97*/ 98 99/*! 100 \fn QList<QIcon> QDesignerIconCacheInterface::iconList() const 101 102 Returns a list of icons provided by the icon cache. 103*/ 104 105/*! 106 \fn QString QDesignerIconCacheInterface::resolveQrcPath(const QString &filePath, const QString &qrcPath, const QString &workingDirectory) const 107 108 Returns a path to a resource specified by the \a filePath within 109 the resource file located at \a qrcPath. If \a workingDirectory is 110 a valid path to a directory, the path returned will be relative to 111 that directory; otherwise an absolute path is returned. 112 113 \omit 114 ### Needs checking 115 \endomit 116*/ 117