#include <k3panelapplet.h>

Inheritance diagram for K3PanelApplet:

Public Types
enum	Action { About = 1, Help = 2, Preferences = 4, ReportBug = 8 }

enum	Alignment { LeftTop = 0, Center, RightBottom }

enum	Position { Left = 0, Right, Up, Down, Top = Up, Bottom = Down, Floating }

enum	Type { Normal = 0, Stretch }

Signals
void	requestFocus ()

void	requestFocus (bool focus)

void	updateLayout ()

Public Member Functions
	K3PanelApplet (const QString &configFile, Type t=Normal, int actions=0, QWidget *parent=0, Qt::WindowFlags f=0)

	~K3PanelApplet ()

virtual void	action (Action a)

int	actions () const

KConfig *	config () const

const QMenu *	customMenu () const

virtual int	heightForWidth (int width) const

void	setAlignment (Alignment a)

void	setPosition (Position p)

KSharedConfig::Ptr	sharedConfig () const

Type	type () const

virtual int	widthForHeight (int height) const

Public Member Functions inherited from QFrame
	QFrame (QWidget *parent, QFlags< Qt::WindowType > f)

	QFrame (QWidget parent, const char name, QFlags< Qt::WindowType > f)

	~QFrame ()

QRect	frameRect () const

Shadow	frameShadow () const

Shape	frameShape () const

int	frameStyle () const

int	frameWidth () const

int	lineWidth () const

int	midLineWidth () const

void	setFrameRect (const QRect &)

void	setFrameShadow (Shadow)

void	setFrameShape (Shape)

void	setFrameStyle (int style)

void	setLineWidth (int)

void	setMidLineWidth (int)

virtual QSize	sizeHint () const

Public Member Functions inherited from QWidget
	QWidget (QWidget *parent, QFlags< Qt::WindowType > f)

	QWidget (QWidget parent, const char name, QFlags< Qt::WindowType > f)

	~QWidget ()

bool	acceptDrops () const

QString	accessibleDescription () const

QString	accessibleName () const

QList< QAction * >	actions () const

void	activateWindow ()

void	addAction (QAction *action)

void	addActions (QList< QAction * > actions)

void	adjustSize ()

bool	autoFillBackground () const

Qt::BackgroundMode	backgroundMode () const

QPoint	backgroundOffset () const

BackgroundOrigin	backgroundOrigin () const

QPalette::ColorRole	backgroundRole () const

QSize	baseSize () const

QString	caption () const

QWidget *	childAt (int x, int y, bool includeThis) const

QWidget *	childAt (const QPoint &p, bool includeThis) const

QWidget *	childAt (int x, int y) const

QWidget *	childAt (const QPoint &p) const

QRect	childrenRect () const

QRegion	childrenRegion () const

void	clearFocus ()

void	clearMask ()

bool	close (bool alsoDelete)

bool	close ()

QColorGroup	colorGroup () const

void	constPolish () const

QMargins	contentsMargins () const

QRect	contentsRect () const

Qt::ContextMenuPolicy	contextMenuPolicy () const

QCursor	cursor () const

void	customContextMenuRequested (const QPoint &pos)

void	drawText (const QPoint &p, const QString &s)

void	drawText (int x, int y, const QString &s)

WId	effectiveWinId () const

void	ensurePolished () const

void	erase ()

void	erase (const QRect &rect)

void	erase (const QRegion &rgn)

void	erase (int x, int y, int w, int h)

Qt::FocusPolicy	focusPolicy () const

QWidget *	focusProxy () const

QWidget *	focusWidget () const

const QFont &	font () const

QFontInfo	fontInfo () const

QFontMetrics	fontMetrics () const

QPalette::ColorRole	foregroundRole () const

QRect	frameGeometry () const

QSize	frameSize () const

const QRect &	geometry () const

void	getContentsMargins (int left, int top, int right, int bottom) const

virtual HDC	getDC () const

void	grabGesture (Qt::GestureType gesture, QFlags< Qt::GestureFlag > flags)

void	grabKeyboard ()

void	grabMouse ()

void	grabMouse (const QCursor &cursor)

int	grabShortcut (const QKeySequence &key, Qt::ShortcutContext context)

QGraphicsEffect *	graphicsEffect () const

QGraphicsProxyWidget *	graphicsProxyWidget () const

bool	hasEditFocus () const

bool	hasFocus () const

bool	hasMouse () const

bool	hasMouseTracking () const

int	height () const

void	hide ()

const QPixmap *	icon () const

void	iconify ()

QString	iconText () const

QInputContext *	inputContext ()

Qt::InputMethodHints	inputMethodHints () const

virtual QVariant	inputMethodQuery (Qt::InputMethodQuery query) const

void	insertAction (QAction before, QAction action)

void	insertActions (QAction before, QList< QAction > actions)

bool	isActiveWindow () const

bool	isAncestorOf (const QWidget *child) const

bool	isDesktop () const

bool	isDialog () const

bool	isEnabled () const

bool	isEnabledTo (QWidget *ancestor) const

bool	isEnabledToTLW () const

bool	isFullScreen () const

bool	isHidden () const

bool	isInputMethodEnabled () const

bool	isMaximized () const

bool	isMinimized () const

bool	isModal () const

bool	isPopup () const

bool	isShown () const

bool	isTopLevel () const

bool	isUpdatesEnabled () const

bool	isVisible () const

bool	isVisibleTo (QWidget *ancestor) const

bool	isVisibleToTLW () const

bool	isWindow () const

bool	isWindowModified () const

QLayout *	layout () const

Qt::LayoutDirection	layoutDirection () const

QLocale	locale () const

void	lower ()

Qt::HANDLE	macCGHandle () const

Qt::HANDLE	macQDHandle () const

QPoint	mapFrom (QWidget *parent, const QPoint &pos) const

QPoint	mapFromGlobal (const QPoint &pos) const

QPoint	mapFromParent (const QPoint &pos) const

QPoint	mapTo (QWidget *parent, const QPoint &pos) const

QPoint	mapToGlobal (const QPoint &pos) const

QPoint	mapToParent (const QPoint &pos) const

QRegion	mask () const

int	maximumHeight () const

QSize	maximumSize () const

int	maximumWidth () const

int	minimumHeight () const

QSize	minimumSize () const

virtual QSize	minimumSizeHint () const

int	minimumWidth () const

void	move (int x, int y)

void	move (const QPoint &)

QWidget *	nativeParentWidget () const

QWidget *	nextInFocusChain () const

QRect	normalGeometry () const

void	overrideWindowFlags (QFlags< Qt::WindowType > flags)

bool	ownCursor () const

bool	ownFont () const

bool	ownPalette () const

virtual QPaintEngine *	paintEngine () const

const QPalette &	palette () const

QWidget *	parentWidget (bool sameWindow) const

QWidget *	parentWidget () const

QPlatformWindow *	platformWindow () const

QPlatformWindowFormat	platformWindowFormat () const

void	polish ()

QPoint	pos () const

QWidget *	previousInFocusChain () const

void	raise ()

void	recreate (QWidget *parent, QFlags< Qt::WindowType > f, const QPoint &p, bool showIt)

QRect	rect () const

virtual void	releaseDC (HDC hdc) const

void	releaseKeyboard ()

void	releaseMouse ()

void	releaseShortcut (int id)

void	removeAction (QAction *action)

void	render (QPaintDevice *target, const QPoint &targetOffset, const QRegion &sourceRegion, QFlags< QWidget::RenderFlag > renderFlags)

void	render (QPainter *painter, const QPoint &targetOffset, const QRegion &sourceRegion, QFlags< QWidget::RenderFlag > renderFlags)

void	repaint (int x, int y, int w, int h, bool b)

void	repaint (const QRegion &rgn, bool b)

void	repaint ()

void	repaint (int x, int y, int w, int h)

void	repaint (const QRegion &rgn)

void	repaint (bool b)

void	repaint (const QRect &rect)

void	repaint (const QRect &r, bool b)

void	reparent (QWidget *parent, QFlags< Qt::WindowType > f, const QPoint &p, bool showIt)

void	reparent (QWidget *parent, const QPoint &p, bool showIt)

void	resize (int w, int h)

void	resize (const QSize &)

bool	restoreGeometry (const QByteArray &geometry)

QByteArray	saveGeometry () const

void	scroll (int dx, int dy)

void	scroll (int dx, int dy, const QRect &r)

void	setAcceptDrops (bool on)

void	setAccessibleDescription (const QString &description)

void	setAccessibleName (const QString &name)

void	setActiveWindow ()

void	setAttribute (Qt::WidgetAttribute attribute, bool on)

void	setAutoFillBackground (bool enabled)

void	setBackgroundColor (const QColor &color)

void	setBackgroundMode (Qt::BackgroundMode widgetBackground, Qt::BackgroundMode paletteBackground)

void	setBackgroundOrigin (BackgroundOrigin background)

void	setBackgroundPixmap (const QPixmap &pixmap)

void	setBackgroundRole (QPalette::ColorRole role)

void	setBaseSize (const QSize &)

void	setBaseSize (int basew, int baseh)

void	setCaption (const QString &c)

void	setContentsMargins (int left, int top, int right, int bottom)

void	setContentsMargins (const QMargins &margins)

void	setContextMenuPolicy (Qt::ContextMenuPolicy policy)

void	setCursor (const QCursor &)

void	setDisabled (bool disable)

void	setEditFocus (bool enable)

void	setEnabled (bool)

void	setEraseColor (const QColor &color)

void	setErasePixmap (const QPixmap &pixmap)

void	setFixedHeight (int h)

void	setFixedSize (const QSize &s)

void	setFixedSize (int w, int h)

void	setFixedWidth (int w)

void	setFocus (Qt::FocusReason reason)

void	setFocus ()

void	setFocusPolicy (Qt::FocusPolicy policy)

void	setFocusProxy (QWidget *w)

void	setFont (const QFont &)

void	setFont (const QFont &f, bool b)

void	setForegroundRole (QPalette::ColorRole role)

void	setGeometry (int x, int y, int w, int h)

void	setGeometry (const QRect &)

void	setGraphicsEffect (QGraphicsEffect *effect)

void	setHidden (bool hidden)

void	setIcon (const QPixmap &i)

void	setIconText (const QString &it)

void	setInputContext (QInputContext *context)

void	setInputMethodEnabled (bool enabled)

void	setInputMethodHints (QFlags< Qt::InputMethodHint > hints)

void	setKeyCompression (bool b)

void	setLayout (QLayout *layout)

void	setLayoutDirection (Qt::LayoutDirection direction)

void	setLocale (const QLocale &locale)

void	setMask (const QBitmap &bitmap)

void	setMask (const QRegion &region)

void	setMaximumHeight (int maxh)

void	setMaximumSize (const QSize &)

void	setMaximumSize (int maxw, int maxh)

void	setMaximumWidth (int maxw)

void	setMinimumHeight (int minh)

void	setMinimumSize (int minw, int minh)

void	setMinimumSize (const QSize &)

void	setMinimumWidth (int minw)

void	setMouseTracking (bool enable)

void	setPalette (const QPalette &)

void	setPalette (const QPalette &p, bool b)

void	setPaletteBackgroundColor (const QColor &color)

void	setPaletteBackgroundPixmap (const QPixmap &pixmap)

void	setPaletteForegroundColor (const QColor &color)

void	setParent (QWidget *parent)

void	setParent (QWidget *parent, QFlags< Qt::WindowType > f)

void	setPlatformWindow (QPlatformWindow *window)

void	setPlatformWindowFormat (const QPlatformWindowFormat &format)

void	setShortcutAutoRepeat (int id, bool enable)

void	setShortcutEnabled (int id, bool enable)

void	setShown (bool shown)

void	setSizeIncrement (const QSize &)

void	setSizeIncrement (int w, int h)

void	setSizePolicy (QSizePolicy::Policy hor, QSizePolicy::Policy ver, bool hfw)

void	setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)

void	setSizePolicy (QSizePolicy)

void	setStatusTip (const QString &)

void	setStyle (QStyle *style)

QStyle *	setStyle (const QString &style)

void	setStyleSheet (const QString &styleSheet)

void	setToolTip (const QString &)

void	setUpdatesEnabled (bool enable)

void	setupUi (QWidget *widget)

virtual void	setVisible (bool visible)

void	setWhatsThis (const QString &)

void	setWindowFilePath (const QString &filePath)

void	setWindowFlags (QFlags< Qt::WindowType > type)

void	setWindowIcon (const QIcon &icon)

void	setWindowIconText (const QString &)

void	setWindowModality (Qt::WindowModality windowModality)

void	setWindowModified (bool)

void	setWindowOpacity (qreal level)

void	setWindowRole (const QString &role)

void	setWindowState (QFlags< Qt::WindowState > windowState)

void	setWindowSurface (QWindowSurface *surface)

void	setWindowTitle (const QString &)

void	show ()

void	showFullScreen ()

void	showMaximized ()

void	showMinimized ()

void	showNormal ()

QSize	size () const

QSize	sizeIncrement () const

QSizePolicy	sizePolicy () const

void	stackUnder (QWidget *w)

QString	statusTip () const

QStyle *	style () const

QString	styleSheet () const

bool	testAttribute (Qt::WidgetAttribute attribute) const

QString	toolTip () const

QWidget *	topLevelWidget () const

bool	underMouse () const

void	ungrabGesture (Qt::GestureType gesture)

void	unsetCursor ()

void	unsetFont ()

void	unsetLayoutDirection ()

void	unsetLocale ()

void	unsetPalette ()

void	update (const QRect &rect)

void	update (const QRegion &rgn)

void	update (int x, int y, int w, int h)

void	update ()

void	updateGeometry ()

bool	updatesEnabled () const

QRect	visibleRect () const

QRegion	visibleRegion () const

QString	whatsThis () const

int	width () const

QWidget *	window () const

QString	windowFilePath () const

Qt::WindowFlags	windowFlags () const

QIcon	windowIcon () const

QString	windowIconText () const

Qt::WindowModality	windowModality () const

qreal	windowOpacity () const

QString	windowRole () const

Qt::WindowStates	windowState () const

QWindowSurface *	windowSurface () const

QString	windowTitle () const

Qt::WindowType	windowType () const

WId	winId () const

int	x () const

const QX11Info &	x11Info () const

Qt::HANDLE	x11PictureHandle () const

int	y () const

Public Member Functions inherited from QObject
	QObject (QObject *parent)

	QObject (QObject parent, const char name)

virtual	~QObject ()

bool	blockSignals (bool block)

QObject *	child (const char objName, const char inheritsClass, bool recursiveSearch) const

const QObjectList &	children () const

const char *	className () const

bool	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const QObject receiver, const char method)

bool	disconnect (const char signal, const QObject receiver, const char *method)

void	dumpObjectInfo ()

void	dumpObjectTree ()

QList< QByteArray >	dynamicPropertyNames () const

T	findChild (const QString &name) const

QList< T >	findChildren (const QRegExp &regExp) const

QList< T >	findChildren (const QString &name) const

bool	inherits (const char *className) const

void	insertChild (QObject *object)

void	installEventFilter (QObject *filterObj)

bool	isA (const char *className) const

bool	isWidgetType () const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

const char *	name () const

const char *	name (const char *defaultName) const

QString	objectName () const

QObject *	parent () const

QVariant	property (const char *name) const

void	removeChild (QObject *object)

void	removeEventFilter (QObject *obj)

void	setName (const char *name)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const

int	startTimer (int interval)

QThread *	thread () const

Public Member Functions inherited from QPaintDevice
virtual	~QPaintDevice ()

int	colorCount () const

int	depth () const

int	height () const

int	heightMM () const

int	logicalDpiX () const

int	logicalDpiY () const

int	numColors () const

virtual QPaintEngine *	paintEngine () const =0

bool	paintingActive () const

int	physicalDpiX () const

int	physicalDpiY () const

int	width () const

int	widthMM () const

int	x11Cells () const

Qt::HANDLE	x11Colormap () const

bool	x11DefaultColormap () const

bool	x11DefaultVisual () const

int	x11Depth () const

Display *	x11Display () const

int	x11Screen () const

void *	x11Visual () const

Protected Member Functions
virtual void	about ()

Alignment	alignment () const

virtual void	alignmentChange (Alignment)

bool	eventFilter (QObject , QEvent )

virtual void	help ()

void	needsFocus (bool focus)

Qt::Orientation	orientation () const

virtual void	orientationChange (Qt::Orientation)

Position	popupDirection ()

virtual void	popupDirectionChange (Position)

Position	position () const

virtual void	positionChange (Position p)

virtual void	preferences ()

virtual void	reportBug ()

void	setCustomMenu (const QMenu *)

void	watchForFocus (QWidget *widget, bool watch=true)

Protected Member Functions inherited from QFrame
virtual void	changeEvent (QEvent *ev)

virtual bool	event (QEvent *e)

virtual void	paintEvent (QPaintEvent *)

Protected Member Functions inherited from QWidget
virtual void	actionEvent (QActionEvent *event)

virtual void	closeEvent (QCloseEvent *event)

virtual void	contextMenuEvent (QContextMenuEvent *event)

void	create (WId window, bool initializeWindow, bool destroyOldWindow)

void	destroy (bool destroyWindow, bool destroySubWindows)

virtual void	dragEnterEvent (QDragEnterEvent *event)

virtual void	dragLeaveEvent (QDragLeaveEvent *event)

virtual void	dragMoveEvent (QDragMoveEvent *event)

virtual void	dropEvent (QDropEvent *event)

virtual void	enterEvent (QEvent *event)

virtual void	focusInEvent (QFocusEvent *event)

bool	focusNextChild ()

virtual bool	focusNextPrevChild (bool next)

virtual void	focusOutEvent (QFocusEvent *event)

bool	focusPreviousChild ()

virtual void	hideEvent (QHideEvent *event)

virtual void	inputMethodEvent (QInputMethodEvent *event)

virtual void	keyPressEvent (QKeyEvent *event)

virtual void	keyReleaseEvent (QKeyEvent *event)

virtual void	languageChange ()

virtual void	leaveEvent (QEvent *event)

virtual bool	macEvent (EventHandlerCallRef caller, EventRef event)

virtual int	metric (PaintDeviceMetric m) const

virtual void	mouseDoubleClickEvent (QMouseEvent *event)

virtual void	mouseMoveEvent (QMouseEvent *event)

virtual void	mousePressEvent (QMouseEvent *event)

virtual void	mouseReleaseEvent (QMouseEvent *event)

virtual void	moveEvent (QMoveEvent *event)

virtual bool	qwsEvent (QWSEvent *event)

void	resetInputContext ()

virtual void	resizeEvent (QResizeEvent *event)

virtual void	showEvent (QShowEvent *event)

virtual void	tabletEvent (QTabletEvent *event)

void	updateMicroFocus ()

virtual void	wheelEvent (QWheelEvent *event)

virtual bool	winEvent (MSG message, long result)

virtual bool	x11Event (XEvent *event)

Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char signal, const QObject object, const char *method)

virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const char *signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const char *signal)

int	receivers (const char *signal) const

QObject *	sender () const

int	senderSignalIndex () const

virtual void	timerEvent (QTimerEvent *event)

Protected Member Functions inherited from QPaintDevice
	QPaintDevice ()

Protected Attributes
Private *	d

Additional Inherited Members
Static Public Member Functions inherited from QWidget
QWidget *	find (WId id)

QWidget *	keyboardGrabber ()

QWidget *	mouseGrabber ()

void	setTabOrder (QWidget first, QWidget second)

QWidgetMapper *	wmapper ()

Static Public Member Functions inherited from QObject
bool	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

bool	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Static Public Member Functions inherited from QPaintDevice
int	x11AppCells (int screen)

Qt::HANDLE	x11AppColormap (int screen)

bool	x11AppDefaultColormap (int screen)

bool	x11AppDefaultVisual (int screen)

int	x11AppDepth (int screen)

Display *	x11AppDisplay ()

int	x11AppDpiX (int screen)

int	x11AppDpiY (int screen)

Qt::HANDLE	x11AppRootWindow (int screen)

int	x11AppScreen ()

void *	x11AppVisual (int screen)

void	x11SetAppDpiX (int dpi, int screen)

void	x11SetAppDpiY (int dpi, int screen)

Public Attributes inherited from QWidget
typedef	RenderFlags

Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)

Properties inherited from QFrame
	frameRect

	frameShadow

	frameShape

	frameWidth

	lineWidth

	midLineWidth

Properties inherited from QWidget
	acceptDrops

	accessibleDescription

	accessibleName

	autoFillBackground

	baseSize

	childrenRect

	childrenRegion

	contextMenuPolicy

	cursor

	enabled

	focus

	focusPolicy

	font

	frameGeometry

	frameSize

	fullScreen

	geometry

	height

	inputMethodHints

	isActiveWindow

	layoutDirection

	locale

	maximized

	maximumHeight

	maximumSize

	maximumWidth

	minimized

	minimumHeight

	minimumSize

	minimumSizeHint

	minimumWidth

	modal

	mouseTracking

	normalGeometry

	palette

	pos

	rect

	size

	sizeHint

	sizeIncrement

	sizePolicy

	statusTip

	styleSheet

	toolTip

	updatesEnabled

	visible

	whatsThis

	width

	windowFilePath

	windowFlags

	windowIcon

	windowIconText

	windowModality

	windowModified

	windowOpacity

	windowTitle

	x

	y

Properties inherited from QObject
	objectName

Detailed Description

KDE Panel Applet class

Panel applets

Are small applications living in the KDE panel.
Are implemented as DSOs (Dynamic Shared Objects).

Note: For security and stability reasons the panel won't load untrusted third party applets directly into its namespace but via an external wrapper process.

The panel locates available applets by searching for applet desktop files in (ALL_DIRS)/share/apps/kicker/applets. Every panel applet should install a desktop file there to be recognized by the panel.

Besides standard keys like "Name", "Comment" and "Icon" there are two panel applet specific keys:

X-KDE-Library
Used by the panel to locate the applet DSO (Dynamic Shared Object) Example: X-KDE-Library=libexampleapplet

X-KDE-UniqueApplet
Similar to KApplication and KUniqueApplication there are two types of panel applets. Use unique applets when it makes no sence to run more than one instance of a applet in the panel. A good example for unique applets is the taskbar applet. Use normal applets when you need instance specific configuration. An example is the koolclock applet where you might want to run two instances in your panel, one configured as analog clock, the other one as digital clock. X-KDE-UniqueApplet is a boolean key which defaults to "false". Example: X-KDE-UniqueApplet=true

Back to panel applet DSOs, the following conventions are used for KDE: Name: lib<appletname>applet.la LDFLAGS: -module -no-undefined

To implement a panel applet it is not enough to write a class inheriting from K3PanelApplet but you also have to provide a factory function in your DSO. A sample factory function could look like this:

extern "C"
{
    K3PanelApplet* init(QWidget *parent, const QString& configFile)
    {
        KGlobal::locale()->insertCatalog("exampleapplet");
        return new ExampleApplet(configFile, K3PanelApplet::Normal,
                      K3PanelApplet::About | K3PanelApplet::Help | K3PanelApplet::Preferences,
                      parent, "exampleapplet");
    }
}

Note: Don't change the factory function signature or the panel will fail to load your applet.

Author: Matthias Elter elter.nosp@m.@kde.nosp@m..org

Definition at line 98 of file k3panelapplet.h.

Member Enumeration Documentation

enum K3PanelApplet::Action

Enumerator
About
Help
Preferences
ReportBug

Definition at line 104 of file k3panelapplet.h.

enum K3PanelApplet::Alignment

Enumerator
LeftTop
Center
RightBottom

Definition at line 106 of file k3panelapplet.h.

enum K3PanelApplet::Position

Enumerator
Left
Right
Up
Down
Top
Bottom
Floating

Definition at line 105 of file k3panelapplet.h.

enum K3PanelApplet::Type

Enumerator
Normal
Stretch

Definition at line 103 of file k3panelapplet.h.

Constructor & Destructor Documentation

K3PanelApplet::K3PanelApplet	(	const QString &	configFile,
		K3PanelApplet::Type	type = `Normal`,
		int	actions = `0`,
		QWidget *	parent = `0`,
		Qt::WindowFlags	f = `0`
	)

explicit

Constructs a K3PanelApplet just like any other widget.

Parameters

configFile	The configFile handed over in the factory function.
t	The applet type().
actions	Standard RMB menu actions supported by the applet (see action() ).
parent	The pointer to the parent widget handed over in the factory function.
f	Window control flags

Definition at line 51 of file k3panelapplet.cpp.

K3PanelApplet::~K3PanelApplet ( )

Destructor.

Definition at line 70 of file k3panelapplet.cpp.

Member Function Documentation

virtual void K3PanelApplet::about ( )

inlineprotectedvirtual

Is called when the user selects "About" from the applet's RMB menu.

Reimplement this function to launch a about dialog.

Note that this is called only when your applet supports the About action. See Action and K3PanelApplet().

Definition at line 260 of file k3panelapplet.h.

void K3PanelApplet::action ( Action a )

virtual

Generic action dispatcher.

Called when the user selects an item from the applet's RMB menu.

Reimplement this function to handle actions.

For About, Help, Preferences and ReportBug, use the convenience handlers ref about(), help(), preferences(), reportBug()

Definition at line 153 of file k3panelapplet.cpp.

int K3PanelApplet::actions ( ) const

Returns: int indicating the supported RMB menu actions. Action

Definition at line 87 of file k3panelapplet.cpp.

K3PanelApplet::Alignment K3PanelApplet::alignment ( ) const

protected

Returns: the applet's alignment. (top/left, center, or bottom/right)

Definition at line 148 of file k3panelapplet.cpp.

virtual void K3PanelApplet::alignmentChange ( Alignment )

inlineprotectedvirtual

The panel on which this applet resides has changed its alignment.

Reimplement this change handler in order to adjust the look of your applet.

Definition at line 315 of file k3panelapplet.h.

KConfig * K3PanelApplet::config ( ) const

Always use this KConfig object to save/load your applet's configuration.

For unique applets this config object will write to a config file called <appletname>rc in the user's local KDE directory.

For normal applets this config object will write to a instance specific config file called <appletname><instanceid>rc in the user's local KDE directory.

Definition at line 77 of file k3panelapplet.cpp.

const QMenu * K3PanelApplet::customMenu ( ) const

Returns: the applet's custom menu, usually the same as the context menu, or 0 if none see setCustomMenu(QMenu*)

Definition at line 173 of file k3panelapplet.cpp.

bool K3PanelApplet::eventFilter	(	QObject *	o,
		QEvent *	e
	)

protectedvirtual

Reimplemented from QObject.

Definition at line 216 of file k3panelapplet.cpp.

virtual int K3PanelApplet::heightForWidth ( int width ) const

inlinevirtual

Returns: A suggested height for a given width.

Every applet should reimplement this function.

Depending on the panel orientation the height (horizontal panel) or the width (vertical panel) of the applets is fixed. The exact values of the fixed size component depend on the panel size.

On a vertical panel the applet width is fixed, the panel will call heightForWidth(int width) with width equal to 'the fixed applet width' when laying out the applets.

The applet can now choose the other size component (height) based on the given width.

The height you return is granted.

Reimplemented from QWidget.

Definition at line 165 of file k3panelapplet.h.

virtual void K3PanelApplet::help ( )

inlineprotectedvirtual

Is called when the user selects "Help" from the applet's RMB menu.

Reimplement this function to launch a manual or help page.

Note that this is called only when your applet supports the Help action. See Action and K3PanelApplet().

Definition at line 269 of file k3panelapplet.h.

void K3PanelApplet::needsFocus ( bool focus )

protected

Call this whenever focus is needed or not needed.

You do not have to call this method for widgets that have been registered with watchForFocus

Parameters

focus whether to or not to request focus

Definition at line 205 of file k3panelapplet.cpp.

Qt::Orientation K3PanelApplet::orientation ( ) const

protected

Returns: the applet's orientation. (horizontal or vertical)

Definition at line 131 of file k3panelapplet.cpp.

virtual void K3PanelApplet::orientationChange ( Qt::Orientation )

inlineprotectedvirtual

The orientation changed to orientation.

Reimplement this change handler in order to adjust the look of your applet.

Deprecated:: Reimplement positionChange instead.

Definition at line 350 of file k3panelapplet.h.

K3PanelApplet::Position K3PanelApplet::popupDirection ( )

protected

A convenience method that translates the position of the applet into which direction to show a popup.

Definition at line 116 of file k3panelapplet.cpp.

virtual void K3PanelApplet::popupDirectionChange ( Position )

inlineprotectedvirtual

The popup direction changed to direction.

Reimplement this change handler in order to adjust the look of your applet.

Deprecated:: Reimplement positionChange instead.

Definition at line 365 of file k3panelapplet.h.

K3PanelApplet::Position K3PanelApplet::position ( ) const

protected

Returns: the applet's position. (top, left, bottom, or right)

Definition at line 143 of file k3panelapplet.cpp.

void K3PanelApplet::positionChange ( K3PanelApplet::Position p )

protectedvirtual

The panel on which this applet resides has changed its position.

Reimplement this change handler in order to adjust the look of your applet.

Definition at line 107 of file k3panelapplet.cpp.

virtual void K3PanelApplet::preferences ( )

inlineprotectedvirtual

Is called when the user selects "Preferences" from the applet's RMB menu.

Reimplement this function to launch a preferences dialog or kcontrol module.

Note that this is called only when your applet supports the preferences action. See Action and K3PanelApplet().

Definition at line 278 of file k3panelapplet.h.

virtual void K3PanelApplet::reportBug ( )

inlineprotectedvirtual

Is called when the user selects "Report bug" from the applet's RMB menu.

Reimplement this function to launch a bug reporting dialog.

Note that this is called only when your applet supports the ReportBug action. See Action and K3PanelApplet()

Definition at line 288 of file k3panelapplet.h.

void K3PanelApplet::requestFocus ( )

signal

Request keyboard focus from the panel.

Deprecated:

void K3PanelApplet::requestFocus ( bool focus )

signal

Request keyboard focus from the panel.

Applets should never call this directly but rather call needsFocus(bool)

See also: needsFocus

Parameters

focus activate the window and ensure the panel remains visible when true Each and ever time a requestFocus(true) is emitted, it MUST be paired eventually with a requestFocus(false) otherwise the panel may end up never hiding

void K3PanelApplet::setAlignment ( K3PanelApplet::Alignment a )

Definition at line 99 of file k3panelapplet.cpp.

void K3PanelApplet::setCustomMenu ( const QMenu * menu )

protected

Use this method to set the custom menu for this applet so that it can be shown in the applet handle menu and other appropriate places that the applet many not itself be aware of.

The applet itself is still responsible for deleting and managing the the menu.

If the menu is deleted during the life of the applet, be sure to call this method again with the new menu (or 0) to avoid crashes

Definition at line 178 of file k3panelapplet.cpp.

void K3PanelApplet::setPosition ( K3PanelApplet::Position p )

Definition at line 92 of file k3panelapplet.cpp.

KSharedConfig::Ptr K3PanelApplet::sharedConfig ( ) const

Definition at line 234 of file k3panelapplet.cpp.

K3PanelApplet::Type K3PanelApplet::type ( ) const

Returns: Type indicating the applet's type. Type

Definition at line 82 of file k3panelapplet.cpp.

void K3PanelApplet::updateLayout ( )

signal

Emit this signal to make the panel relayout all applets, when you want to change your width (horizontal panel) or height (vertical panel).

The panel is going to relayout all applets based on their widthForHeight(int height) (horizontal panel) or heightForWidth(int width) (vertical panel).

Please note that the panel may change the applet's location if the new widthForHeight(int height) (horizontal panel) or heightForWidth(int width) (vertical panel) does not fit into the current panel layout.

void K3PanelApplet::watchForFocus	(	QWidget *	widget,
		bool	watch = `true`
	)

protected

Register widgets that can receive keyboard focus with this this method This call results in an eventFilter being places on the widget.

Parameters

widget	the widget to watch for keyboard focus
watch	whether to start watching the widget, or to stop doing so

Definition at line 183 of file k3panelapplet.cpp.

virtual int K3PanelApplet::widthForHeight ( int height ) const

inlinevirtual

Returns a suggested width for a given height.

Every applet should reimplement this function.

Depending on the panel orientation the height (horizontal panel) or the width (vertical panel) of the applets is fixed. The exact values of the fixed size component depend on the panel size.

On a horizontal panel the applet height is fixed, the panel will call widthForHeight(int height) with height equal to 'the fixed applet height' when laying out the applets.

The applet can now choose the other size component (width) based on the given height.

The width you return is granted.

Definition at line 144 of file k3panelapplet.h.

Member Data Documentation

Private* K3PanelApplet::d

protected

Definition at line 370 of file k3panelapplet.h.

The documentation for this class was generated from the following files:

KDE3Support

Public Types

Signals

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

KDE3Support

kdelibs API Reference

Search