]> Pileus Git - ~andy/gtk/blobdiff - gtk/gtktreesortable.c
filechooserbutton: HACK: Set a reasonable size for the dialog in the tests' second...
[~andy/gtk] / gtk / gtktreesortable.c
index d6cd4e2d1e233dbdda485d0f4fb488ee398cb799..0eeadc5e8be333c8ae50f93da791e0879a93d4e2 100644 (file)
@@ -12,9 +12,7 @@
  * Library General Public License for more details.
  *
  * You should have received a copy of the GNU Library 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/>.
  */
 
 
 #include "gtktreesortable.h"
 #include "gtkmarshalers.h"
 #include "gtkintl.h"
-#include "gtkalias.h"
+
+
+/**
+ * SECTION:gtktreesortable
+ * @Short_description: The interface for sortable models used by GtkTreeView
+ * @Title: GtkTreeSortable
+ * @See_also:#GtkTreeModel, #GtkTreeView
+ *
+ * #GtkTreeSortable is an interface to be implemented by tree models which
+ * support sorting. The #GtkTreeView uses the methods provided by this interface
+ * to sort the model.
+ */
+
 
 static void gtk_tree_sortable_base_init (gpointer g_class);
 
@@ -99,8 +109,8 @@ gtk_tree_sortable_sort_column_changed (GtkTreeSortable *sortable)
 /**
  * gtk_tree_sortable_get_sort_column_id:
  * @sortable: A #GtkTreeSortable
- * @sort_column_id: The sort column id to be filled in
- * @order: The #GtkSortType to be filled in
+ * @sort_column_id: (out): The sort column id to be filled in
+ * @order: (out): The #GtkSortType to be filled in
  * 
  * Fills in @sort_column_id and @order with the current sort column and the
  * order. It returns %TRUE unless the @sort_column_id is 
@@ -135,7 +145,7 @@ gtk_tree_sortable_get_sort_column_id (GtkTreeSortable  *sortable,
  * 
  * Sets the current sort column to be @sort_column_id. The @sortable will
  * resort itself to reflect this change, after emitting a
- * #GtkTreeSortable::sort-column-changed signal. @sortable may either be 
+ * #GtkTreeSortable::sort-column-changed signal. @sort_column_id may either be
  * a regular column id, or one of the following special values:
  * <variablelist>
  * <varlistentry>
@@ -170,8 +180,8 @@ gtk_tree_sortable_set_sort_column_id (GtkTreeSortable  *sortable,
  * @sortable: A #GtkTreeSortable
  * @sort_column_id: the sort column id to set the function for
  * @sort_func: The comparison function
- * @user_data: User data to pass to @sort_func, or %NULL
- * @destroy: Destroy notifier of @user_data, or %NULL
+ * @user_data: (allow-none): User data to pass to @sort_func, or %NULL
+ * @destroy: (allow-none): Destroy notifier of @user_data, or %NULL
  * 
  * Sets the comparison function used when sorting to be @sort_func. If the
  * current sort column id of @sortable is the same as @sort_column_id, then 
@@ -202,8 +212,8 @@ gtk_tree_sortable_set_sort_func (GtkTreeSortable        *sortable,
  * gtk_tree_sortable_set_default_sort_func:
  * @sortable: A #GtkTreeSortable
  * @sort_func: The comparison function
- * @user_data: User data to pass to @sort_func, or %NULL
- * @destroy: Destroy notifier of @user_data, or %NULL
+ * @user_data: (allow-none): User data to pass to @sort_func, or %NULL
+ * @destroy: (allow-none): Destroy notifier of @user_data, or %NULL
  * 
  * Sets the default comparison function used when sorting to be @sort_func.  
  * If the current sort column id of @sortable is
@@ -257,6 +267,3 @@ gtk_tree_sortable_has_default_sort_func (GtkTreeSortable *sortable)
   
   return (* iface->has_default_sort_func) (sortable);
 }
-
-#define __GTK_TREE_SORTABLE_C__
-#include "gtkaliasdef.c"