|
1 /**************************************************************************** |
|
2 ** |
|
3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies). |
|
4 ** All rights reserved. |
|
5 ** Contact: Nokia Corporation (qt-info@nokia.com) |
|
6 ** |
|
7 ** This file is part of the documentation of the Qt Toolkit. |
|
8 ** |
|
9 ** $QT_BEGIN_LICENSE:LGPL$ |
|
10 ** No Commercial Usage |
|
11 ** This file contains pre-release code and may not be distributed. |
|
12 ** You may use this file in accordance with the terms and conditions |
|
13 ** contained in the Technology Preview License Agreement accompanying |
|
14 ** this package. |
|
15 ** |
|
16 ** GNU Lesser General Public License Usage |
|
17 ** Alternatively, this file may be used under the terms of the GNU Lesser |
|
18 ** General Public License version 2.1 as published by the Free Software |
|
19 ** Foundation and appearing in the file LICENSE.LGPL included in the |
|
20 ** packaging of this file. Please review the following information to |
|
21 ** ensure the GNU Lesser General Public License version 2.1 requirements |
|
22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. |
|
23 ** |
|
24 ** In addition, as a special exception, Nokia gives you certain additional |
|
25 ** rights. These rights are described in the Nokia Qt LGPL Exception |
|
26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. |
|
27 ** |
|
28 ** If you have questions regarding the use of this file, please contact |
|
29 ** Nokia at qt-info@nokia.com. |
|
30 ** |
|
31 ** |
|
32 ** |
|
33 ** |
|
34 ** |
|
35 ** |
|
36 ** |
|
37 ** |
|
38 ** $QT_END_LICENSE$ |
|
39 ** |
|
40 ****************************************************************************/ |
|
41 |
|
42 /*! |
|
43 \class QDesignerIconCacheInterface |
|
44 \brief The QDesignerIconCacheInterface class provides an interface to \QD's icon cache. |
|
45 \inmodule QtDesigner |
|
46 \internal |
|
47 */ |
|
48 |
|
49 /*! |
|
50 \fn QDesignerIconCacheInterface::QDesignerIconCacheInterface(QObject *parent) |
|
51 |
|
52 Constructs a new interface with the given \a parent. |
|
53 */ |
|
54 |
|
55 /*! |
|
56 \fn QIcon QDesignerIconCacheInterface::nameToIcon(const QString &filePath, const QString &qrcPath) |
|
57 |
|
58 Returns the icon associated with the name specified by \a filePath in the resource |
|
59 file specified by \a qrcPath. |
|
60 |
|
61 If \a qrcPath refers to a valid resource file, the name used for the file path is a path |
|
62 within those resources; otherwise the file path refers to a local file. |
|
63 |
|
64 \sa {The Qt Resource System}, nameToPixmap() |
|
65 */ |
|
66 |
|
67 /*! |
|
68 \fn QPixmap QDesignerIconCacheInterface::nameToPixmap(const QString &filePath, const QString &qrcPath) |
|
69 |
|
70 Returns the pixmap associated with the name specified by \a filePath in the resource |
|
71 file specified by \a qrcPath. |
|
72 |
|
73 If \a qrcPath refers to a valid resource file, the name used for the file path is a path |
|
74 within those resources; otherwise the file path refers to a local file. |
|
75 |
|
76 \sa {The Qt Resource System}, nameToIcon() |
|
77 */ |
|
78 |
|
79 /*! |
|
80 \fn QString QDesignerIconCacheInterface::iconToFilePath(const QIcon &icon) const |
|
81 |
|
82 Returns the file path associated with the given \a icon. The file path is a path within |
|
83 an application resources. |
|
84 */ |
|
85 |
|
86 /*! |
|
87 \fn QString QDesignerIconCacheInterface::iconToQrcPath(const QIcon &icon) const |
|
88 |
|
89 Returns the path to the resource file that refers to the specified \a icon. The resource |
|
90 path refers to a local file. |
|
91 */ |
|
92 |
|
93 /*! |
|
94 \fn QString QDesignerIconCacheInterface::pixmapToFilePath(const QPixmap &pixmap) const |
|
95 |
|
96 Returns the file path associated with the given \a pixmap. The file path is a path within |
|
97 an application resources. |
|
98 */ |
|
99 |
|
100 /*! |
|
101 \fn QString QDesignerIconCacheInterface::pixmapToQrcPath(const QPixmap &pixmap) const |
|
102 |
|
103 Returns the path to the resource file that refers to the specified \a pixmap. The resource |
|
104 path refers to a local file. |
|
105 */ |
|
106 |
|
107 /*! |
|
108 \fn QList<QPixmap> QDesignerIconCacheInterface::pixmapList() const |
|
109 |
|
110 Returns a list of pixmaps for the icons provided by the icon cache. |
|
111 */ |
|
112 |
|
113 /*! |
|
114 \fn QList<QIcon> QDesignerIconCacheInterface::iconList() const |
|
115 |
|
116 Returns a list of icons provided by the icon cache. |
|
117 */ |
|
118 |
|
119 /*! |
|
120 \fn QString QDesignerIconCacheInterface::resolveQrcPath(const QString &filePath, const QString &qrcPath, const QString &workingDirectory) const |
|
121 |
|
122 Returns a path to a resource specified by the \a filePath within |
|
123 the resource file located at \a qrcPath. If \a workingDirectory is |
|
124 a valid path to a directory, the path returned will be relative to |
|
125 that directory; otherwise an absolute path is returned. |
|
126 |
|
127 \omit |
|
128 ### Needs checking |
|
129 \endomit |
|
130 */ |