X-Git-Url: http://git.meshlink.io/?a=blobdiff_plain;f=avahi-ui%2Favahi-ui.h;h=aae61dcdab1850b5a245a08b5c8da68d69712697;hb=72223abd8a3b53f539e020b354bdfbbfc579473d;hp=592d09bca0d454d6ab58458f1456ea73ea896f4a;hpb=e5cc6bde6390048349a3edef991d9278a13cdaf6;p=catta

diff --git a/avahi-ui/avahi-ui.h b/avahi-ui/avahi-ui.h
index 592d09b..aae61dc 100644
--- a/avahi-ui/avahi-ui.h
+++ b/avahi-ui/avahi-ui.h
@@ -1,29 +1,26 @@
 #ifndef fooavahiuihfoo
 #define fooavahiuihfoo
 
-/* $Id$ */
-
 /***
   This file is part of avahi.
- 
+
   avahi is free software; you can redistribute it and/or modify it
   under the terms of the GNU Lesser General Public License as
   published by the Free Software Foundation; either version 2.1 of the
   License, or (at your option) any later version.
- 
+
   avahi is distributed in the hope that it will be useful, but WITHOUT
   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
   or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
   Public License for more details.
- 
+
   You should have received a copy of the GNU Lesser General Public
   License along with avahi; if not, write to the Free Software
   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
   USA.
 ***/
 
-#include <gtk/gtkwidget.h>
-#include <gtk/gtkdialog.h>
+#include <gtk/gtk.h>
 
 #include <avahi-client/client.h>
 
@@ -45,7 +42,7 @@ typedef struct _AuiServiceDialogClass  AuiServiceDialogClass;
 
 struct _AuiServiceDialogClass {
     GtkDialogClass parent_class;
-    
+
     /* Padding for future expansion */
     void (*_aui_reserved1)(void);
     void (*_aui_reserved2)(void);
@@ -66,6 +63,8 @@ GType aui_service_dialog_get_type(void) G_GNUC_CONST;
 /** The GTK service dialog structure */
 typedef struct _AuiServiceDialog AuiServiceDialog;
 
+/** @{ \name Construction */
+
 /** Create a new service browser dialog with the specific title,
  * parent window and the speicified buttons. The buttons are specified
  * in a similar way to GtkFileChooserDialog. Please note that at least
@@ -75,13 +74,17 @@ GtkWidget* aui_service_dialog_new(
         GtkWindow *parent,
         const gchar *first_button_text, ...) G_GNUC_NULL_TERMINATED;
 
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
+/** \cond fulldocs */
 GtkWidget *aui_service_dialog_new_valist(
-        gchar *title,
+        const gchar *title,
         GtkWindow *parent,
         const gchar *first_button_text,
         va_list varargs);
-#endif
+/** \endcond */
+
+/** @} */
+
+/** @{ \name Service types to browse for */
 
 /** Select the service types to browse for. Takes a NULL terminated list of DNS-SD service types. i.e. _http._tcp */
 void aui_service_dialog_set_browse_service_types(AuiServiceDialog *d, const gchar *type, ...) G_GNUC_NULL_TERMINATED;
@@ -89,12 +92,22 @@ void aui_service_dialog_set_browse_service_types(AuiServiceDialog *d, const gcha
 void aui_service_dialog_set_browse_service_typesv(AuiServiceDialog *d, const gchar *const*type);
 /** Return the service types currently browsed for. i.e. what was previously set with aui_service_dialog_set_browse_service_types() */
 const gchar*const* aui_service_dialog_get_browse_service_types(AuiServiceDialog *d);
+/** Overwrite the pretty name shown in the service type column. \since 0.6.22 */
+void aui_service_dialog_set_service_type_name(AuiServiceDialog *d, const gchar *type, const gchar *name);
+
+/** @} */
+
+/** @{ \name Domain to browse in */
 
 /** Set the domain to browse in */
 void aui_service_dialog_set_domain(AuiServiceDialog *d, const gchar *domain);
 /** Query the domain that is browsed in */
 const gchar* aui_service_dialog_get_domain(AuiServiceDialog *d);
 
+/** @} */
+
+/** @{ \name Selected service item */
+
 /** Set the service type for the service to select */
 void aui_service_dialog_set_service_type(AuiServiceDialog *d, const gchar *name);
 
@@ -107,6 +120,10 @@ void aui_service_dialog_set_service_name(AuiServiceDialog *d, const gchar *name)
 /** Query the service name of the currently select service */
 const gchar* aui_service_dialog_get_service_name(AuiServiceDialog *d);
 
+/** @} */
+
+/** @{ \name Resolved service information */
+
 /** Return the IP address of the selected service. (Only valid if host name resolving has not been disabled via aui_service_dialog_set_resolve_host_name()) */
 const AvahiAddress* aui_service_dialog_get_address(AuiServiceDialog *d);
 
@@ -119,6 +136,10 @@ const gchar* aui_service_dialog_get_host_name(AuiServiceDialog *d);
 /** Return the TXT metadata of the selected service */
 const AvahiStringList *aui_service_dialog_get_txt_data(AuiServiceDialog *d);
 
+/** @} */
+
+/** @{ \name Resolving settings */
+
 /** Disable/Enable automatic service resolving. Disabling this feature
  * will require you to resolve the selected service on our own. I.e. the port
  * number, the TXT data and the host name/IP address will not be
@@ -141,6 +162,10 @@ void aui_service_dialog_set_resolve_host_name(AuiServiceDialog *d, gboolean reso
 /** Query the last status of aui_service_dialog_set_resolve_host_name() */
 gboolean aui_service_dialog_get_resolve_host_name(AuiServiceDialog *d);
 
+/** @} */
+
+/** @{ \name Address family */
+
 /** Select the address family to look for services of. This can be
 used to look only for IPv6 services or only for IPv4 services. By
 default avahi-ui will browse for both IPv4 and IPv6 services.*/
@@ -149,8 +174,8 @@ void aui_service_dialog_set_address_family(AuiServiceDialog *d, AvahiProtocol pr
 /** Query the address family we're looking for. */
 AvahiProtocol aui_service_dialog_get_address_family(AuiServiceDialog *d);
 
+/** @} */
+
 G_END_DECLS
 
 #endif
-
-