#include "plugintypes.h"
Go to the source code of this file.
Functions | |
int | findObject (const char *object, const char *type) |
Finds a specific object by name, and optionally type. | |
const char * | typeOfObject (const char *object) |
Gets the type name of an object. | |
char * | getPropertyAsString (const char *object, const char *property) |
Gets the string value of a property. | |
int | setPropertyAsString (const char *object, const char *property, const char *value) |
Sets the string value of a property. | |
char * | callMethod (const char *object, const char *method, int numargs, const char *args[]) |
Calls a method on an object. | |
void | callMethodNoReturn (const char *object, const char *method, int numargs, const char *args[]) |
Calls a method on an object, when you don't care about the return value. | |
int | registerObject (const char *name) |
Registers a new custom object. | |
int | registerPropertyDL (const char *object, const char *property, const char *getter, const char *setter) |
Registers a property on a custom object. | |
int | registerEventHandlerDL (const char *object, const char *event, const char *eventfunc) |
Registers a handler for an event. | |
int | registerMethodDL (const char *object, const char *method, int numargs, const char *methodfunc) |
Registers a method on a custom object. | |
int | fireEvent (const char *object, const char *event) |
Fires an event on an object. | |
const struct plugin_info * | getPluginInfo (const char *name) |
Gets information on a loaded plugin. | |
void | setPluginInfo (const char *namestring, const char *verstring) |
Sets information for your plugin. | |
void | requestUnload (void) |
Tells eboxy that your plugin should be unloaded as soon as possible. | |
int | changePage (const char *pagename) |
Changes the current page. | |
int | loadXMLFile (const char *filename, const char *pagename) |
Loads a new XML file. | |
int | performAction (const char *actionname) |
Performs an eboxy action (see documentation for action list). | |
int | isPluginLoaded (const char *name) |
Checks if a plugin is loaded. | |
int | unregisterObject (const char *name) |
Unregisters a previously registered custom object. | |
int | unregisterEventHandlerDL (const char *object, const char *event) |
Unregisters a previously registered handler for an event. | |
int | createWidget (const char *name, const char *type, const char *templatename) |
Creates a widget at runtime. | |
int | createPage (const char *name) |
Creates a page at runtime. | |
int | cloneWidget (const char *original, const char *duplicate) |
Creates a copy of an existing widget at runtime. | |
int | deleteWidget (const char *name) |
Deletes a widget at runtime. | |
int | deletePage (const char *name) |
Deletes a page at runtime. | |
int | runScript (const char *code, int flags) |
Execute the specified eboxy script code. |
|
Calls a method on an object.
|
|
Calls a method on an object, when you don't care about the return value.
|
|
Changes the current page.
|
|
Creates a copy of an existing widget at runtime. Note that to actually make use of this widget, you will need to add it to the current page (possibly adjusting its property values beforehand).
|
|
Creates a page at runtime.
|
|
Creates a widget at runtime. Note that to actually make use of this widget, you will need to set its properties and then add it to the current page.
|
|
Deletes a page at runtime. The page you are deleting can be any page, dynamically created or otherwise, as long as it is not currently being displayed.
|
|
Deletes a widget at runtime. The widget cannot be added to a page at this time - you must remove it first.
|
|
Finds a specific object by name, and optionally type.
|
|
Fires an event on an object. Events can only be fired on objects that your plugin created.
|
|
Gets information on a loaded plugin.
|
|
Gets the string value of a property.
|
|
Checks if a plugin is loaded.
|
|
Loads a new XML file.
|
|
Performs an eboxy action (see documentation for action list).
|
|
Registers a handler for an event. Note: you will not get an error if you register for an event that will never be triggered, so be careful to type the name correctly.
|
|
Registers a method on a custom object. Methods can only be registered on objects that your plugin created.
|
|
Registers a new custom object.
|
|
Registers a property on a custom object. Properties can only be registered on objects that your plugin created.
|
|
Execute the specified eboxy script code.
|
|
Sets information for your plugin. This should only ever be called once, in your plugin's ebplugin_init function.
|
|
Sets the string value of a property.
|
|
Gets the type name of an object.
|
|
Unregisters a previously registered handler for an event. Note: it is not required that you unregister events - only if you wish to stop handling them for some reason but still keep the plugin running. (Event handlers are automatically unregistered when the plugin that owns them is unloaded).
|
|
Unregisters a previously registered custom object. Also unregisters properties, methods and event handlers registered on the object. Note: it is not required that you unregister objects you create - only if you wish to withdraw them from service for some reason but still keep the plugin running. (Objects are automatically unregistered when the plugin that owns them is unloaded).
|