org.kde.koala

Class KPanelApplet

public class KPanelApplet extends QFrame

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 booleanean key which defaults to "false". Example: X-KDE-UniqueApplet=true Back to panel applet DSOs, the following conventions are used for %KDE: Name: libapplet.la LDFLAGS: -module -no-undefined To implement a panel applet it is not enough to write a class inheriting from KPanelApplet but you also have to provide a factory function in your DSO. A sample factory function could look like this:
     extern "C"
     {
         KPanelApplet init(QWidget parent, String configFile)
         {
             KGlobal.locale().insertCatalogue("exampleapplet");
             return new ExampleApplet(configFile, KPanelApplet.Normal,
                           KPanelApplet.About | KPanelApplet.Help | KPanelApplet.Preferences,
                           parent, "exampleapplet");
         }
     }
     
    Note: Don't change the factory function signature or the panel will fail to load your applet. See KPanelAppletSignals for signals emitted by KPanelApplet

    Author: Matthias Elter

    UNKNOWN: %KDE Panel Applet class.

    Field Summary
    static intAbout
    This enum holds flags which can be ORed together to describe which items the context menu over the applet handle contains.
    static intCenter
    static intDown
    static intHelp
    static intLeft
    static intLeftTop
    static intNormal
    This enum describes the type of the applet.
    static intpBottom
    static intpLeft
    static intpRight
    static intpTop
    static intPreferences
    static intReportBug
    static intRight
    static intRightBottom
    static intStretch
    static intUp
    Constructor Summary
    protected KPanelApplet(Class dummy)
    KPanelApplet(String configFile, int t, int actions, QWidget parent, String name, int f)
    Constructs a KPanelApplet just like any other widget.
    KPanelApplet(String configFile, int t, int actions, QWidget parent, String name)
    KPanelApplet(String configFile, int t, int actions, QWidget parent)
    KPanelApplet(String configFile, int t, int actions)
    KPanelApplet(String configFile, int t)
    KPanelApplet(String configFile)
    Method Summary
    protected voidabout()
    Is called when the user selects "About" from the applet's RMB menu.
    voidaction(int a)
    Generic action dispatcher.
    intactions()
    protected intalignment()
    protected voidalignmentChange(int arg1)
    The panel on which this applet resides has changed its alignment.
    StringclassName()
    KConfigconfig()
    Always use this KConfig object to save/load your applet's configuration.
    QPopupMenucustomMenu()
    voiddispose()
    Delete the wrapped C++ instance ahead of finalize()
    booleaneventFilter(QObject arg1, QEvent arg2)
    protected voidfinalize()
    Deletes the wrapped C++ instance
    intheightForWidth(int width)
    Every applet should reimplement this function.
    protected voidhelp()
    Is called when the user selects "Help" from the applet's RMB menu.
    booleanisDisposed()
    Has the wrapped C++ instance been deleted?
    QMetaObjectmetaObject()
    protected voidneedsFocus(boolean focus)
    Call this whenever focus is needed or not needed.
    protected intorientation()
    protected intpopupDirection()
    A convenience method that translates the position of the applet into which direction to show a popup.
    protected intposition()
    protected voidpositionChange(int p)
    The panel on which this applet resides has changed its position.
    protected voidpreferences()
    Is called when the user selects "Preferences" from the applet's RMB menu.
    protected voidreportBug()
    Is called when the user selects "Report bug" from the applet's RMB menu.
    voidsetAlignment(int a)
    protected voidsetCustomMenu(QPopupMenu arg1)
    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.
    voidsetPosition(int p)
    inttype()
    protected voidwatchForFocus(QWidget widget, boolean watch)
    Register widgets that can receive keyboard focus with this this method This call results in an eventFilter being places on the widget.
    protected voidwatchForFocus(QWidget widget)
    intwidthForHeight(int height)
    Returns a suggested width for a given height.

    Field Detail

    About

    public static final int About
    This enum holds flags which can be ORed together to describe which items the context menu over the applet handle contains.

    UNKNOWN: This enum holds flags which can be ORed together to describe which items the context menu over the applet handle contains.

    Center

    public static final int Center

    Down

    public static final int Down

    Help

    public static final int Help

    Left

    public static final int Left

    LeftTop

    public static final int LeftTop

    Normal

    public static final int Normal
    This enum describes the type of the applet.

    UNKNOWN: This enum describes the type of the applet.

    pBottom

    public static final int pBottom

    pLeft

    public static final int pLeft

    pRight

    public static final int pRight

    pTop

    public static final int pTop

    Preferences

    public static final int Preferences

    ReportBug

    public static final int ReportBug

    Right

    public static final int Right

    RightBottom

    public static final int RightBottom

    Stretch

    public static final int Stretch

    Up

    public static final int Up

    Constructor Detail

    KPanelApplet

    protected KPanelApplet(Class dummy)

    KPanelApplet

    public KPanelApplet(String configFile, int t, int actions, QWidget parent, String name, int f)
    Constructs a KPanelApplet 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. name A Qt object name for your applet. f Window control flags

    UNKNOWN: Constructs a KPanelApplet just like any other widget.

    KPanelApplet

    public KPanelApplet(String configFile, int t, int actions, QWidget parent, String name)

    KPanelApplet

    public KPanelApplet(String configFile, int t, int actions, QWidget parent)

    KPanelApplet

    public KPanelApplet(String configFile, int t, int actions)

    KPanelApplet

    public KPanelApplet(String configFile, int t)

    KPanelApplet

    public KPanelApplet(String configFile)

    Method Detail

    about

    protected void about()
    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 KPanelApplet().

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

    action

    public void action(int a)
    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()

    UNKNOWN: Generic action dispatcher.

    actions

    public int actions()

    Returns: int indicating the supported RMB menu actions. Action

    UNKNOWN:

    alignment

    protected int alignment()

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

    UNKNOWN:

    alignmentChange

    protected void alignmentChange(int arg1)
    The panel on which this applet resides has changed its alignment. Reimplement this change handler in order to adjust the look of your applet.

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

    className

    public String className()

    config

    public KConfig config()
    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 \rc in the user's local %KDE directory. For normal applets this config object will write to a instance specific config file called \\rc in the user's local %KDE directory.

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

    customMenu

    public QPopupMenu customMenu()

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

    UNKNOWN:

    dispose

    public void dispose()
    Delete the wrapped C++ instance ahead of finalize()

    eventFilter

    public boolean eventFilter(QObject arg1, QEvent arg2)

    finalize

    protected void finalize()
    Deletes the wrapped C++ instance

    heightForWidth

    public int heightForWidth(int 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.

    Returns: A suggested height for a given width.

    UNKNOWN:

    help

    protected void help()
    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 KPanelApplet().

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

    isDisposed

    public boolean isDisposed()
    Has the wrapped C++ instance been deleted?

    metaObject

    public QMetaObject metaObject()

    needsFocus

    protected void needsFocus(boolean focus)
    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

    UNKNOWN: Call this whenever focus is needed or not needed.

    orientation

    protected int orientation()

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

    UNKNOWN:

    popupDirection

    protected int popupDirection()
    A convenience method that translates the position of the applet into which direction to show a popup.

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

    position

    protected int position()

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

    UNKNOWN:

    positionChange

    protected void positionChange(int p)
    The panel on which this applet resides has changed its position. Reimplement this change handler in order to adjust the look of your applet.

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

    preferences

    protected void preferences()
    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 KPanelApplet().

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

    reportBug

    protected void reportBug()
    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 KPanelApplet()

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

    setAlignment

    public void setAlignment(int a)

    UNKNOWN:

    setCustomMenu

    protected void setCustomMenu(QPopupMenu arg1)
    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

    UNKNOWN: 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.

    setPosition

    public void setPosition(int p)

    UNKNOWN:

    type

    public int type()

    Returns: Type indicating the applet's type. Type

    UNKNOWN:

    watchForFocus

    protected void watchForFocus(QWidget widget, boolean watch)
    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

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

    watchForFocus

    protected void watchForFocus(QWidget widget)

    widthForHeight

    public int widthForHeight(int height)
    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.

    UNKNOWN: Returns a suggested width for a given height.