Diffstat (limited to 'noncore/settings/networksettings/module.h') (more/less context) (ignore whitespace changes)
-rw-r--r-- | noncore/settings/networksettings/module.h | 12 |
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: | |||
65 | * and the name of the qcop call | 65 | * and the name of the qcop call |
66 | */ | 66 | */ |
67 | virtual const QString type() = 0; | 67 | virtual const QString type() = 0; |
68 | 68 | ||
69 | /** | 69 | /** |
70 | * The current profile has been changed and the module should do any | 70 | * The current profile has been changed and the module should do any |
71 | * neccesary changes also. | 71 | * neccesary changes also. |
72 | * As of Opie1.0 profiles are disabled. | 72 | * As of Opie1.0 profiles are disabled. |
73 | * | 73 | * |
74 | * @param newProfile what the profile should be changed to. | 74 | * @param newProfile what the profile should be changed to. |
75 | */ | 75 | */ |
76 | virtual void setProfile(const QString &newProfile) = 0; | 76 | virtual void setProfile(const QString &newProfile) = 0; |
77 | 77 | ||
78 | /** | 78 | /** |
79 | * get the icon name for this device. | 79 | * get the icon name for this device. |
80 | * @param Interface* can be used in determining the icon. | 80 | * @param Interface* can be used in determining the icon. |
81 | * @return QString the icon name (minus .png, .gif etc) | 81 | * @return QString the icon name (minus .png, .gif etc) |
82 | */ | 82 | */ |
83 | virtual QString getPixmapName(Interface *) = 0; | 83 | virtual QString getPixmapName(Interface *) = 0; |
84 | 84 | ||
85 | /** | 85 | /** |
86 | * 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 | 87 | * See if you can handle it. And if you can claim ownership |
88 | * by returning true. | 88 | * by returning true. |
89 | * For physical devices you will be asked if you want to own the | ||
90 | * device. But you can also create new \sa Interface Implementations. | ||
91 | * | ||
92 | * If you want to own the Interface add it to your internal interface | ||
93 | * list | ||
94 | * | ||
89 | * @param Interface* interface to check against | 95 | * @param Interface* interface to check against |
90 | * @return bool true if i is owned by this module, false otherwise. | 96 | * @return bool true if i is owned by this module, false otherwise. |
97 | * | ||
98 | * @see getInterfaces | ||
91 | */ | 99 | */ |
92 | virtual bool isOwner(Interface *){ return false; }; | 100 | virtual bool isOwner(Interface *){ return false; }; |
93 | 101 | ||
94 | /** | 102 | /** |
95 | * Create and return the Configure Module | 103 | * Create and return the Configure Module |
96 | * @param Interface *i the interface to configure. | 104 | * @param Interface *i the interface to configure. |
97 | * @return QWidget* pointer to this modules configure. | 105 | * @return QWidget* pointer to this modules configure. |
98 | * | 106 | * |
99 | * @see InterfaceSetupImp | 107 | * @see InterfaceSetupImp |
100 | */ | 108 | */ |
101 | virtual QWidget *configure(Interface *){ return NULL; } ; | 109 | virtual QWidget *configure(Interface *){ return NULL; } ; |
102 | 110 | ||
103 | /** | 111 | /** |
104 | * Create, and return the Information Module. | 112 | * Create, and return the Information Module. |
105 | * | 113 | * |
106 | * An default Implementation is InterfaceInformationImp | 114 | * An default Implementation is InterfaceInformationImp |
107 | * | 115 | * |
108 | * @param Interface *i the interface to get info on. | 116 | * @param Interface *i the interface to get info on. |
109 | * @return QWidget* pointer to this modules info. | 117 | * @return QWidget* pointer to this modules info. |
110 | * | 118 | * |
111 | * @see InterfaceInformationImp | 119 | * @see InterfaceInformationImp |
112 | * | 120 | * |
113 | */ | 121 | */ |
114 | virtual QWidget *information(Interface *){ return NULL; }; | 122 | virtual QWidget *information(Interface *){ return NULL; }; |
115 | 123 | ||
116 | /** | 124 | /** |
117 | * Get all active (up or down) interfaces managed by this | 125 | * Get all active (up or down) interfaces managed by this |
118 | * module. | 126 | * module. |
127 | * At the end of initialisation you will be asked to return your interfaces | ||
128 | * Return all of your interfaces even the ones you claimed by isOnwer. | ||
129 | * Here you can also return your 'virtual' Interface Objects | ||
130 | * | ||
119 | * @return QList<Interface> A list of interfaces that exsist that havn't | 131 | * @return QList<Interface> A list of interfaces that exsist that havn't |
120 | * been called by isOwner() | 132 | * been called by isOwner() |
121 | */ | 133 | */ |
122 | virtual QList<Interface> getInterfaces() = 0; | 134 | virtual QList<Interface> getInterfaces() = 0; |
123 | 135 | ||
124 | /** | 136 | /** |
125 | * Adds possible new interfaces to the list (Example: usb(ppp), ir(ppp), | 137 | * Adds possible new interfaces to the list (Example: usb(ppp), ir(ppp), |
126 | * modem ppp) | 138 | * modem ppp) |
127 | * Both strings need to be translated. The first string is a Shortcut | 139 | * Both strings need to be translated. The first string is a Shortcut |
128 | * like PPP and the second argument is a description. | 140 | * like PPP and the second argument is a description. |
129 | * | 141 | * |
130 | * <code> | 142 | * <code> |
131 | * list.insert( | 143 | * list.insert( |
132 | * | 144 | * |
133 | * </code> | 145 | * </code> |
134 | * | 146 | * |
135 | * @param list A reference to the list of supported additionns. | 147 | * @param list A reference to the list of supported additionns. |
136 | */ | 148 | */ |
137 | virtual void possibleNewInterfaces(QMap<QString, QString> &list) = 0; | 149 | virtual void possibleNewInterfaces(QMap<QString, QString> &list) = 0; |
138 | 150 | ||
139 | /** | 151 | /** |
140 | * Attempts to create a new interface from name you gave | 152 | * Attempts to create a new interface from name you gave |
141 | * possibleNewInterfaces() | 153 | * possibleNewInterfaces() |
142 | * @return Interface* NULL if it was unable to be created. | 154 | * @return Interface* NULL if it was unable to be created. |