• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • kdecore
 

kdecore

  • kdecore
kiconloader.h
1 /* vi: ts=8 sts=4 sw=4
2  *
3  * This file is part of the KDE project, module kdecore.
4  * Copyright (C) 2000 Geert Jansen <jansen@kde.org>
5  * Antonio Larrosa <larrosa@kde.org>
6  *
7  * This is free software; it comes under the GNU Library General
8  * Public License, version 2. See the file "COPYING.LIB" for the
9  * exact licensing terms.
10  */
11 
12 #ifndef __KIconLoader_h_Included__
13 #define __KIconLoader_h_Included__
14 
15 #include <tqstring.h>
16 #include <tqpixmap.h>
17 #include <tqiconset.h>
18 
19 // Grmbl, X headers.....
20 #ifdef Status
21 #define KIconLoaderXStatus Status
22 #undef Status
23 #endif
24 #include <tqmovie.h>
25 #ifdef KIconLoaderXStatus
26 #define Status int
27 #undef KIconLoaderXStatus
28 #endif
29 
30 #include <kglobal.h>
31 #include <kinstance.h>
32 #include <kicontheme.h>
33 
34 struct KIconGroup;
35 class KIconThemeNode;
36 class KConfig;
37 struct KIconLoaderPrivate;
38 class KStandardDirs;
39 class KIconEffect;
40 
41 
77 class KDECORE_EXPORT KIconLoader
78 {
79 public:
80 
95  KIconLoader(const TQString& appname=TQString::null, KStandardDirs *dirs = 0);
96 
100  ~KIconLoader();
101 
106  void addAppDir(const TQString& appname);
107 
129  TQPixmap loadIcon(const TQString& name, KIcon::Group group, int size=0,
130  int state=KIcon::DefaultState, TQString *path_store=0L,
131  bool canReturnNull=false) const;
132 
151  TQIconSet loadIconSet(const TQString& name, KIcon::Group group, int size,
152  bool canReturnNull, bool immediateExistenceCheck);
153 
154  // KDE4 merge as (const TQString&,KIcon::Group,int=0,bool=false,bool=true);
171  TQIconSet loadIconSet(const TQString& name, KIcon::Group group, int size,
172  bool canReturnNull);
173 
174  // KDE4 merge as (const TQString&,KIcon::Group,int=0,bool=false,bool=true);
186  TQIconSet loadIconSet(const TQString& name, KIcon::Group group, int size=0);
187 
202  TQString iconPath(const TQString& name, int group_or_size,
203  bool canReturnNull=false) const;
204 
213  TQMovie loadMovie(const TQString& name, KIcon::Group group, int size=0) const;
214 
224  TQString moviePath(const TQString& name, KIcon::Group group, int size=0) const;
225 
236  TQStringList loadAnimated(const TQString& name, KIcon::Group group, int size=0) const;
237 
248  TQStringList queryIcons(int group_or_size, KIcon::Context context=KIcon::Any) const;
249 
261  TQStringList queryIconsByContext(int group_or_size,
262  KIcon::Context context=KIcon::Any) const;
263 
267  bool hasContext( KIcon::Context context ) const;
268 
276  TQStringList queryIconsByDir( const TQString& iconsDir ) const;
277 
283  int currentSize(KIcon::Group group) const;
284 
290  KIconTheme *theme() const;
291 
296  KIconEffect *iconEffect() const;
297 
304  void reconfigure( const TQString& _appname, KStandardDirs *_dirs );
305 
311  static TQPixmap unknown();
312 
320  bool alphaBlending( KIcon::Group group ) const;
321 
327  void addExtraDesktopThemes();
328 
334  bool extraDesktopThemesAdded() const;
335 
355  void enableDelayedIconSetLoading( bool enable );
356 
364  bool isDelayedIconSetLoadingEnabled() const;
365 
366 
367  private:
371  void init( const TQString& _appname, KStandardDirs *_dirs );
372 
378  KIcon findMatchingIcon(const TQString& name, int size) const;
379 
384  TQImage *loadOverlay(const TQString& name, int size) const;
385 
390  void addAppThemes(const TQString& appname);
391 
397  void addBaseThemes(KIconThemeNode *node, const TQString &appname);
398 
404  TQString unknownIconPath( int size ) const;
405 
421  TQString removeIconExtension(const TQString &name) const;
422 
432  TQString removeIconExtensionInternal(const TQString &name) const;
433 
437  TQIconSet loadIconSetNonDelayed( const TQString& name, KIcon::Group group,
438  int size, bool canReturnNull );
439 
440  // @internal the data object
441  KIconLoaderPrivate *d;
442 };
443 
448 KDECORE_EXPORT TQPixmap DesktopIcon(const TQString& name, int size=0,
449  int state=KIcon::DefaultState,
450  KInstance *instance=KGlobal::instance());
451 
456 KDECORE_EXPORT TQPixmap DesktopIcon(const TQString& name, KInstance *instance);
457 
462 KDECORE_EXPORT TQIconSet DesktopIconSet(const TQString& name, int size=0,
463  KInstance *instance=KGlobal::instance());
464 
469 KDECORE_EXPORT TQPixmap BarIcon(const TQString& name, int size=0, int state=KIcon::DefaultState,
470  KInstance *instance=KGlobal::instance());
471 
476 KDECORE_EXPORT TQPixmap BarIcon(const TQString& name, KInstance *instance);
477 
482 KDECORE_EXPORT TQIconSet BarIconSet(const TQString& name, int size=0,
483  KInstance *instance=KGlobal::instance());
484 
489 KDECORE_EXPORT TQPixmap SmallIcon(const TQString& name, int size=0,
490  int state=KIcon::DefaultState,
491  KInstance *instance=KGlobal::instance());
492 
497 KDECORE_EXPORT TQPixmap SmallIcon(const TQString& name, KInstance *instance);
498 
503 KDECORE_EXPORT TQIconSet SmallIconSet(const TQString& name, int size=0,
504  KInstance *instance=KGlobal::instance());
505 
510 KDECORE_EXPORT TQPixmap MainBarIcon(const TQString& name, int size=0,
511  int state=KIcon::DefaultState,
512  KInstance *instance=KGlobal::instance());
513 
518 KDECORE_EXPORT TQPixmap MainBarIcon(const TQString& name, KInstance *instance);
519 
524 KDECORE_EXPORT TQIconSet MainBarIconSet(const TQString& name, int size=0,
525  KInstance *instance=KGlobal::instance());
526 
531 KDECORE_EXPORT TQPixmap UserIcon(const TQString& name, int state=KIcon::DefaultState,
532  KInstance *instance=KGlobal::instance());
533 
538 KDECORE_EXPORT TQPixmap UserIcon(const TQString& name, KInstance *instance);
539 
544 KDECORE_EXPORT TQIconSet UserIconSet(const TQString& name,
545  KInstance *instance=KGlobal::instance());
546 
551 KDECORE_EXPORT int IconSize(KIcon::Group group, KInstance *instance=KGlobal::instance());
552 
553 #endif // __KIconLoader_h_Included__
KConfig
Access KDE Configuration entries.
Definition: kconfig.h:44
KGlobal::instance
static KInstance * instance()
Returns the global instance.
Definition: kglobal.cpp:82
KIconEffect
Applies effects to icons.
Definition: kiconeffect.h:35
KIconLoader
Iconloader for KDE.
Definition: kiconloader.h:78
KIconLoader::MainBarIcon
TQPixmap MainBarIcon(const TQString &name, int size=0, int state=KIcon::DefaultState, KInstance *instance=KGlobal::instance())
Load a main toolbar icon.
Definition: kiconloader.cpp:1351
KIconLoader::UserIcon
TQPixmap UserIcon(const TQString &name, int state=KIcon::DefaultState, KInstance *instance=KGlobal::instance())
Load a user icon.
Definition: kiconloader.cpp:1369
KIconLoader::SmallIcon
TQPixmap SmallIcon(const TQString &name, int size=0, int state=KIcon::DefaultState, KInstance *instance=KGlobal::instance())
Load a small icon.
Definition: kiconloader.cpp:1333
KIconLoader::BarIconSet
TQIconSet BarIconSet(const TQString &name, int size=0, KInstance *instance=KGlobal::instance())
Load a toolbar icon, and apply the necessary effects to get an IconSet.
Definition: kiconloader.cpp:1327
KIconLoader::DesktopIcon
TQPixmap DesktopIcon(const TQString &name, int size=0, int state=KIcon::DefaultState, KInstance *instance=KGlobal::instance())
Load a desktop icon.
Definition: kiconloader.cpp:1297
KIconLoader::MainBarIconSet
TQIconSet MainBarIconSet(const TQString &name, int size=0, KInstance *instance=KGlobal::instance())
Load a main toolbar icon, and apply the effects to get an IconSet.
Definition: kiconloader.cpp:1363
KIconLoader::BarIcon
TQPixmap BarIcon(const TQString &name, int size=0, int state=KIcon::DefaultState, KInstance *instance=KGlobal::instance())
Load a toolbar icon.
Definition: kiconloader.cpp:1315
KIconLoader::UserIconSet
TQIconSet UserIconSet(const TQString &name, KInstance *instance=KGlobal::instance())
Load a user icon, and apply the effects to get an IconSet.
Definition: kiconloader.cpp:1380
KIconLoader::SmallIconSet
TQIconSet SmallIconSet(const TQString &name, int size=0, KInstance *instance=KGlobal::instance())
Load a small icon, and apply the necessary effects to get an IconSet.
Definition: kiconloader.cpp:1345
KIconLoader::IconSize
int IconSize(KIcon::Group group, KInstance *instance=KGlobal::instance())
Returns the current icon size for a specific group.
Definition: kiconloader.cpp:1386
KIconLoader::DesktopIconSet
TQIconSet DesktopIconSet(const TQString &name, int size=0, KInstance *instance=KGlobal::instance())
Load a desktop icon, and apply the necessary effects to get an IconSet.
Definition: kiconloader.cpp:1309
KIconTheme
Class to use/access icon themes in KDE.
Definition: kicontheme.h:188
KIcon
One icon as found by KIconTheme.
Definition: kicontheme.h:37
KIcon::DefaultState
@ DefaultState
The default state.
Definition: kicontheme.h:130
KIcon::Group
Group
The group of the icon.
Definition: kicontheme.h:88
KIcon::Context
Context
Defines the context of the icon.
Definition: kicontheme.h:49
KIcon::Any
@ Any
Some icon with unknown purpose.
Definition: kicontheme.h:50
KInstance
Access to KDE global objects for use in shared libraries.
Definition: kinstance.h:44
KStandardDirs
Site-independent access to standard KDE directories.
Definition: kstandarddirs.h:126

kdecore

Skip menu "kdecore"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdecore

Skip menu "kdecore"
  • arts
  • dcop
  • dnssd
  • interfaces
  •     interface
  •     library
  •   kspeech
  •   ktexteditor
  • kabc
  • kate
  • kcmshell
  • kdecore
  • kded
  • kdefx
  • kdeprint
  • kdesu
  • kdeui
  • kdoctools
  • khtml
  • kimgio
  • kinit
  • kio
  •   bookmarks
  •   httpfilter
  •   kfile
  •   kio
  •   kioexec
  •   kpasswdserver
  •   kssl
  • kioslave
  •   http
  • kjs
  • kmdi
  •   kmdi
  • knewstuff
  • kparts
  • krandr
  • kresources
  • kspell2
  • kunittest
  • kutils
  • kwallet
  • libkmid
  • libkscreensaver
Generated for kdecore by doxygen 1.9.1
This website is maintained by Timothy Pearson.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. |