4 files changed, 81 insertions, 8 deletions
diff --git a/noncore/settings/networksettings/interfaces/interfaceinformationimp.h b/noncore/settings/networksettings/interfaces/interfaceinformationimp.h index 9c93d1d..03da736 100644 --- a/noncore/settings/networksettings/interfaces/interfaceinformationimp.h +++ b/noncore/settings/networksettings/interfaces/interfaceinformationimp.h | |||
@@ -6,2 +6,6 @@ | |||
6 | 6 | ||
7 | /** | ||
8 | * This widget just shows some generic information about the | ||
9 | * given Interface. IP Addresses and such will be shown. | ||
10 | */ | ||
7 | class InterfaceInformationImp : public InterfaceInformation { | 11 | class InterfaceInformationImp : public InterfaceInformation { |
diff --git a/noncore/settings/networksettings/interfaces/interfacesetupimp.h b/noncore/settings/networksettings/interfaces/interfacesetupimp.h index 172da6a..f38fba5 100644 --- a/noncore/settings/networksettings/interfaces/interfacesetupimp.h +++ b/noncore/settings/networksettings/interfaces/interfacesetupimp.h | |||
@@ -9,2 +9,8 @@ class Interface; | |||
9 | 9 | ||
10 | /** | ||
11 | * A default implementation for setting up basic | ||
12 | * network config. Like DHCP, IP and other information. | ||
13 | * You can use it in a tab or in any other way* | ||
14 | * On saveChanges() it'll save the changes to Interfaces. | ||
15 | */ | ||
10 | class InterfaceSetupImp : public InterfaceSetup { | 16 | class InterfaceSetupImp : public InterfaceSetup { |
diff --git a/noncore/settings/networksettings/module.h b/noncore/settings/networksettings/module.h index 5cc82cd..3ef823c 100644 --- a/noncore/settings/networksettings/module.h +++ b/noncore/settings/networksettings/module.h | |||
@@ -15,5 +15,43 @@ class QTabWidget; | |||
15 | 15 | ||
16 | class Module : QObject{ | 16 | |
17 | /** | ||
18 | * \brief The basis of all plugins | ||
19 | * | ||
20 | * This is the way to extend networksettings with | ||
21 | * extra functionality. | ||
22 | * | ||
23 | * | ||
24 | * Networksettings in the 1.0 release does not use QCOM | ||
25 | * for activation. You need to provide the following function yourself. | ||
26 | * | ||
27 | * A module needs to provide Name, Images, and methods for | ||
28 | * claiming interfaces. For example you can claim physicla | ||
29 | * interfaces like wlan0, ppp0 or virtual like a VPN | ||
30 | * connection and hide the real ppp device or ethernet device | ||
31 | * behind your VPN plugin. | ||
32 | * | ||
33 | * During start up. The main application searches for network devices | ||
34 | * and then looks for an owner under the plugins for them. | ||
35 | * For example the WLAN Plugin looks if there is a WLAN Extension | ||
36 | * on that interface and then claims it by returning true from isOwner() | ||
37 | * | ||
38 | * \code | ||
39 | * extern "C" | ||
40 | * { | ||
41 | * void* create_plugin() { | ||
42 | * return new WLANModule(); | ||
43 | * } | ||
44 | * }; | ||
45 | * \endcode | ||
46 | * @see isOwner(Interface*) | ||
47 | */ | ||
48 | class Module : private QObject{ | ||
17 | 49 | ||
18 | signals: | 50 | signals: |
51 | /** | ||
52 | * Emit this Signal once you change the Interface | ||
53 | * you're operating on | ||
54 | * | ||
55 | * @param i The Interface | ||
56 | */ | ||
19 | void updateInterface(Interface *i); | 57 | void updateInterface(Interface *i); |
@@ -26,3 +64,3 @@ public: | |||
26 | * The type of the plugin | 64 | * The type of the plugin |
27 | * and the name of the dcop call | 65 | * and the name of the qcop call |
28 | */ | 66 | */ |
@@ -33,2 +71,4 @@ public: | |||
33 | * neccesary changes also. | 71 | * neccesary changes also. |
72 | * As of Opie1.0 profiles are disabled. | ||
73 | * | ||
34 | * @param newProfile what the profile should be changed to. | 74 | * @param newProfile what the profile should be changed to. |
@@ -46,2 +86,4 @@ public: | |||
46 | * Check to see if the interface i is owned by this module. | 86 | * Check to see if the interface i is owned by this module. |
87 | * See if you can handle it. And if you can claim ownership | ||
88 | * by returning true. | ||
47 | * @param Interface* interface to check against | 89 | * @param Interface* interface to check against |
@@ -52,5 +94,7 @@ public: | |||
52 | /** | 94 | /** |
53 | * Create and return the WLANConfigure Module | 95 | * Create and return the Configure Module |
54 | * @param Interface *i the interface to configure. | 96 | * @param Interface *i the interface to configure. |
55 | * @return QWidget* pointer to this modules configure. | 97 | * @return QWidget* pointer to this modules configure. |
98 | * | ||
99 | * @see InterfaceSetupImp | ||
56 | */ | 100 | */ |
@@ -59,5 +103,11 @@ public: | |||
59 | /** | 103 | /** |
60 | * Create, and return the Information Module | 104 | * Create, and return the Information Module. |
105 | * | ||
106 | * An default Implementation is InterfaceInformationImp | ||
107 | * | ||
61 | * @param Interface *i the interface to get info on. | 108 | * @param Interface *i the interface to get info on. |
62 | * @return QWidget* pointer to this modules info. | 109 | * @return QWidget* pointer to this modules info. |
110 | * | ||
111 | * @see InterfaceInformationImp | ||
112 | * | ||
63 | */ | 113 | */ |
@@ -66,3 +116,4 @@ public: | |||
66 | /** | 116 | /** |
67 | * Get all active (up or down) interfaces | 117 | * Get all active (up or down) interfaces managed by this |
118 | * module. | ||
68 | * @return QList<Interface> A list of interfaces that exsist that havn't | 119 | * @return QList<Interface> A list of interfaces that exsist that havn't |
@@ -75,2 +126,11 @@ public: | |||
75 | * modem ppp) | 126 | * modem ppp) |
127 | * Both strings need to be translated. The first string is a Shortcut | ||
128 | * like PPP and the second argument is a description. | ||
129 | * | ||
130 | * <code> | ||
131 | * list.insert( | ||
132 | * | ||
133 | * </code> | ||
134 | * | ||
135 | * @param list A reference to the list of supported additionns. | ||
76 | */ | 136 | */ |
@@ -79,5 +139,8 @@ public: | |||
79 | /** | 139 | /** |
80 | * Attempts to create a new interface from name | 140 | * Attempts to create a new interface from name you gave |
141 | * possibleNewInterfaces() | ||
81 | * @return Interface* NULL if it was unable to be created. | 142 | * @return Interface* NULL if it was unable to be created. |
82 | * @param name the type of interface to create | 143 | * @param name the type of interface to create |
144 | * | ||
145 | * @see possibleNewInterfaces | ||
83 | */ | 146 | */ |
@@ -101,3 +164,3 @@ protected: | |||
101 | * internally of this module.. An already running ppp link or | 164 | * internally of this module.. An already running ppp link or |
102 | * a tunnel... | 165 | * a tunnel... VPN an such |
103 | */ | 166 | */ |
diff --git a/noncore/settings/networksettings/ppp/pppmodule.cpp b/noncore/settings/networksettings/ppp/pppmodule.cpp index 2462fa4..f7dacf6 100644 --- a/noncore/settings/networksettings/ppp/pppmodule.cpp +++ b/noncore/settings/networksettings/ppp/pppmodule.cpp | |||
@@ -129,3 +129,3 @@ QWidget *PPPModule::configure(Interface *i){ | |||
129 | 0, "PPPConfig", false, | 129 | 0, "PPPConfig", false, |
130 | Qt::WDestructiveClose | Qt::WStyle_ContextHelp); | 130 | (Qt::WDestructiveClose | Qt::WStyle_ContextHelp)); |
131 | return pppconfig; | 131 | return pppconfig; |