From f75dd6fd1975146623052b843b182dc32c3fbe46 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Fri, 8 Apr 2011 07:30:59 +0200 Subject: Imported Upstream version 0.8.998 --- docs/libnm-util/html/NMSettingConnection.html | 338 +++++++++++++++++++++----- 1 file changed, 273 insertions(+), 65 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 f70fdb95..27c30ebd 100644 --- a/docs/libnm-util/html/NMSettingConnection.html +++ b/docs/libnm-util/html/NMSettingConnection.html @@ -3,12 +3,12 @@ NMSettingConnection - + - + @@ -30,7 +30,7 @@ Properties -
+
@@ -39,13 +39,13 @@
-
+

Synopsis

-
+
 #include <nm-setting-connection.h>
 
 #define             NM_SETTING_CONNECTION_SETTING_NAME
-enum                NMSettingConnectionError;
+enum                NMSettingConnectionError;
 #define             NM_TYPE_SETTING_CONNECTION_ERROR
 #define             NM_SETTING_CONNECTION_ERROR
 GQuark              nm_setting_connection_error_quark   (void);
@@ -55,6 +55,7 @@ enum                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);
@@ -67,39 +68,63 @@ const char *        NMSettingConnection *setting);
 guint64             nm_setting_connection_get_timestamp (NMSettingConnection *setting);
 gboolean            nm_setting_connection_get_read_only (NMSettingConnection *setting);
+guint32             nm_setting_connection_get_num_permissions
+                                                        (NMSettingConnection *setting);
+gboolean            nm_setting_connection_get_permission
+                                                        (NMSettingConnection *setting,
+                                                         guint32 idx,
+                                                         const char **out_ptype,
+                                                         const char **out_pitem,
+                                                         const char **out_detail);
+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);
-
+

Object Hierarchy

+
+  GEnum
+   +----NMSettingConnectionError
+
   GObject
    +----NMSetting
          +----NMSettingConnection
-
+

Properties

   "autoconnect"              gboolean              : Read / Write / Construct
   "id"                       gchar*                : Read / Write
+  "permissions"              GSList_gchararray_*   : Read / Write
   "read-only"                gboolean              : Read / Write / Construct
   "timestamp"                guint64               : Read / Write / Construct
   "type"                     gchar*                : Read / Write
   "uuid"                     gchar*                : Read / Write
-
+

Description

The NMSettingConnection object is a NMSetting subclass that describes -properties that apply to all NMConnection objects, regardless of what type -of network connection they describe. Each NMConnection object must contain +properties that apply to all NMConnection objects, regardless of what type +of network connection they describe. Each NMConnection object must contain a NMSettingConnection setting.

-
+

Details

-
+

NM_SETTING_CONNECTION_SETTING_NAME

#define NM_SETTING_CONNECTION_SETTING_NAME "connection"
@@ -107,7 +132,7 @@ a
-
+

enum NMSettingConnectionError

typedef enum
 {
@@ -145,14 +170,14 @@ Describes errors that may result from operations involving a
 
NM_SETTING_CONNECTION_ERROR_TYPE_SETTING_NOT_FOUND

 the NMSetting object
   referenced by the setting name contained in the
-  "type" property was not present in the NMConnection
+  "type" property was not present in the NMConnection
-
+

NM_TYPE_SETTING_CONNECTION_ERROR

#define NM_TYPE_SETTING_CONNECTION_ERROR (nm_setting_connection_error_get_type ())
@@ -160,7 +185,7 @@ Describes errors that may result from operations involving a

-
+

NM_SETTING_CONNECTION_ERROR

#define NM_SETTING_CONNECTION_ERROR nm_setting_connection_error_quark ()
@@ -168,7 +193,7 @@ Describes errors that may result from operations involving a

-
+

nm_setting_connection_error_quark ()

GQuark              nm_setting_connection_error_quark   (void);

@@ -178,13 +203,12 @@ Registers an error quark for

Returns :

- the error quark used for NMSettingConnection errors. - +the error quark used for NMSettingConnection errors.
-
+

NM_SETTING_CONNECTION_ID

#define NM_SETTING_CONNECTION_ID          "id"
@@ -192,7 +216,7 @@ Registers an error quark for
-
+

NM_SETTING_CONNECTION_UUID

#define NM_SETTING_CONNECTION_UUID        "uuid"
@@ -200,7 +224,7 @@ Registers an error quark for
-
+

NM_SETTING_CONNECTION_TYPE

#define NM_SETTING_CONNECTION_TYPE        "type"
@@ -208,7 +232,7 @@ Registers an error quark for
-
+

NM_SETTING_CONNECTION_AUTOCONNECT

#define NM_SETTING_CONNECTION_AUTOCONNECT "autoconnect"
@@ -216,7 +240,7 @@ Registers an error quark for
-
+

NM_SETTING_CONNECTION_TIMESTAMP

#define NM_SETTING_CONNECTION_TIMESTAMP   "timestamp"
@@ -224,7 +248,7 @@ Registers an error quark for
-
+

NM_SETTING_CONNECTION_READ_ONLY

#define NM_SETTING_CONNECTION_READ_ONLY   "read-only"
@@ -232,7 +256,15 @@ Registers an error quark for
-
+
+

NM_SETTING_CONNECTION_PERMISSIONS

+
#define NM_SETTING_CONNECTION_PERMISSIONS "permissions"
+
+

+

+
+
+

NMSettingConnection

typedef struct _NMSettingConnection NMSettingConnection;

@@ -241,7 +273,7 @@ It should only be accessed through the functions described below.

-
+

NMSettingConnectionClass

typedef struct {
 	NMSettingClass parent;
@@ -257,22 +289,14 @@ It should only be accessed through the functions described below.
-
+

nm_setting_connection_get_type ()

GType               nm_setting_connection_get_type      (void);

-
-- - - - -

Returns :

 -
-
+

nm_setting_connection_new ()

NMSetting *         nm_setting_connection_new           (void);

@@ -282,13 +306,12 @@ Creates a new

Returns :

- the new empty NMSettingConnection object - +the new empty NMSettingConnection object
-
+

nm_setting_connection_get_id ()

const char *        nm_setting_connection_get_id        (NMSettingConnection *setting);

@@ -304,14 +327,13 @@ Returns the Returns :

- the connection ID - +the connection ID
-
+

nm_setting_connection_get_uuid ()

const char *        nm_setting_connection_get_uuid      (NMSettingConnection *setting);

@@ -327,14 +349,13 @@ Returns the Returns :

- the connection UUID - +the connection UUID
-
+

nm_setting_connection_get_connection_type ()

const char *        nm_setting_connection_get_connection_type
                                                         (NMSettingConnection *setting);
@@ -351,14 +372,13 @@ Returns the Returns :

- the connection type - +the connection type
-
+

nm_setting_connection_get_autoconnect ()

gboolean            nm_setting_connection_get_autoconnect
                                                         (NMSettingConnection *setting);
@@ -375,14 +395,13 @@ Returns the Returns :

- the connection's autoconnect behavior - +the connection's autoconnect behavior
-
+

nm_setting_connection_get_timestamp ()

guint64             nm_setting_connection_get_timestamp (NMSettingConnection *setting);

@@ -398,14 +417,13 @@ Returns the Returns :

- the connection's timestamp - +the connection's timestamp
-
+

nm_setting_connection_get_read_only ()

gboolean            nm_setting_connection_get_read_only (NMSettingConnection *setting);

@@ -421,16 +439,184 @@ Returns the Returns :

- TRUE if the connection is read-only, FALSE if it is not + +TRUE if the connection is read-only, FALSE if it is not + + +
+
+
+
+

nm_setting_connection_get_num_permissions ()

+
guint32             nm_setting_connection_get_num_permissions
+                                                        (NMSettingConnection *setting);
+

+Returns the number of entires in the "permissions" +property of this setting. +

+
++ + + + + + + +

setting :

the NMSettingConnection

Returns :

the number of permissions entires
+
+
+

nm_setting_connection_get_permission ()

+
gboolean            nm_setting_connection_get_permission
+                                                        (NMSettingConnection *setting,
+                                                         guint32 idx,
+                                                         const char **out_ptype,
+                                                         const char **out_pitem,
+                                                         const char **out_detail);
+

+Retrieve one of the entries of the "permissions" property +of this setting. +

+
++ + + + + + + + + + + + + + + + + + + + + + + + + + +

setting :

the NMSettingConnection +

idx :

the zero-based index of the permissions entry

out_ptype :

on return, the permission type (at this time, always "user")

out_pitem :

on return, the permission item (formatted accoring to ptype, see +"permissions" for more detail

out_detail :

on return, the permission detail (at this time, always NULL)

Returns :

 +TRUE if a permission was returned, FALSE if idx was invalid
-
+
+
+

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 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);
+

+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. +

+
++ + + + + + + + + + + + + + + + + + + + + + +

setting :

the NMSettingConnection +

ptype :

the permission type; at this time only "user" is supported

pitem :

the permission item formatted as required for ptype +

detail :

unused at this time; must be NULL. [allow-none] +

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
+
+
+
+

nm_setting_connection_remove_permission ()

+
void                nm_setting_connection_remove_permission
+                                                        (NMSettingConnection *setting,
+                                                         guint32 idx);
+

+Removes the permission at index idx from the connection. +

+
++ + + + + + + + + + +

setting :

the NMSettingConnection +

idx :

the zero-based index of the permission to remove
+
+
+

Property Details

-
+

The "autoconnect" property

  "autoconnect"              gboolean              : Read / Write / Construct

@@ -442,7 +628,7 @@ intervention to activate the connection. Defaults to +

The "id" property

  "id"                       gchar*                : Read / Write

@@ -452,7 +638,29 @@ A human readable unique idenfier for the connection, like "Work WiFi" or

Default value: NULL

-
+
+

The "permissions" property

+
  "permissions"              GSList_gchararray_*   : Read / Write
+

+An array of strings defining what access a given user has to this +connection. If this is NULL or empty, all users are allowed to access +this connection. Otherwise a user is allowed to access this connection +if and only if they are in this list. Each entry is of the form +"[type]:[id]:[reserved]", for example: +

+

+ user:dcbw:blah +

+

+At this time only the 'user' [type] is allowed. Any other values are +ignored and reserved for future use. [id] is the username that this +permission refers to, which may not contain the ':' character. Any +[reserved] information present must be ignored and is reserved for +future use. All of [type], [id], and [reserved] must be valid UTF-8. +

+
+
+

The "read-only" property

  "read-only"                gboolean              : Read / Write / Construct

@@ -463,7 +671,7 @@ if the connection is read-only and cannot be modified.

Default value: FALSE

-
+

The "timestamp" property

  "timestamp"                guint64               : Read / Write / Construct

@@ -473,7 +681,7 @@ _successfully_ fully activated.

Default value: 0

-
+

The "type" property

  "type"                     gchar*                : Read / Write

@@ -485,7 +693,7 @@ type's parameters. For example, for WiFi devices, the name of the

Default value: NULL

-
+

The "uuid" property

  "uuid"                     gchar*                : Read / Write

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

- Generated by GTK-Doc V1.15
+ Generated by GTK-Doc V1.17
\ No newline at end of file -- cgit 1.3.0-6-gf8a5