K3PanelApplet Class Reference

#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

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 Attributes
Private *	d

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  )

protected

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.

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:

• k3panelapplet.h
• k3panelapplet.cpp