Changeset View
Changeset View
Standalone View
Standalone View
src/plasma/pluginloader.h
| Show First 20 Lines • Show All 76 Lines • ▼ Show 20 Line(s) | 58 | public: | |||
|---|---|---|---|---|---|
| 77 | DataEngine *loadDataEngine(const QString &name); | 77 | DataEngine *loadDataEngine(const QString &name); | ||
| 78 | 78 | | |||
| 79 | /** | 79 | /** | ||
| 80 | * @return a listing of all known dataengines by name | 80 | * @return a listing of all known dataengines by name | ||
| 81 | * | 81 | * | ||
| 82 | * @param parentApp the application to filter dataengines on. Uses the | 82 | * @param parentApp the application to filter dataengines on. Uses the | ||
| 83 | * X-KDE-ParentApp entry (if any) in the plugin info. | 83 | * X-KDE-ParentApp entry (if any) in the plugin info. | ||
| 84 | * The default value of QString() will result in a | 84 | * The default value of QString() will result in a | ||
| 85 | * list containing only dataengines not specifically | 85 | * list of all dataengines. | ||
| 86 | * registered to an application. | | |||
| 87 | */ | 86 | */ | ||
| 88 | static QStringList listAllEngines(const QString &parentApp = QString()); | 87 | static QStringList listAllEngines(const QString &parentApp = QString()); | ||
| 89 | 88 | | |||
| 90 | /** | 89 | /** | ||
| 91 | * Returns a list of all known dataengines. | 90 | * Returns a list of all known dataengines. | ||
| 92 | * | 91 | * | ||
| 93 | * @param parentApp the application to filter dataengines on. Uses the | 92 | * @param parentApp the application to filter dataengines on. Uses the | ||
| 94 | * X-KDE-ParentApp entry (if any) in the plugin info. | 93 | * X-KDE-ParentApp entry (if any) in the plugin info. | ||
| 95 | * The default value of QString() will result in a | 94 | * The default value of QString() will result in a | ||
| 96 | * list containing only dataengines not specifically | 95 | * list of all dataengines. | ||
| 97 | * registered to an application. | | |||
| 98 | * @return list of dataengines | 96 | * @return list of dataengines | ||
| 99 | **/ | 97 | **/ | ||
| 100 | static KPluginInfo::List listEngineInfo(const QString &parentApp = QString()); | 98 | static KPluginInfo::List listEngineInfo(const QString &parentApp = QString()); | ||
| 101 | 99 | | |||
| 102 | /** | 100 | /** | ||
| 103 | * Returns a list of all known dataengines filtering by category. | 101 | * Returns a list of all known dataengines filtering by category. | ||
| 104 | * | 102 | * | ||
| 105 | * @param category the category to filter dataengines on. Uses the | 103 | * @param category the category to filter dataengines on. Uses the | ||
| 106 | * X-KDE-PluginInfo-Category entry (if any) in the | 104 | * X-KDE-PluginInfo-Category entry (if any) in the | ||
| 107 | * plugin info. The value of QString() will | 105 | * plugin info. The value of QString() will | ||
| 108 | * result in a list of dataengines with an empty category. | 106 | * result in a list of dataengines with an empty category. | ||
| 109 | * | 107 | * | ||
| 110 | * @param parentApp the application to filter dataengines on. Uses the | 108 | * @param parentApp the application to filter dataengines on. Uses the | ||
| 111 | * X-KDE-ParentApp entry (if any) in the plugin info. | 109 | * X-KDE-ParentApp entry (if any) in the plugin info. | ||
| 112 | * The default value of QString() will result in a | 110 | * The default value of QString() will result in a | ||
| 113 | * list containing only dataengines not specifically | 111 | * list of all dataengines in specified categories. | ||
| 114 | * registered to an application. | | |||
| 115 | * @return list of dataengines | 112 | * @return list of dataengines | ||
| 116 | * @since 4.3 | 113 | * @since 4.3 | ||
| 117 | **/ | 114 | **/ | ||
| 118 | static KPluginInfo::List listEngineInfoByCategory(const QString &category, const QString &parentApp = QString()); | 115 | static KPluginInfo::List listEngineInfoByCategory(const QString &category, const QString &parentApp = QString()); | ||
| 119 | 116 | | |||
| 120 | /** | 117 | /** | ||
| 121 | * Load a Service plugin. | 118 | * Load a Service plugin. | ||
| 122 | * | 119 | * | ||
| ▲ Show 20 Lines • Show All 41 Lines • ▼ Show 20 Line(s) | 154 | #endif | |||
| 164 | * Useful in conjunction with knownCategories. | 161 | * Useful in conjunction with knownCategories. | ||
| 165 | * If "Misc" is passed in, then applets without a | 162 | * If "Misc" is passed in, then applets without a | ||
| 166 | * Categories= entry are also returned. | 163 | * Categories= entry are also returned. | ||
| 167 | * If an empty string is passed in, all applets are | 164 | * If an empty string is passed in, all applets are | ||
| 168 | * returned. | 165 | * returned. | ||
| 169 | * @param parentApp the application to filter applets on. Uses the | 166 | * @param parentApp the application to filter applets on. Uses the | ||
| 170 | * X-KDE-ParentApp entry (if any) in the plugin info. | 167 | * X-KDE-ParentApp entry (if any) in the plugin info. | ||
| 171 | * The default value of QString() will result in a | 168 | * The default value of QString() will result in a | ||
| 172 | * list containing only applets not specifically | 169 | * list of all applets in specified category. | ||
| 173 | * registered to an application. | | |||
| 174 | * @return list of applets | 170 | * @return list of applets | ||
| 175 | * | 171 | * | ||
| 176 | * @deprecated use listAppletMetaData. Doesn't support metadata.json packages. | 172 | * @deprecated use listAppletMetaData. Doesn't support metadata.json packages. | ||
| 177 | **/ | 173 | **/ | ||
| 178 | PLASMA_DEPRECATED KPluginInfo::List listAppletInfo(const QString &category, const QString &parentApp = QString()); | 174 | PLASMA_DEPRECATED KPluginInfo::List listAppletInfo(const QString &category, const QString &parentApp = QString()); | ||
| 179 | 175 | | |||
| 180 | /** | 176 | /** | ||
| 181 | * Returns a list of all known applets. | 177 | * Returns a list of all known applets. | ||
| 182 | * This may skip applets based on security settings and ExcludeCategories in the application's config. | 178 | * This may skip applets based on security settings and ExcludeCategories in the application's config. | ||
| 183 | * | 179 | * | ||
| 184 | * @param category Only applets matchin this category will be returned. | 180 | * @param category Only applets matchin this category will be returned. | ||
| 185 | * Useful in conjunction with knownCategories. | 181 | * Useful in conjunction with knownCategories. | ||
| 186 | * If "Misc" is passed in, then applets without a | 182 | * If "Misc" is passed in, then applets without a | ||
| 187 | * Categories= entry are also returned. | 183 | * Categories= entry are also returned. | ||
| 188 | * If an empty string is passed in, all applets are | 184 | * If an empty string is passed in, all applets are | ||
| 189 | * returned. | 185 | * returned. | ||
| 190 | * @param parentApp the application to filter applets on. Uses the | 186 | * @param parentApp the application to filter applets on. Uses the | ||
| 191 | * X-KDE-ParentApp entry (if any) in the plugin info. | 187 | * X-KDE-ParentApp entry (if any) in the plugin info. | ||
| 192 | * The default value of QString() will result in a | 188 | * The default value of QString() will result in a | ||
| 193 | * list containing only applets not specifically | 189 | * list of all applets in specified categories. | ||
| 194 | * registered to an application. | | |||
| 195 | * @return list of applets | 190 | * @return list of applets | ||
| 196 | * | 191 | * | ||
| 197 | * @since 5.28 | 192 | * @since 5.28 | ||
| 198 | **/ | 193 | **/ | ||
| 199 | QList<KPluginMetaData> listAppletMetaData(const QString &category, const QString &parentApp = QString()); | 194 | QList<KPluginMetaData> listAppletMetaData(const QString &category, const QString &parentApp = QString()); | ||
| 200 | 195 | | |||
| 201 | /** | 196 | /** | ||
| 202 | * Returns a list of all known applets associated with a certain mimetype. | 197 | * Returns a list of all known applets associated with a certain mimetype. | ||
| Show All 28 Lines | |||||
| 231 | QList<KPluginMetaData> listAppletMetaDataForUrl(const QUrl &url); | 226 | QList<KPluginMetaData> listAppletMetaDataForUrl(const QUrl &url); | ||
| 232 | 227 | | |||
| 233 | /** | 228 | /** | ||
| 234 | * Returns a list of all the categories used by installed applets. | 229 | * Returns a list of all the categories used by installed applets. | ||
| 235 | * | 230 | * | ||
| 236 | * @param parentApp the application to filter applets on. Uses the | 231 | * @param parentApp the application to filter applets on. Uses the | ||
| 237 | * X-KDE-ParentApp entry (if any) in the plugin info. | 232 | * X-KDE-ParentApp entry (if any) in the plugin info. | ||
| 238 | * The default value of QString() will result in a | 233 | * The default value of QString() will result in a | ||
| 239 | * list containing only applets not specifically | 234 | * list of all Applets. | ||
| 240 | * registered to an application. | | |||
| 241 | * @return list of categories | 235 | * @return list of categories | ||
| 242 | * @param visibleOnly true if it should only return applets that are marked as visible | 236 | * @param visibleOnly true if it should only return applets that are marked as visible | ||
| 243 | */ | 237 | */ | ||
| 244 | QStringList listAppletCategories(const QString &parentApp = QString(), | 238 | QStringList listAppletCategories(const QString &parentApp = QString(), | ||
| 245 | bool visibleOnly = true); | 239 | bool visibleOnly = true); | ||
| 246 | 240 | | |||
| 247 | /** | 241 | /** | ||
| 248 | * Sets the list of custom categories that are used in addition to the default | 242 | * Sets the list of custom categories that are used in addition to the default | ||
| Show All 23 Lines | |||||
| 272 | * Useful in conjunction with knownCategories. | 266 | * Useful in conjunction with knownCategories. | ||
| 273 | * If "Miscellaneous" is passed in, then containments without a | 267 | * If "Miscellaneous" is passed in, then containments without a | ||
| 274 | * Categories= entry are also returned. | 268 | * Categories= entry are also returned. | ||
| 275 | * If an empty string is passed in, all containments are | 269 | * If an empty string is passed in, all containments are | ||
| 276 | * returned. | 270 | * returned. | ||
| 277 | * @param parentApp the application to filter containments on. Uses the | 271 | * @param parentApp the application to filter containments on. Uses the | ||
| 278 | * X-KDE-ParentApp entry (if any) in the plugin info. | 272 | * X-KDE-ParentApp entry (if any) in the plugin info. | ||
| 279 | * The default value of QString() will result in a | 273 | * The default value of QString() will result in a | ||
| 280 | * list containing only containments not specifically | 274 | * list of all containments. | ||
| 281 | * registered to an application. | | |||
| 282 | * @return list of containments | 275 | * @return list of containments | ||
| 283 | **/ | 276 | **/ | ||
| 284 | static KPluginInfo::List listContainments(const QString &category = QString(), | 277 | static KPluginInfo::List listContainments(const QString &category = QString(), | ||
| 285 | const QString &parentApp = QString()); | 278 | const QString &parentApp = QString()); | ||
| 286 | 279 | | |||
| 287 | /** | 280 | /** | ||
| 288 | * Returns a list of all known containments that match the parameters. | 281 | * Returns a list of all known containments that match the parameters. | ||
| 289 | * | 282 | * | ||
| 290 | * @param type Only containments with this string in X-Plasma-ContainmentType | 283 | * @param type Only containments with this string in X-Plasma-ContainmentType | ||
| 291 | * in their .desktop files will be returned. Common values are panel and | 284 | * in their .desktop files will be returned. Common values are panel and | ||
| 292 | * desktop | 285 | * desktop | ||
| 293 | * @param category Only containments matching this category will be returned. | 286 | * @param category Only containments matching this category will be returned. | ||
| 294 | * Useful in conjunction with knownCategories. | 287 | * Useful in conjunction with knownCategories. | ||
| 295 | * If "Miscellaneous" is passed in, then containments without a | 288 | * If "Miscellaneous" is passed in, then containments without a | ||
| 296 | * Categories= entry are also returned. | 289 | * Categories= entry are also returned. | ||
| 297 | * If an empty string is passed in, all containments are | 290 | * If an empty string is passed in, all containments are | ||
| 298 | * returned. | 291 | * returned. | ||
| 299 | * @param parentApp the application to filter containments on. Uses the | 292 | * @param parentApp the application to filter containments on. Uses the | ||
| 300 | * X-KDE-ParentApp entry (if any) in the plugin info. | 293 | * X-KDE-ParentApp entry (if any) in the plugin info. | ||
| 301 | * The default value of QString() will result in a | 294 | * The default value of QString() will result in a | ||
| 302 | * list containing only containments not specifically | 295 | * list of all containments, matching categories/type. | ||
| 303 | * registered to an application. | | |||
| 304 | * @return list of containments | 296 | * @return list of containments | ||
| 305 | **/ | 297 | **/ | ||
| 306 | static KPluginInfo::List listContainmentsOfType(const QString &type, | 298 | static KPluginInfo::List listContainmentsOfType(const QString &type, | ||
| 307 | const QString &category = QString(), | 299 | const QString &category = QString(), | ||
| 308 | const QString &parentApp = QString()); | 300 | const QString &parentApp = QString()); | ||
| 309 | 301 | | |||
| 310 | /** | 302 | /** | ||
| 311 | * @return a list of all known types of containments on this system | 303 | * @return a list of all known types of containments on this system | ||
| 312 | */ | 304 | */ | ||
| 313 | static QStringList listContainmentTypes(); | 305 | static QStringList listContainmentTypes(); | ||
| 314 | 306 | | |||
| 315 | /** | 307 | /** | ||
| 316 | * Returns a list of all known containments associated with a certain MimeType | 308 | * Returns a list of all known containments associated with a certain MimeType | ||
| 317 | * | 309 | * | ||
| 318 | * @return list of containments | 310 | * @return list of containments | ||
| 319 | **/ | 311 | **/ | ||
| 320 | static KPluginInfo::List listContainmentsForMimeType(const QString &mimeType); | 312 | static KPluginInfo::List listContainmentsForMimeType(const QString &mimeType); | ||
| 321 | 313 | | |||
| 322 | /** | 314 | /** | ||
| 323 | * Returns a list of all known dataengines. | 315 | * Returns a list of all known dataengines. | ||
| 324 | * | 316 | * | ||
| 325 | * @param parentApp the application to filter dataengines on. Uses the | 317 | * @param parentApp the application to filter dataengines on. Uses the | ||
| 326 | * X-KDE-ParentApp entry (if any) in the plugin info. | 318 | * X-KDE-ParentApp entry (if any) in the plugin info. | ||
| 327 | * The default value of QString() will result in a | 319 | * The default value of QString() will result in a | ||
| 328 | * list containing only dataengines not specifically | 320 | * list of all dataengines | ||
| 329 | * registered to an application. | | |||
| 330 | * @return list of dataengines | 321 | * @return list of dataengines | ||
| 331 | **/ | 322 | **/ | ||
| 332 | KPluginInfo::List listDataEngineInfo(const QString &parentApp = QString()); | 323 | KPluginInfo::List listDataEngineInfo(const QString &parentApp = QString()); | ||
| 333 | 324 | | |||
| 334 | /** | 325 | /** | ||
| 335 | * Returns a list of all known ContainmentActions. | 326 | * Returns a list of all known ContainmentActions. | ||
| 336 | * | 327 | * | ||
| 337 | * @param parentApp the application to filter ContainmentActions on. Uses the | 328 | * @param parentApp the application to filter ContainmentActions on. Uses the | ||
| 338 | * X-KDE-ParentApp entry (if any) in the plugin info. | 329 | * X-KDE-ParentApp entry (if any) in the plugin info. | ||
| 339 | * The default value of QString() will result in a | 330 | * The default value of QString() will result in a | ||
| 340 | * list containing only ContainmentActions not specifically | 331 | * list of all ContainmentActions. | ||
| 341 | * registered to an application. | | |||
| 342 | * @return list of ContainmentActions | 332 | * @return list of ContainmentActions | ||
| 343 | **/ | 333 | **/ | ||
| 344 | KPluginInfo::List listContainmentActionsInfo(const QString &parentApp); | 334 | KPluginInfo::List listContainmentActionsInfo(const QString &parentApp); | ||
| 345 | 335 | | |||
| 346 | /** | 336 | /** | ||
| 347 | * Set the plugin loader which will be queried for all loads. | 337 | * Set the plugin loader which will be queried for all loads. | ||
| 348 | * | 338 | * | ||
| 349 | * @param loader A subclass of PluginLoader which will be supplied | 339 | * @param loader A subclass of PluginLoader which will be supplied | ||
| ▲ Show 20 Lines • Show All 183 Lines • Show Last 20 Lines | |||||