Widgets Xml · Wiki · QUIQQER / Core

deprecated

Mit der widgets.xml können Sie eigene Widgets für den Desktop definieren. Widgets sind kleine Programme / Hilfen / Übersichten für das QUIQQER Desktop-Panel. Da der QUIQQER Desktop auch separat aufgerufen werden kann, sind Widgets nützliche kleine Helfer, die Ihnen das Arbeiten erleichtern können.

Legen Sie im root Verzeichnis Ihres Plugins eine widgets.xml Datei an. In dieser Datei definieren Sie neue Widgets.

Standardaufbau eines widgets.xml

<widgets>

    <widget>
        <title>PHP - Info</title>

        <attributes
            height="1"
            width="2"
            icon="icon-info-sign"
            refresh="1"
        />

        <content type="ajax" func="ajax_system_phpinfo"></content>
        <!--<content type="html"></content> -->
    </widget>

    <!-- Widget on another location -->
    <widget src="/path/to/my/widget/dir/widget.xml" />

</widgets>

<widgets> beginnt die Widgets XML
<widget> Definition eines einzelnen Widgets
<title> Titel eines Widgets. Dieser Titel wird in der Widget-Liste angezeigt
<attributes> Attribut des Widgets (Definiert unter anderem die Standardgröße)
<content> Definition des Widget-Inhalts

<widget>

Ein <widget> Node beginnt ein Widget. Sie können ein Widget auch in einer separaten Datei auslagern. Über das src="" -Attribut können Sie eine separate Datei angeben, in dem die Widget-Definition liegt.

Im Dateipfad können Sie die System-Konstanten verwenden, diese werden automatisiert ersetzt.

URL_BIN_DIR, URL_OPT_DIR, URL_USR_DIR, BIN_DIR, OPT_DIR, URL_DIR, SYS_DIR, CMS_DIR

Beispiel:

<widget src="OPT_DIRquiqqer/translator/widgets/first.xml" />

In der Widget-Datei kann nur ein einzelnes Widget definiert werden.

Beispiel:

<?xml version="1.0" encoding="UTF-8"?>
<widget>
    <title>Test Widget</title>

    <attributes
        height="1"
        width="1"
        icon="icon-user"
        refresh="1"
    />

    <content type="html">My Content</content>
</widget>

<attributes>

Ein Widget kann mehrere Attribute besitzen. Mit dem <attribute> Node können Sie das Aussehen und das Standardverhalten eines Widgets bestimmen.

Attribute

height="" Definieren Sie die Höhe des Widgets width="" Definieren Sie die Breite des Widgets

Höhe und breite werden in Feldern angegeben, ein Feld hat eine Dimension von 100px. Möchten Sie ein 400px breites und 200px hohes Widget anbieten, geben Sie als Höhe 4 und Breite 2 an.

icon="icon-info-sign" Sie können ein Icon für das Widget festlegen, welches bei der Auswahl der Widget-Liste angezeigt wird. Es werden Font Awesome Icons verwendet (http://fontawesome.io/),

refresh="1" Legt fest, ob das Widget ein refresh-Button besitzt.

<content>

Mit dem <content> Node bestimmen Sie wie das Widget seinen Inhalt erhält.

Reiner HTML Inhalt

<content type="html">
    <![CDATA[
        <b>my <u>html</u> text</b>
    ]]>
</content>

Inhalt per Ajax erhalten:

<content type="ajax" func="ajax_system_phpinfo"></content>

Das Widget ruft die ajax_system_phpinfo Funktion auf und fügt den Rückgabewert in das Widget ein. Die Ajax-Funktion muss HTML / Text zurückgeben.