]> Pileus Git - ~andy/gtk/blobdiff - gtk/gtkwidgetpath.h
Minor doc cleanup
[~andy/gtk] / gtk / gtkwidgetpath.h
index 234f79b9372121689763edc580d29a15b8f1103c..73bf7c0e19c5da2637ddc2df151886c7c46f0d8b 100644 (file)
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * License along with this library. If not, see <http://www.gnu.org/licenses/>.
  */
 
 #ifndef __GTK_WIDGET_PATH_H__
 #define __GTK_WIDGET_PATH_H__
 
+#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
+#error "Only <gtk/gtk.h> can be included directly."
+#endif
+
 #include <glib-object.h>
-#include "gtkenums.h"
+#include <gdk/gdk.h>
+#include <gtk/gtkenums.h>
+#include <gtk/gtktypes.h>
 
 G_BEGIN_DECLS
 
-typedef struct GtkWidgetPath GtkWidgetPath;
-
+#define GTK_TYPE_WIDGET_PATH (gtk_widget_path_get_type ())
 
-GtkWidgetPath * gtk_widget_path_new (void);
+GType           gtk_widget_path_get_type            (void) G_GNUC_CONST;
+GtkWidgetPath * gtk_widget_path_new                 (void);
 
 GtkWidgetPath * gtk_widget_path_copy                (const GtkWidgetPath *path);
+GDK_AVAILABLE_IN_3_2
+GtkWidgetPath * gtk_widget_path_ref                 (GtkWidgetPath       *path);
+GDK_AVAILABLE_IN_3_2
+void            gtk_widget_path_unref               (GtkWidgetPath       *path);
 void            gtk_widget_path_free                (GtkWidgetPath       *path);
 
-guint           gtk_widget_path_length              (const GtkWidgetPath *path);
+GDK_AVAILABLE_IN_3_2
+char *          gtk_widget_path_to_string           (const GtkWidgetPath *path);
+gint            gtk_widget_path_length              (const GtkWidgetPath *path);
 
-guint           gtk_widget_path_prepend_type        (GtkWidgetPath       *path,
+gint            gtk_widget_path_append_type         (GtkWidgetPath       *path,
                                                      GType                type);
-
-GType               gtk_widget_path_iter_get_widget_type (const GtkWidgetPath *path,
-                                                          guint                pos);
-void                gtk_widget_path_iter_set_widget_type (GtkWidgetPath       *path,
-                                                          guint                pos,
-                                                          GType                type);
-
-G_CONST_RETURN gchar * gtk_widget_path_iter_get_name  (const GtkWidgetPath *path,
-                                                       guint                pos);
+void            gtk_widget_path_prepend_type        (GtkWidgetPath       *path,
+                                                     GType                type);
+GDK_AVAILABLE_IN_3_2
+gint            gtk_widget_path_append_with_siblings(GtkWidgetPath       *path,
+                                                     GtkWidgetPath       *siblings,
+                                                     guint                sibling_index);
+/* gtk_widget_path_append_for_widget() is declared in gtkwidget.c */
+GDK_AVAILABLE_IN_3_2
+gint            gtk_widget_path_append_for_widget   (GtkWidgetPath       *path,
+                                                     GtkWidget           *widget);
+
+GType               gtk_widget_path_iter_get_object_type  (const GtkWidgetPath *path,
+                                                           gint                 pos);
+void                gtk_widget_path_iter_set_object_type  (GtkWidgetPath       *path,
+                                                           gint                 pos,
+                                                           GType                type);
+const GtkWidgetPath *
+                    gtk_widget_path_iter_get_siblings     (const GtkWidgetPath *path,
+                                                           gint                 pos);
+guint               gtk_widget_path_iter_get_sibling_index(const GtkWidgetPath *path,
+                                                           gint                 pos);
+
+const gchar *          gtk_widget_path_iter_get_name  (const GtkWidgetPath *path,
+                                                       gint                 pos);
 void                   gtk_widget_path_iter_set_name  (GtkWidgetPath       *path,
-                                                       guint                pos,
+                                                       gint                 pos,
                                                        const gchar         *name);
 gboolean               gtk_widget_path_iter_has_name  (const GtkWidgetPath *path,
-                                                       guint                pos,
+                                                       gint                 pos,
                                                        const gchar         *name);
 gboolean               gtk_widget_path_iter_has_qname (const GtkWidgetPath *path,
-                                                       guint                pos,
+                                                       gint                 pos,
                                                        GQuark               qname);
 
 void     gtk_widget_path_iter_add_class     (GtkWidgetPath       *path,
-                                             guint                pos,
+                                             gint                 pos,
                                              const gchar         *name);
 void     gtk_widget_path_iter_remove_class  (GtkWidgetPath       *path,
-                                             guint                pos,
+                                             gint                 pos,
                                              const gchar         *name);
 void     gtk_widget_path_iter_clear_classes (GtkWidgetPath       *path,
-                                             guint                pos);
+                                             gint                 pos);
 GSList * gtk_widget_path_iter_list_classes  (const GtkWidgetPath *path,
-                                             guint                pos);
+                                             gint                 pos);
 gboolean gtk_widget_path_iter_has_class     (const GtkWidgetPath *path,
-                                             guint                pos,
+                                             gint                 pos,
                                              const gchar         *name);
 gboolean gtk_widget_path_iter_has_qclass    (const GtkWidgetPath *path,
-                                             guint                pos,
+                                             gint                 pos,
                                              GQuark               qname);
 
 void     gtk_widget_path_iter_add_region    (GtkWidgetPath      *path,
-                                             guint               pos,
+                                             gint                pos,
                                              const gchar        *name,
                                              GtkRegionFlags     flags);
 void     gtk_widget_path_iter_remove_region (GtkWidgetPath      *path,
-                                             guint               pos,
+                                             gint                pos,
                                              const gchar        *name);
 void     gtk_widget_path_iter_clear_regions (GtkWidgetPath      *path,
-                                             guint               pos);
+                                             gint                pos);
 
 GSList * gtk_widget_path_iter_list_regions  (const GtkWidgetPath *path,
-                                             guint                pos);
+                                             gint                 pos);
 
 gboolean gtk_widget_path_iter_has_region    (const GtkWidgetPath *path,
-                                             guint                pos,
+                                             gint                 pos,
                                              const gchar         *name,
                                              GtkRegionFlags      *flags);
 gboolean gtk_widget_path_iter_has_qregion   (const GtkWidgetPath *path,
-                                             guint                pos,
+                                             gint                 pos,
                                              GQuark               qname,
                                              GtkRegionFlags      *flags);
 
-GType           gtk_widget_path_get_widget_type (const GtkWidgetPath *path);
+GType           gtk_widget_path_get_object_type (const GtkWidgetPath *path);
 
 gboolean        gtk_widget_path_is_type    (const GtkWidgetPath *path,
                                             GType                type);