kio Library API Documentation

KIconButton Class Reference

A pushbutton for choosing an icon. A push button that allows selection of an icon. More...

#include <kicondialog.h>

Inheritance diagram for KIconButton:

QPushButton List of all members.

Signals

void iconChanged (QString icon)

Public Member Functions

 KIconButton (QWidget *parent=0L, const char *name=0L)
 KIconButton (KIconLoader *loader, QWidget *parent, const char *name=0L)
 ~KIconButton ()
void setStrictIconSize (bool b)
bool strictIconSize () const
void setIconType (KIcon::Group group, KIcon::Context context, bool user=false)
void setIcon (const QString &icon)
void resetIcon ()
QString icon () const
void setIconSize (int size)
int iconSize () const

Detailed Description

A pushbutton for choosing an icon. A push button that allows selection of an icon.

Pressing on the button will open a KIconDialog for the user to select an icon. The current icon will be displayed on the button.

See also:
KIconDialog

Definition at line 240 of file kicondialog.h.


Constructor & Destructor Documentation

KIconButton::KIconButton QWidget parent = 0L,
const char *  name = 0L
 

Constructs a KIconButton using the global iconloader.

Definition at line 505 of file kicondialog.cpp.

References KGlobal::iconLoader(), and KIconButton().

Referenced by KIconButton().

KIconButton::KIconButton KIconLoader loader,
QWidget parent,
const char *  name = 0L
 

Constructs a KIconButton using a specific KIconLoader.

Definition at line 519 of file kicondialog.cpp.

References KIconButton().

KIconButton::~KIconButton  ) 
 

Destructs the button.

Definition at line 533 of file kicondialog.cpp.


Member Function Documentation

void KIconButton::setStrictIconSize bool  b  ) 
 

Sets a strict icon size policy for allowed icons.

When true, only icons of the specified group's size in setIconType are allowed, and only icons of that size will be shown in the icon dialog.

Definition at line 539 of file kicondialog.cpp.

References setStrictIconSize().

Referenced by KFilePropsPlugin::KFilePropsPlugin(), KURLBarItemDialog::KURLBarItemDialog(), and setStrictIconSize().

bool KIconButton::strictIconSize  )  const
 

Returns true if a strict icon size policy is set.

Definition at line 544 of file kicondialog.cpp.

void KIconButton::setIconType KIcon::Group  group,
KIcon::Context  context,
bool  user = false
 

Sets the icon group and context.

Use KIcon::NoGroup if you want to allow icons for any group in the given context.

Definition at line 559 of file kicondialog.cpp.

References setIconType().

Referenced by KFilePropsPlugin::KFilePropsPlugin(), and setIconType().

void KIconButton::setIcon const QString icon  ) 
 

Sets the button's initial icon.

Definition at line 566 of file kicondialog.cpp.

References KIconLoader::iconPath(), KIconLoader::loadIcon(), KIconDialog::setCustomLocation(), and setIcon().

Referenced by KFilePropsPlugin::KFilePropsPlugin(), KURLBarItemDialog::KURLBarItemDialog(), and setIcon().

void KIconButton::resetIcon  ) 
 

Resets the icon (reverts to an empty button).

Definition at line 581 of file kicondialog.cpp.

QString KIconButton::icon  )  const [inline]
 

Returns the name of the selected icon.

Definition at line 289 of file kicondialog.h.

Referenced by KDevicePropsPlugin::applyChanges(), and KURLBarItemDialog::icon().

void KIconButton::setIconSize int  size  ) 
 

Sets the size of the icon to be shown / selected.

See also:
KIcon::StdSizes

iconSize

Definition at line 549 of file kicondialog.cpp.

References setIconSize().

Referenced by KFilePropsPlugin::KFilePropsPlugin(), KURLBarItemDialog::KURLBarItemDialog(), and setIconSize().

int KIconButton::iconSize  )  const
 

Returns the iconsize set via setIconSize() or 0, if the default iconsize will be used.

Definition at line 554 of file kicondialog.cpp.

void KIconButton::iconChanged QString  icon  )  [signal]
 

Emitted when the icon has changed.


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kio Library Version 3.2.3.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Sun Oct 10 18:55:31 2004 by doxygen 1.3.7 written by Dimitri van Heesch, © 1997-2003