diff options
Diffstat (limited to 'docs/libnm-glib/tmpl/nm-client.sgml')
| -rw-r--r-- | docs/libnm-glib/tmpl/nm-client.sgml | 316 |
1 files changed, 206 insertions, 110 deletions
diff --git a/docs/libnm-glib/tmpl/nm-client.sgml b/docs/libnm-glib/tmpl/nm-client.sgml index c3443c40..2c439d61 100644 --- a/docs/libnm-glib/tmpl/nm-client.sgml +++ b/docs/libnm-glib/tmpl/nm-client.sgml @@ -22,130 +22,103 @@ NMClient <!-- ##### SECTION Image ##### --> -<!-- ##### STRUCT NMClient ##### --> +<!-- ##### MACRO NM_CLIENT_VERSION ##### --> <para> </para> -<!-- ##### SIGNAL NMClient::device-added ##### --> + +<!-- ##### MACRO NM_CLIENT_STATE ##### --> <para> </para> -@nmclient: the object which received the signal. -@arg1: -<!-- ##### SIGNAL NMClient::device-removed ##### --> + +<!-- ##### MACRO NM_CLIENT_MANAGER_RUNNING ##### --> <para> </para> -@nmclient: the object which received the signal. -@arg1: -<!-- ##### SIGNAL NMClient::permission-changed ##### --> + +<!-- ##### MACRO NM_CLIENT_NETWORKING_ENABLED ##### --> <para> </para> -@nmclient: the object which received the signal. -@arg1: -@arg2: -<!-- ##### ARG NMClient:active-connections ##### --> + +<!-- ##### MACRO NM_CLIENT_WIRELESS_ENABLED ##### --> <para> </para> -<!-- ##### ARG NMClient:manager-running ##### --> -<para> -</para> -<!-- ##### ARG NMClient:networking-enabled ##### --> +<!-- ##### MACRO NM_CLIENT_WIRELESS_HARDWARE_ENABLED ##### --> <para> </para> -<!-- ##### ARG NMClient:state ##### --> -<para> -</para> -<!-- ##### ARG NMClient:version ##### --> +<!-- ##### MACRO NM_CLIENT_WWAN_ENABLED ##### --> <para> </para> -<!-- ##### ARG NMClient:wimax-enabled ##### --> -<para> -</para> -<!-- ##### ARG NMClient:wimax-hardware-enabled ##### --> +<!-- ##### MACRO NM_CLIENT_WWAN_HARDWARE_ENABLED ##### --> <para> </para> -<!-- ##### ARG NMClient:wireless-enabled ##### --> -<para> -</para> -<!-- ##### ARG NMClient:wireless-hardware-enabled ##### --> +<!-- ##### MACRO NM_CLIENT_WIMAX_ENABLED ##### --> <para> </para> -<!-- ##### ARG NMClient:wwan-enabled ##### --> + + +<!-- ##### MACRO NM_CLIENT_WIMAX_HARDWARE_ENABLED ##### --> <para> </para> -<!-- ##### ARG NMClient:wwan-hardware-enabled ##### --> + + +<!-- ##### MACRO NM_CLIENT_ACTIVE_CONNECTIONS ##### --> <para> </para> -<!-- ##### USER_FUNCTION NMClientActivateFn ##### --> + + +<!-- ##### MACRO NM_CLIENT_CONNECTIVITY ##### --> <para> </para> -@client: -@active_connection: -@error: -@user_data: -<!-- ##### USER_FUNCTION NMClientAddActivateFn ##### --> +<!-- ##### MACRO NM_CLIENT_PRIMARY_CONNECTION ##### --> <para> </para> -@client: -@connection: -@new_connection_path: -@error: -@user_data: -<!-- ##### STRUCT NMClientClass ##### --> +<!-- ##### MACRO NM_CLIENT_ACTIVATING_CONNECTION ##### --> <para> </para> -@parent: -@device_added: -@device_removed: -@permission_changed: -@_reserved1: -@_reserved2: -@_reserved3: -@_reserved4: -@_reserved5: -@_reserved6: + <!-- ##### ENUM NMClientPermission ##### --> <para> @@ -176,81 +149,190 @@ NMClient @NM_CLIENT_PERMISSION_RESULT_AUTH: @NM_CLIENT_PERMISSION_RESULT_NO: -<!-- ##### MACRO NM_CLIENT_ACTIVE_CONNECTIONS ##### --> +<!-- ##### STRUCT NMClient ##### --> <para> </para> +<!-- ##### SIGNAL NMClient::device-added ##### --> +<para> -<!-- ##### MACRO NM_CLIENT_MANAGER_RUNNING ##### --> +</para> + +@nmclient: the object which received the signal. +@arg1: + +<!-- ##### SIGNAL NMClient::device-removed ##### --> <para> </para> +@nmclient: the object which received the signal. +@arg1: +<!-- ##### SIGNAL NMClient::permission-changed ##### --> +<para> -<!-- ##### MACRO NM_CLIENT_NETWORKING_ENABLED ##### --> +</para> + +@nmclient: the object which received the signal. +@arg1: +@arg2: + +<!-- ##### ARG NMClient:activating-connection ##### --> <para> </para> +<!-- ##### ARG NMClient:active-connections ##### --> +<para> +</para> -<!-- ##### MACRO NM_CLIENT_STATE ##### --> +<!-- ##### ARG NMClient:connectivity ##### --> <para> </para> +<!-- ##### ARG NMClient:manager-running ##### --> +<para> +</para> -<!-- ##### MACRO NM_CLIENT_VERSION ##### --> +<!-- ##### ARG NMClient:networking-enabled ##### --> <para> </para> +<!-- ##### ARG NMClient:primary-connection ##### --> +<para> +</para> -<!-- ##### MACRO NM_CLIENT_WIMAX_ENABLED ##### --> +<!-- ##### ARG NMClient:state ##### --> <para> </para> +<!-- ##### ARG NMClient:version ##### --> +<para> +</para> -<!-- ##### MACRO NM_CLIENT_WIMAX_HARDWARE_ENABLED ##### --> +<!-- ##### ARG NMClient:wimax-enabled ##### --> <para> </para> +<!-- ##### ARG NMClient:wimax-hardware-enabled ##### --> +<para> +</para> -<!-- ##### MACRO NM_CLIENT_WIRELESS_ENABLED ##### --> +<!-- ##### ARG NMClient:wireless-enabled ##### --> <para> </para> +<!-- ##### ARG NMClient:wireless-hardware-enabled ##### --> +<para> +</para> -<!-- ##### MACRO NM_CLIENT_WIRELESS_HARDWARE_ENABLED ##### --> +<!-- ##### ARG NMClient:wwan-enabled ##### --> <para> </para> +<!-- ##### ARG NMClient:wwan-hardware-enabled ##### --> +<para> +</para> -<!-- ##### MACRO NM_CLIENT_WWAN_ENABLED ##### --> +<!-- ##### STRUCT NMClientClass ##### --> +<para> + +</para> + +@parent: +@device_added: +@device_removed: +@permission_changed: +@_reserved1: +@_reserved2: +@_reserved3: +@_reserved4: +@_reserved5: +@_reserved6: + +<!-- ##### FUNCTION nm_client_new ##### --> <para> </para> +@void: +@Returns: -<!-- ##### MACRO NM_CLIENT_WWAN_HARDWARE_ENABLED ##### --> +<!-- ##### FUNCTION nm_client_new_async ##### --> +<para> + +</para> + +@cancellable: +@callback: +@user_data: + + +<!-- ##### FUNCTION nm_client_new_finish ##### --> +<para> + +</para> + +@result: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_client_get_devices ##### --> +<para> + +</para> + +@client: +@Returns: + + +<!-- ##### FUNCTION nm_client_get_device_by_path ##### --> +<para> + +</para> + +@client: +@object_path: +@Returns: + + +<!-- ##### FUNCTION nm_client_get_device_by_iface ##### --> +<para> + +</para> + +@client: +@iface: +@Returns: + + +<!-- ##### USER_FUNCTION NMClientActivateFn ##### --> <para> </para> +@client: +@active_connection: +@error: +@user_data: <!-- ##### FUNCTION nm_client_activate_connection ##### --> @@ -266,6 +348,18 @@ NMClient @user_data: +<!-- ##### USER_FUNCTION NMClientAddActivateFn ##### --> +<para> + +</para> + +@client: +@connection: +@new_connection_path: +@error: +@user_data: + + <!-- ##### FUNCTION nm_client_add_and_activate_connection ##### --> <para> @@ -288,7 +382,7 @@ NMClient @active: -<!-- ##### FUNCTION nm_client_get_active_connections ##### --> +<!-- ##### FUNCTION nm_client_networking_get_enabled ##### --> <para> </para> @@ -297,48 +391,43 @@ NMClient @Returns: -<!-- ##### FUNCTION nm_client_get_device_by_iface ##### --> +<!-- ##### FUNCTION nm_client_networking_set_enabled ##### --> <para> </para> @client: -@iface: -@Returns: +@enabled: -<!-- ##### FUNCTION nm_client_get_device_by_path ##### --> +<!-- ##### FUNCTION nm_client_wireless_get_enabled ##### --> <para> </para> @client: -@object_path: @Returns: -<!-- ##### FUNCTION nm_client_get_devices ##### --> +<!-- ##### FUNCTION nm_client_wireless_set_enabled ##### --> <para> </para> @client: -@Returns: +@enabled: -<!-- ##### FUNCTION nm_client_get_logging ##### --> +<!-- ##### FUNCTION nm_client_wireless_hardware_get_enabled ##### --> <para> </para> @client: -@level: -@domains: -@error: @Returns: -<!-- ##### FUNCTION nm_client_get_manager_running ##### --> +<!-- ##### FUNCTION nm_client_wwan_get_enabled ##### --> <para> </para> @@ -347,17 +436,16 @@ NMClient @Returns: -<!-- ##### FUNCTION nm_client_get_permission_result ##### --> +<!-- ##### FUNCTION nm_client_wwan_set_enabled ##### --> <para> </para> @client: -@permission: -@Returns: +@enabled: -<!-- ##### FUNCTION nm_client_get_state ##### --> +<!-- ##### FUNCTION nm_client_wwan_hardware_get_enabled ##### --> <para> </para> @@ -366,7 +454,7 @@ NMClient @Returns: -<!-- ##### FUNCTION nm_client_get_version ##### --> +<!-- ##### FUNCTION nm_client_wimax_get_enabled ##### --> <para> </para> @@ -375,62 +463,57 @@ NMClient @Returns: -<!-- ##### FUNCTION nm_client_networking_get_enabled ##### --> +<!-- ##### FUNCTION nm_client_wimax_set_enabled ##### --> <para> </para> @client: -@Returns: +@enabled: -<!-- ##### FUNCTION nm_client_networking_set_enabled ##### --> +<!-- ##### FUNCTION nm_client_wimax_hardware_get_enabled ##### --> <para> </para> @client: -@enabled: +@Returns: -<!-- ##### FUNCTION nm_client_new ##### --> +<!-- ##### FUNCTION nm_client_get_version ##### --> <para> </para> -@void: +@client: @Returns: -<!-- ##### FUNCTION nm_client_new_async ##### --> +<!-- ##### FUNCTION nm_client_get_state ##### --> <para> </para> -@cancellable: -@callback: -@user_data: +@client: +@Returns: -<!-- ##### FUNCTION nm_client_new_finish ##### --> +<!-- ##### FUNCTION nm_client_get_manager_running ##### --> <para> </para> -@result: -@error: +@client: @Returns: -<!-- ##### FUNCTION nm_client_set_logging ##### --> +<!-- ##### FUNCTION nm_client_get_active_connections ##### --> <para> </para> @client: -@level: -@domains: -@error: @Returns: @@ -443,34 +526,41 @@ NMClient @sleep_: -<!-- ##### FUNCTION nm_client_wimax_get_enabled ##### --> +<!-- ##### FUNCTION nm_client_get_permission_result ##### --> <para> </para> @client: +@permission: @Returns: -<!-- ##### FUNCTION nm_client_wimax_hardware_get_enabled ##### --> +<!-- ##### FUNCTION nm_client_get_logging ##### --> <para> </para> @client: +@level: +@domains: +@error: @Returns: -<!-- ##### FUNCTION nm_client_wimax_set_enabled ##### --> +<!-- ##### FUNCTION nm_client_set_logging ##### --> <para> </para> @client: -@enabled: +@level: +@domains: +@error: +@Returns: -<!-- ##### FUNCTION nm_client_wireless_get_enabled ##### --> +<!-- ##### FUNCTION nm_client_get_connectivity ##### --> <para> </para> @@ -479,34 +569,40 @@ NMClient @Returns: -<!-- ##### FUNCTION nm_client_wireless_hardware_get_enabled ##### --> +<!-- ##### FUNCTION nm_client_check_connectivity ##### --> <para> </para> @client: +@cancellable: +@error: @Returns: -<!-- ##### FUNCTION nm_client_wireless_set_enabled ##### --> +<!-- ##### FUNCTION nm_client_check_connectivity_async ##### --> <para> </para> @client: -@enabled: +@cancellable: +@callback: +@user_data: -<!-- ##### FUNCTION nm_client_wwan_get_enabled ##### --> +<!-- ##### FUNCTION nm_client_check_connectivity_finish ##### --> <para> </para> @client: +@result: +@error: @Returns: -<!-- ##### FUNCTION nm_client_wwan_hardware_get_enabled ##### --> +<!-- ##### FUNCTION nm_client_get_primary_connection ##### --> <para> </para> @@ -515,12 +611,12 @@ NMClient @Returns: -<!-- ##### FUNCTION nm_client_wwan_set_enabled ##### --> +<!-- ##### FUNCTION nm_client_get_activating_connection ##### --> <para> </para> @client: -@enabled: +@Returns: |