Updated documentation for 0.2 release
[mtetherd] / plugin.h
1 /*
2   mtetherd
3   (c) 2010 Gregor Riepl <onitake@gmail.com>
4   
5   Tethering utility for Maemo
6   
7   This program is free software: you can redistribute it and/or modify
8   it under the terms of the GNU General Public License as published by
9   the Free Software Foundation, either version 3 of the License, or
10   (at your option) any later version.
11   
12   This program is distributed in the hope that it will be useful,
13   but WITHOUT ANY WARRANTY; without even the implied warranty of
14   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15   GNU General Public License for more details.
16   
17   You should have received a copy of the GNU General Public License
18   along with this program.  If not, see <http://www.gnu.org/licenses/>.
19 */
20
21 #ifndef _MTETHERD_STATUS_H
22 #define _MTETHERD_STATUS_H
23
24 #include <libhal.h>
25 #include <libhildondesktop/libhildondesktop.h>
26 #include "net.h"
27
28 G_BEGIN_DECLS
29
30 // The logging domain for Glib log messages
31 const char *MTETHERD_LOG_DOMAIN;
32
33 #define TYPE_MTETHERD_STATUS_PLUGIN (mtetherd_status_plugin_get_type())
34 #define MTETHERD_STATUS_PLUGIN(object) (G_TYPE_CHECK_INSTANCE_CAST((object), TYPE_MTETHERD_STATUS_PLUGIN, MTetherDStatusPlugin))
35 #define MTETHERD_STATUS_PLUGIN_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), TYPE_MTETHERD_STATUS_PLUGIN, MTetherDStatusPluginClass))
36 #define IS_MTETHERD_STATUS_PLUGIN(object) (G_TYPE_CHECK_INSTANCE_TYPE((object), TYPE_MTETHERD_STATUS_PLUGIN))
37 #define IS_MTETHERD_STATUS_PLUGIN_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), TYPE_MTETHERD_STATUS_PLUGIN))
38 #define MTETHERD_STATUS_PLUGIN_GET_CLASS(object) (G_TYPE_INSTANCE_GET_CLASS((object), TYPE_MTETHERD_STATUS_PLUGIN, MTetherDStatusPluginClass))
39
40 typedef struct _MTetherDStatusPluginClass MTetherDStatusPluginClass;
41 typedef struct _MTetherDStatusPlugin MTetherDStatusPlugin;
42 typedef struct _MTetherDStatusPluginPrivate MTetherDStatusPluginPrivate;
43
44 struct _MTetherDStatusPluginClass {
45         HDStatusMenuItemClass parent;
46 };
47
48 struct _MTetherDStatusPlugin {
49         HDStatusMenuItem parent;
50         MTetherDStatusPluginPrivate *priv;
51         DBusGConnection *dbus_connection;
52         LibHalContext *hal_context;
53 };
54
55 GType mtetherd_status_plugin_get_type();
56
57 // Network device creation callback
58 void mtetherd_status_plugin_device_added(MTetherDStatusPlugin *plugin, MTetherDDevice *device);
59 // Network device removal callback
60 void mtetherd_status_plugin_device_removed(MTetherDStatusPlugin *plugin, const gchar *udi);
61 // Signals a USB connection or disconnection event
62 void mtetherd_status_plugin_usb_plugged(MTetherDStatusPlugin *plugin);
63
64 G_END_DECLS
65
66 #endif //_MTETHERD_STATUS_H
67