colin/ModemManager
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

libmm-glib,network-timezone: improve documentation

Browse Source
This commit is contained in:
Aleksander Morgado
2012-10-03 16:41:12 +02:00
parent 487090607d
commit dc4656cead
3 changed files with 97 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/reference/libmm-glib/libmm-glib-sections.txt
View File

@@ -476,19 +476,21 @@ mm_modem_time_get_type
<FILE>mm-network-timezone</FILE>
<TITLE>MMNetworkTimezone</TITLE>
MMNetworkTimezone
MMNetworkTimezoneClass
MM_NETWORK_TIMEZONE_LEAP_SECONDS_UNKNOWN
MM_NETWORK_TIMEZONE_OFFSET_UNKNOWN
mm_network_timezone_get_dictionary
MM_NETWORK_TIMEZONE_LEAP_SECONDS_UNKNOWN
<SUBSECTION Getters>
mm_network_timezone_get_offset
mm_network_timezone_get_dst_offset
mm_network_timezone_get_leap_seconds
mm_network_timezone_get_offset
<SUBSECTION Private>
mm_network_timezone_new
mm_network_timezone_new_from_dictionary
mm_network_timezone_set_dst_offset
mm_network_timezone_set_leap_seconds
mm_network_timezone_get_dictionary
mm_network_timezone_set_offset
<SUBSECTION Standard>
MMNetworkTimezoneClass
MMNetworkTimezonePrivate
MM_IS_NETWORK_TIMEZONE
MM_IS_NETWORK_TIMEZONE_CLASS

79
libmm-glib/mm-network-timezone.c
View File

@@ -18,6 +18,18 @@
#include "mm-errors-types.h"
#include "mm-network-timezone.h"
/**
* SECTION: mm-network-timezone
* @title: MMNetworkTimezone
* @short_description: Helper object to handle network timezone information.
*
* The #MMNetworkTimezone is an object handling the timezone information
* reported by the network.
*
* This object is retrieved with either mm_modem_time_peek_network_timezone()
* or mm_modem_time_get_network_timezone().
*/
G_DEFINE_TYPE (MMNetworkTimezone, mm_network_timezone, G_TYPE_OBJECT);
struct _MMNetworkTimezonePrivate {
@@ -28,6 +40,14 @@ struct _MMNetworkTimezonePrivate {
/*****************************************************************************/
/**
* mm_network_timezone_get_offset:
* @self: a #MMNetworkTimezone.
*
* Gets the timezone offset (in minutes) reported by the network.
*
* Returns: the offset, or %MM_NETWORK_TIMEZONE_OFFSET_UNKNOWN if unknown.
*/
gint
mm_network_timezone_get_offset (MMNetworkTimezone *self)
{
@@ -37,26 +57,6 @@ mm_network_timezone_get_offset (MMNetworkTimezone *self)
return self->priv->offset;
}
gint
mm_network_timezone_get_dst_offset (MMNetworkTimezone *self)
{
g_return_val_if_fail (MM_IS_NETWORK_TIMEZONE (self),
MM_NETWORK_TIMEZONE_OFFSET_UNKNOWN);
return self->priv->dst_offset;
}
gint
mm_network_timezone_get_leap_seconds (MMNetworkTimezone *self)
{
g_return_val_if_fail (MM_IS_NETWORK_TIMEZONE (self),
MM_NETWORK_TIMEZONE_LEAP_SECONDS_UNKNOWN);
return self->priv->leap_seconds;
}
/*****************************************************************************/
void
mm_network_timezone_set_offset (MMNetworkTimezone *self,
gint offset)
@@ -66,6 +66,26 @@ mm_network_timezone_set_offset (MMNetworkTimezone *self,
self->priv->offset = offset;
}
/*****************************************************************************/
/**
* mm_network_timezone_get_dst_offset:
* @self: a #MMNetworkTimezone.
*
* Gets the timezone offset due to daylight saving time (in minutes) reported by
* the network.
*
* Returns: the offset, or %MM_NETWORK_TIMEZONE_OFFSET_UNKNOWN if unknown.
*/
gint
mm_network_timezone_get_dst_offset (MMNetworkTimezone *self)
{
g_return_val_if_fail (MM_IS_NETWORK_TIMEZONE (self),
MM_NETWORK_TIMEZONE_OFFSET_UNKNOWN);
return self->priv->dst_offset;
}
void
mm_network_timezone_set_dst_offset (MMNetworkTimezone *self,
gint dst_offset)
@@ -75,6 +95,25 @@ mm_network_timezone_set_dst_offset (MMNetworkTimezone *self,
self->priv->dst_offset = dst_offset;
}
/*****************************************************************************/
/**
* mm_network_timezone_get_leap_seconds:
* @self: a #MMNetworkTimezone.
*
* Gets the number of leap seconds (TAI-UTC), as reported by the network.
*
* Returns: the number of leap seconds, or %MM_NETWORK_TIMEZONE_LEAP_SECONDS_UNKNOWN if unknown.
*/
gint
mm_network_timezone_get_leap_seconds (MMNetworkTimezone *self)
{
g_return_val_if_fail (MM_IS_NETWORK_TIMEZONE (self),
MM_NETWORK_TIMEZONE_LEAP_SECONDS_UNKNOWN);
return self->priv->leap_seconds;
}
void
mm_network_timezone_set_leap_seconds (MMNetworkTimezone *self,
gint leap_seconds)

36
libmm-glib/mm-network-timezone.h
View File

@@ -32,32 +32,58 @@ G_BEGIN_DECLS
#define MM_IS_NETWORK_TIMEZONE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), MM_TYPE_NETWORK_TIMEZONE))
#define MM_NETWORK_TIMEZONE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), MM_TYPE_NETWORK_TIMEZONE, MMNetworkTimezoneClass))
/**
* MM_NETWORK_TIMEZONE_OFFSET_UNKNOWN:
*
* Identifier for an unknown timezone offset.
*/
#define MM_NETWORK_TIMEZONE_OFFSET_UNKNOWN G_MAXINT32
/**
* MM_NETWORK_TIMEZONE_LEAP_SECONDS_UNKNOWN:
*
* Identifier for an unknown leap seconds value.
*/
#define MM_NETWORK_TIMEZONE_LEAP_SECONDS_UNKNOWN G_MAXINT32
typedef struct _MMNetworkTimezone MMNetworkTimezone;
typedef struct _MMNetworkTimezoneClass MMNetworkTimezoneClass;
typedef struct _MMNetworkTimezonePrivate MMNetworkTimezonePrivate;
/**
* MMNetworkTimezone:
*
* The #MMNetworkTimezone structure contains private data and should
* only be accessed using the provided API.
*/
struct _MMNetworkTimezone {
/*< private >*/
GObject parent;
MMNetworkTimezonePrivate *priv;
};
struct _MMNetworkTimezoneClass {
/*< private >*/
GObjectClass parent;
};
GType mm_network_timezone_get_type (void);
MMNetworkTimezone *mm_network_timezone_new (void);
MMNetworkTimezone *mm_network_timezone_new_from_dictionary (GVariant *dictionary,
GError **error);
gint32 mm_network_timezone_get_offset (MMNetworkTimezone *self);
gint32 mm_network_timezone_get_dst_offset (MMNetworkTimezone *self);
gint32 mm_network_timezone_get_leap_seconds (MMNetworkTimezone *self);
/*****************************************************************************/
/* ModemManager/libmm-glib/mmcli specific methods */
#if defined (_LIBMM_INSIDE_MM) || \
defined (_LIBMM_INSIDE_MMCLI) || \
defined (LIBMM_GLIB_COMPILATION)
MMNetworkTimezone *mm_network_timezone_new (void);
MMNetworkTimezone *mm_network_timezone_new_from_dictionary (GVariant *dictionary,
GError **error);
void mm_network_timezone_set_offset (MMNetworkTimezone *self,
gint offset);
void mm_network_timezone_set_dst_offset (MMNetworkTimezone *self,
@@ -67,6 +93,8 @@ void mm_network_timezone_set_leap_seconds (MMNetworkTimezone *self,
GVariant *mm_network_timezone_get_dictionary (MMNetworkTimezone *self);
#endif
G_END_DECLS
#endif /* MM_NETWORK_TIMEZONE_H */