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

tdecore

TDEIconTheme Class Reference

Class to use/access icon themes in KDE. More...

#include <kicontheme.h>

List of all members.

Public Member Functions

 TDEIconTheme (const TQString &name, const TQString &appName=TQString::null)
TQString name () const
TQString description () const
TQString example () const
TQString screenshot () const
TQString linkOverlay () const
TQString zipOverlay () const
TQString lockOverlay () const
TQString shareOverlay () const
TQString dir () const
TQStringList inherits () const
bool isValid () const
bool isHidden () const
int depth () const
int defaultSize (TDEIcon::Group group) const
TQValueList< int > querySizes (TDEIcon::Group group) const
TQStringList queryIcons (int size, TDEIcon::Context context=TDEIcon::Any) const
TQStringList queryIconsByContext (int size, TDEIcon::Context context=TDEIcon::Any) const
TDEIcon iconPath (const TQString &name, int size, TDEIcon::MatchType match) const
bool hasContext (TDEIcon::Context context) const

Static Public Member Functions

static TQStringList list ()
static TQString current ()
static void reconfigure ()
static TQString defaultThemeName ()

Detailed Description

Class to use/access icon themes in KDE.

This class is used by the iconloader but can be used by others too.

See also:
TDEIconLoader

Definition at line 187 of file kicontheme.h.


Constructor & Destructor Documentation

TDEIconTheme::TDEIconTheme ( const TQString &  name,
const TQString &  appName = TQString::null 
)

Load an icon theme by name.

Parameters:
name the name of the theme (e.g. "hicolor" or "keramik")
appName the name of the application. Can be null. This argument allows applications to have themed application icons.

Definition at line 82 of file kicontheme.cpp.


Member Function Documentation

TQString TDEIconTheme::current (  )  [static]

Returns the current icon theme.

Returns:
the name of the current theme

Definition at line 444 of file kicontheme.cpp.

int TDEIconTheme::defaultSize ( TDEIcon::Group  group  )  const

The default size of this theme for a certain icon group.

Parameters:
group The icon group. See TDEIcon::Group.
Returns:
The default size in pixels for the given icon group.

Definition at line 244 of file kicontheme.cpp.

TQString TDEIconTheme::defaultThemeName (  )  [static]

Returns the default icon theme.

Returns:
the name of the default theme name
Since:
3.1

Definition at line 512 of file kicontheme.cpp.

int TDEIconTheme::depth (  )  const [inline]

The minimum display depth required for this theme.

This can either be 8 or 32.

Returns:
the minimum bpp (8 or 32)

Definition at line 280 of file kicontheme.h.

TQString TDEIconTheme::description (  )  const [inline]

A description for the icon theme.

Returns:
a human-readable description of the theme, TQString::null if there is none

Definition at line 210 of file kicontheme.h.

TQString TDEIconTheme::dir (  )  const [inline]

Returns the toplevel theme directory.

Returns:
the directory of the theme

Definition at line 254 of file kicontheme.h.

TQString TDEIconTheme::example (  )  const

Return the name of the "example" icon.

This can be used to present the theme to the user.

Returns:
the name of the example icon, TQString::null if there is none

Definition at line 237 of file kicontheme.cpp.

bool TDEIconTheme::hasContext ( TDEIcon::Context  context  )  const

Returns true if the theme has any icons for the given context.

Since:
3.5.5

Definition at line 347 of file kicontheme.cpp.

TDEIcon TDEIconTheme::iconPath ( const TQString &  name,
int  size,
TDEIcon::MatchType  match 
) const

Lookup an icon in the theme.

Parameters:
name The name of the icon, without extension.
size The desired size of the icon.
match The matching mode. TDEIcon::MatchExact returns an icon only if matches exactly. TDEIcon::MatchBest returns the best matching icon.
Returns:
A TDEIcon class that describes the icon. If an icon is found,
See also:
TDEIcon::isValid will return true, and false otherwise.

Definition at line 361 of file kicontheme.cpp.

TQStringList TDEIconTheme::inherits (  )  const [inline]

The themes this icon theme falls back on.

Returns:
a list of icon themes that are used as fall-backs

Definition at line 260 of file kicontheme.h.

bool TDEIconTheme::isHidden (  )  const

The icon theme should be hidden to the user?

Returns:
true if the icon theme is hidden
Since:
3.1

Definition at line 232 of file kicontheme.cpp.

bool TDEIconTheme::isValid (  )  const

The icon theme exists?

Returns:
true if the icon theme is valid

Definition at line 227 of file kicontheme.cpp.

TQString TDEIconTheme::linkOverlay (  )  const

Returns the name of this theme's link overlay.

Returns:
the name of the link overlay

Definition at line 239 of file kicontheme.cpp.

TQStringList TDEIconTheme::list (  )  [static]

List all icon themes installed on the system, global and local.

Returns:
the list of all icon themes

Definition at line 466 of file kicontheme.cpp.

TQString TDEIconTheme::lockOverlay (  )  const

Returns the name of this theme's lock overlay.

Returns:
the name of the lock overlay

Definition at line 240 of file kicontheme.cpp.

TQString TDEIconTheme::name (  )  const [inline]

The stylized name of the icon theme.

Returns:
the (human-readable) name of the theme

Definition at line 203 of file kicontheme.h.

TQStringList TDEIconTheme::queryIcons ( int  size,
TDEIcon::Context  context = TDEIcon::Any 
) const

Query available icons for a size and context.

Parameters:
size the size of the icons
context the context of the icons
Returns:
the list of icon names

Definition at line 265 of file kicontheme.cpp.

TQStringList TDEIconTheme::queryIconsByContext ( int  size,
TDEIcon::Context  context = TDEIcon::Any 
) const

Query available icons for a context and preferred size.

Parameters:
size the size of the icons
context the context of the icons
Returns:
the list of icon names

Definition at line 318 of file kicontheme.cpp.

TQValueList< int > TDEIconTheme::querySizes ( TDEIcon::Group  group  )  const

Query available sizes for a group.

Parameters:
group The icon group. See TDEIcon::Group.
Returns:
a list of available sized for the given group

Definition at line 254 of file kicontheme.cpp.

void TDEIconTheme::reconfigure (  )  [static]

Reconfigure the theme.

Definition at line 503 of file kicontheme.cpp.

TQString TDEIconTheme::screenshot (  )  const

Return the name of the screenshot.

Returns:
the name of the screenshot, TQString::null if there is none

Definition at line 238 of file kicontheme.cpp.

TQString TDEIconTheme::shareOverlay (  )  const

Returns the name of this theme's share overlay.

Returns:
the name of the share overlay
Since:
3.1

Definition at line 242 of file kicontheme.cpp.

TQString TDEIconTheme::zipOverlay (  )  const

Returns the name of this theme's zip overlay.

Returns:
the name of the zip overlay

Definition at line 241 of file kicontheme.cpp.


The documentation for this class was generated from the following files:
  • kicontheme.h
  • kicontheme.cpp

tdecore

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

tdecore

Skip menu "tdecore"
  • arts
  • dcop
  • dnssd
  • interfaces
  •   kspeech
  •     interface
  •     library
  •   tdetexteditor
  • kate
  • kded
  • kdoctools
  • kimgio
  • kjs
  • libtdemid
  • libtdescreensaver
  • tdeabc
  • tdecmshell
  • tdecore
  • tdefx
  • tdehtml
  • tdeinit
  • tdeio
  •   bookmarks
  •   httpfilter
  •   kpasswdserver
  •   kssl
  •   tdefile
  •   tdeio
  •   tdeioexec
  • tdeioslave
  •   http
  • tdemdi
  •   tdemdi
  • tdenewstuff
  • tdeparts
  • tdeprint
  • tderandr
  • tderesources
  • tdespell2
  • tdesu
  • tdeui
  • tdeunittest
  • tdeutils
  • tdewallet
Generated for tdecore by doxygen 1.6.3
This website is maintained by Timothy Pearson.