From b436a68a20ff3114ded32a7a3d70cdd4954039f9 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Sat, 12 Nov 2011 01:36:14 +0100 Subject: Imported Upstream version 0.9.2.0 --- docs/libnm-util/html/NMSettingConnection.html | 355 ++++++++++++-------------- 1 file changed, 164 insertions(+), 191 deletions(-) (limited to 'docs/libnm-util/html/NMSettingConnection.html') diff --git a/docs/libnm-util/html/NMSettingConnection.html b/docs/libnm-util/html/NMSettingConnection.html index e0085a7c..0089fc41 100644 --- a/docs/libnm-util/html/NMSettingConnection.html +++ b/docs/libnm-util/html/NMSettingConnection.html @@ -8,7 +8,7 @@ - + @@ -44,30 +44,28 @@ 
 #include <nm-setting-connection.h>
 
-#define             NM_SETTING_CONNECTION_SETTING_NAME
-enum                NMSettingConnectionError;
-#define             NM_TYPE_SETTING_CONNECTION_ERROR
-#define             NM_SETTING_CONNECTION_ERROR
-GQuark              nm_setting_connection_error_quark   (void);
-#define             NM_SETTING_CONNECTION_ID
-#define             NM_SETTING_CONNECTION_UUID
-#define             NM_SETTING_CONNECTION_TYPE
-#define             NM_SETTING_CONNECTION_AUTOCONNECT
-#define             NM_SETTING_CONNECTION_TIMESTAMP
-#define             NM_SETTING_CONNECTION_READ_ONLY
-#define             NM_SETTING_CONNECTION_PERMISSIONS
                     NMSettingConnection;
                     NMSettingConnectionClass;
-GType               nm_setting_connection_get_type      (void);
-NMSetting *         nm_setting_connection_new           (void);
-const char *        nm_setting_connection_get_id        (NMSettingConnection *setting);
-const char *        nm_setting_connection_get_uuid      (NMSettingConnection *setting);
-const char *        nm_setting_connection_get_connection_type
-                                                        (NMSettingConnection *setting);
+enum                NMSettingConnectionError;
+#define             NM_SETTING_CONNECTION_AUTOCONNECT
+#define             NM_SETTING_CONNECTION_ID
+#define             NM_SETTING_CONNECTION_PERMISSIONS
+#define             NM_SETTING_CONNECTION_READ_ONLY
+#define             NM_SETTING_CONNECTION_SETTING_NAME
+#define             NM_SETTING_CONNECTION_TIMESTAMP
+#define             NM_SETTING_CONNECTION_TYPE
+#define             NM_SETTING_CONNECTION_UUID
+gboolean            nm_setting_connection_add_permission
+                                                        (NMSettingConnection *setting,
+                                                         const char *ptype,
+                                                         const char *pitem,
+                                                         const char *detail);
+GQuark              nm_setting_connection_error_quark   (void);
 gboolean            nm_setting_connection_get_autoconnect
                                                         (NMSettingConnection *setting);
-guint64             nm_setting_connection_get_timestamp (NMSettingConnection *setting);
-gboolean            nm_setting_connection_get_read_only (NMSettingConnection *setting);
+const char *        nm_setting_connection_get_connection_type
+                                                        (NMSettingConnection *setting);
+const char *        nm_setting_connection_get_id        (NMSettingConnection *setting);
 guint32             nm_setting_connection_get_num_permissions
                                                         (NMSettingConnection *setting);
 gboolean            nm_setting_connection_get_permission
@@ -76,14 +74,13 @@ const char *        const char **out_ptype,
                                                          const char **out_pitem,
                                                          const char **out_detail);
+gboolean            nm_setting_connection_get_read_only (NMSettingConnection *setting);
+guint64             nm_setting_connection_get_timestamp (NMSettingConnection *setting);
+const char *        nm_setting_connection_get_uuid      (NMSettingConnection *setting);
+NMSetting *         nm_setting_connection_new           (void);
 gboolean            nm_setting_connection_permissions_user_allowed
                                                         (NMSettingConnection *setting,
                                                          const char *uname);
-gboolean            nm_setting_connection_add_permission
-                                                        (NMSettingConnection *setting,
-                                                         const char *ptype,
-                                                         const char *pitem,
-                                                         const char *detail);
 void                nm_setting_connection_remove_permission
                                                         (NMSettingConnection *setting,
                                                          guint32 idx);
@@ -91,15 +88,15 @@ const char *        
 
Object Hierarchy

-
-  GEnum
-   +----NMSettingConnectionError
-

 
   GObject
    +----NMSetting
          +----NMSettingConnection
 

+
+  GEnum
+   +----NMSettingConnectionError
+

 
 

 
Properties

@@ -125,17 +122,33 @@ a 
 
Details

 

-
NM_SETTING_CONNECTION_SETTING_NAME

-
#define NM_SETTING_CONNECTION_SETTING_NAME "connection"
+
NMSettingConnection

+
typedef struct _NMSettingConnection NMSettingConnection;

+

+The NMSettingConnection struct contains only private data.
+It should only be accessed through the functions described below.
+

+

+

+

+
NMSettingConnectionClass

+
typedef struct {
+	NMSettingClass parent;
+
+	/* Padding for future expansion */
+	void (*_reserved1) (void);
+	void (*_reserved2) (void);
+	void (*_reserved3) (void);
+	void (*_reserved4) (void);
+} NMSettingConnectionClass;
 

 

 

 

 

 

-
enum NMSettingConnectionError

-
typedef enum
-{
+
enum NMSettingConnectionError

+
typedef enum {
 	NM_SETTING_CONNECTION_ERROR_UNKNOWN = 0,
 	NM_SETTING_CONNECTION_ERROR_INVALID_PROPERTY,
 	NM_SETTING_CONNECTION_ERROR_MISSING_PROPERTY,
@@ -178,37 +191,14 @@ Describes errors that may result from operations involving a
 

 

 

-
NM_TYPE_SETTING_CONNECTION_ERROR

-
#define NM_TYPE_SETTING_CONNECTION_ERROR (nm_setting_connection_error_get_type ()) 
-

-

-

-

-

-

-
NM_SETTING_CONNECTION_ERROR

-
#define NM_SETTING_CONNECTION_ERROR nm_setting_connection_error_quark ()
+
NM_SETTING_CONNECTION_AUTOCONNECT

+
#define NM_SETTING_CONNECTION_AUTOCONNECT "autoconnect"
 

 

 

 

 

 

-
nm_setting_connection_error_quark ()

-
GQuark              nm_setting_connection_error_quark   (void);

-

-Registers an error quark for NMSettingConnection if necessary.
-

-

--
-
-
-
-


Returns :
the error quark used for NMSettingConnection errors.

-

-

-

 
NM_SETTING_CONNECTION_ID

 
#define NM_SETTING_CONNECTION_ID          "id"
 

@@ -217,24 +207,24 @@ Registers an error quark for 
 

 

-
NM_SETTING_CONNECTION_UUID

-
#define NM_SETTING_CONNECTION_UUID        "uuid"
+
NM_SETTING_CONNECTION_PERMISSIONS

+
#define NM_SETTING_CONNECTION_PERMISSIONS "permissions"
 

 

 

 

 

 

-
NM_SETTING_CONNECTION_TYPE

-
#define NM_SETTING_CONNECTION_TYPE        "type"
+
NM_SETTING_CONNECTION_READ_ONLY

+
#define NM_SETTING_CONNECTION_READ_ONLY   "read-only"
 

 

 

 

 

 

-
NM_SETTING_CONNECTION_AUTOCONNECT

-
#define NM_SETTING_CONNECTION_AUTOCONNECT "autoconnect"
+
NM_SETTING_CONNECTION_SETTING_NAME

+
#define NM_SETTING_CONNECTION_SETTING_NAME "connection"
 

 

 

@@ -249,73 +239,32 @@ Registers an error quark for 
 

 

-
NM_SETTING_CONNECTION_READ_ONLY

-
#define NM_SETTING_CONNECTION_READ_ONLY   "read-only"
-

-

-

-

-

-

-
NM_SETTING_CONNECTION_PERMISSIONS

-
#define NM_SETTING_CONNECTION_PERMISSIONS "permissions"
+
NM_SETTING_CONNECTION_TYPE

+
#define NM_SETTING_CONNECTION_TYPE        "type"
 

 

 

 

 

 

-
NMSettingConnection

-
typedef struct _NMSettingConnection NMSettingConnection;

-

-The NMSettingConnection struct contains only private data.
-It should only be accessed through the functions described below.
-

-

-

-

-
NMSettingConnectionClass

-
typedef struct {
-	NMSettingClass parent;
-
-	/* Padding for future expansion */
-	void (*_reserved1) (void);
-	void (*_reserved2) (void);
-	void (*_reserved3) (void);
-	void (*_reserved4) (void);
-} NMSettingConnectionClass;
+
NM_SETTING_CONNECTION_UUID

+
#define NM_SETTING_CONNECTION_UUID        "uuid"
 

 

 

 

 

 

-
nm_setting_connection_get_type ()

-
GType               nm_setting_connection_get_type      (void);

-

-

-

-

-

-
nm_setting_connection_new ()

-
NMSetting *         nm_setting_connection_new           (void);

-

-Creates a new NMSettingConnection object with default values.
-

-

--
-
-
-
-


Returns :
the new empty NMSettingConnection object

-

-

-

-
nm_setting_connection_get_id ()

-
const char *        nm_setting_connection_get_id        (NMSettingConnection *setting);

+
nm_setting_connection_add_permission ()

+
gboolean            nm_setting_connection_add_permission
+                                                        (NMSettingConnection *setting,
+                                                         const char *ptype,
+                                                         const char *pitem,
+                                                         const char *detail);

 

-Returns the "id" property of the connection.
+Adds a permission to the connection's permission list.  At this time, only
+the "user" permission type is supported, and pitem must be a username. See
+"permissions": for more details.
 

 
@@ -326,55 +275,41 @@ Returns the Returns :

-
+
+
-
-

 

the connection ID
ptype :
the permission type; at this time only "user" is supported
 

-

-

-

-
nm_setting_connection_get_uuid ()

-
const char *        nm_setting_connection_get_uuid      (NMSettingConnection *setting);

-

-Returns the "uuid" property of the connection.
-

-

--
-
-
+
+
+
+
+
-
+


 
setting :
the NMSettingConnection
+
pitem :
the permission item formatted as required for ptype
+
detail :
unused at this time; must be NULL. [allow-none]
 
 

 

 
Returns :
the connection UUIDTRUE if the permission was unique and was successfully added to the
+list, FALSE if ptype or pitem was invalid or it the permission was already
+present in the list
 

 
 

 

 

 

-
nm_setting_connection_get_connection_type ()

-
const char *        nm_setting_connection_get_connection_type
-                                                        (NMSettingConnection *setting);

+
nm_setting_connection_error_quark ()

+
GQuark              nm_setting_connection_error_quark   (void);

 

-Returns the "type" property of the connection.
+Registers an error quark for NMSettingConnection if necessary.
 

 
-
-
-
-
-
-
+
-
-
-
+
+

 

setting :
the NMSettingConnection
-

 
Returns :
the connection type
the error quark used for NMSettingConnection errors.

 

 

 

@@ -402,10 +337,11 @@ Returns the 
-
nm_setting_connection_get_timestamp ()

-
guint64             nm_setting_connection_get_timestamp (NMSettingConnection *setting);

+
nm_setting_connection_get_connection_type ()

+
const char *        nm_setting_connection_get_connection_type
+                                                        (NMSettingConnection *setting);

 

-Returns the "timestamp" property of the connection.
+Returns the "type" property of the connection.
 

 
@@ -417,17 +353,17 @@ Returns the Returns :

-
+

 

the connection's timestampthe connection type
 

 
 

 

 

 

-
nm_setting_connection_get_read_only ()

-
gboolean            nm_setting_connection_get_read_only (NMSettingConnection *setting);

+
nm_setting_connection_get_id ()

+
const char *        nm_setting_connection_get_id        (NMSettingConnection *setting);

 

-Returns the "read-only" property of the connection.
+Returns the "id" property of the connection.
 

 
@@ -439,8 +375,7 @@ Returns the Returns :

-
+

 


-TRUE if the connection is read-only, FALSE if it is notthe connection ID
 

 
 

@@ -517,12 +452,10 @@ of this setting.
 

 

 

-
nm_setting_connection_permissions_user_allowed ()

-
gboolean            nm_setting_connection_permissions_user_allowed
-                                                        (NMSettingConnection *setting,
-                                                         const char *uname);

+
nm_setting_connection_get_read_only ()

+
gboolean            nm_setting_connection_get_read_only (NMSettingConnection *setting);

 

-Checks whether the given username is allowed to view/access this connection.
+Returns the "read-only" property of the connection.
 

 
@@ -533,30 +466,19 @@ Checks whether the given username is allowed to view/access this connection.
 
-
-
-
-
+TRUE if the connection is read-only, FALSE if it is not

 

 
 
uname :
the user name to check permissions for

 
Returns :

 
-TRUE if the requested user is allowed to view this connection,
-FALSE if the given user is not allowed to view this connection
 

 
 

 

 

 

-
nm_setting_connection_add_permission ()

-
gboolean            nm_setting_connection_add_permission
-                                                        (NMSettingConnection *setting,
-                                                         const char *ptype,
-                                                         const char *pitem,
-                                                         const char *detail);

+
nm_setting_connection_get_timestamp ()

+
guint64             nm_setting_connection_get_timestamp (NMSettingConnection *setting);

 

-Adds a permission to the connection's permission list.  At this time, only
-the "user" permission type is supported, and pitem must be a username. See
-"permissions": for more details.
+Returns the "timestamp" property of the connection.
 

 
@@ -567,24 +489,75 @@ the "user" permission type is supported, and pitem
 
 
-
-
+
+
+
+

 

ptype :
the permission type; at this time only "user" is supported
Returns :
the connection's timestamp
 

+

+

+

+
nm_setting_connection_get_uuid ()

+
const char *        nm_setting_connection_get_uuid      (NMSettingConnection *setting);

+

+Returns the "uuid" property of the connection.
+

+

++
-
-
+
-
-
+
+
+
+


 
pitem :
the permission item formatted as required for ptype
+
setting :
the NMSettingConnection
 
 

 
detail :
unused at this time; must be NULL. [allow-none]
+
Returns :
the connection UUID

+

+

+

+
nm_setting_connection_new ()

+
NMSetting *         nm_setting_connection_new           (void);

+

+Creates a new NMSettingConnection object with default values.
+

+

++
+
+
+
+


Returns :
the new empty NMSettingConnection object

+

+

+

+
nm_setting_connection_permissions_user_allowed ()

+
gboolean            nm_setting_connection_permissions_user_allowed
+                                                        (NMSettingConnection *setting,
+                                                         const char *uname);

+

+Checks whether the given username is allowed to view/access this connection.
+

+

++
+
+
+
+
+
+
+
-
+


setting :
the NMSettingConnection
 
 

 
uname :
the user name to check permissions for

 
Returns :
TRUE if the permission was unique and was successfully added to the
-list, FALSE if ptype or pitem was invalid or it the permission was already
-present in the list
+TRUE if the requested user is allowed to view this connection,
+FALSE if the given user is not allowed to view this connection
 

 
 

@@ -717,6 +690,6 @@ be generated by 
 

-          Generated by GTK-Doc V1.17

+          Generated by GTK-Doc V1.18

 
 
\ No newline at end of file
-- 
cgit 1.3.0-6-gf8a5