summaryrefslogtreecommitdiff
path: root/noncore/settings/networksettings/module.h
Side-by-side diff
Diffstat (limited to 'noncore/settings/networksettings/module.h') (more/less context) (ignore whitespace changes)
-rw-r--r--noncore/settings/networksettings/module.h12
1 files changed, 12 insertions, 0 deletions
diff --git a/noncore/settings/networksettings/module.h b/noncore/settings/networksettings/module.h
index 3ef823c..9dc913e 100644
--- a/noncore/settings/networksettings/module.h
+++ b/noncore/settings/networksettings/module.h
@@ -65,78 +65,90 @@ public:
* and the name of the qcop call
*/
virtual const QString type() = 0;
/**
* The current profile has been changed and the module should do any
* neccesary changes also.
* As of Opie1.0 profiles are disabled.
*
* @param newProfile what the profile should be changed to.
*/
virtual void setProfile(const QString &newProfile) = 0;
/**
* get the icon name for this device.
* @param Interface* can be used in determining the icon.
* @return QString the icon name (minus .png, .gif etc)
*/
virtual QString getPixmapName(Interface *) = 0;
/**
* Check to see if the interface i is owned by this module.
* See if you can handle it. And if you can claim ownership
* by returning true.
+ * For physical devices you will be asked if you want to own the
+ * device. But you can also create new \sa Interface Implementations.
+ *
+ * If you want to own the Interface add it to your internal interface
+ * list
+ *
* @param Interface* interface to check against
* @return bool true if i is owned by this module, false otherwise.
+ *
+ * @see getInterfaces
*/
virtual bool isOwner(Interface *){ return false; };
/**
* Create and return the Configure Module
* @param Interface *i the interface to configure.
* @return QWidget* pointer to this modules configure.
*
* @see InterfaceSetupImp
*/
virtual QWidget *configure(Interface *){ return NULL; } ;
/**
* Create, and return the Information Module.
*
* An default Implementation is InterfaceInformationImp
*
* @param Interface *i the interface to get info on.
* @return QWidget* pointer to this modules info.
*
* @see InterfaceInformationImp
*
*/
virtual QWidget *information(Interface *){ return NULL; };
/**
* Get all active (up or down) interfaces managed by this
* module.
+ * At the end of initialisation you will be asked to return your interfaces
+ * Return all of your interfaces even the ones you claimed by isOnwer.
+ * Here you can also return your 'virtual' Interface Objects
+ *
* @return QList<Interface> A list of interfaces that exsist that havn't
* been called by isOwner()
*/
virtual QList<Interface> getInterfaces() = 0;
/**
* Adds possible new interfaces to the list (Example: usb(ppp), ir(ppp),
* modem ppp)
* Both strings need to be translated. The first string is a Shortcut
* like PPP and the second argument is a description.
*
* <code>
* list.insert(
*
* </code>
*
* @param list A reference to the list of supported additionns.
*/
virtual void possibleNewInterfaces(QMap<QString, QString> &list) = 0;
/**
* Attempts to create a new interface from name you gave
* possibleNewInterfaces()
* @return Interface* NULL if it was unable to be created.