Blame gcr/gcr-column.c

Packit b00eeb
/*
Packit b00eeb
 * gnome-keyring
Packit b00eeb
 *
Packit b00eeb
 * Copyright (C) 2011 Collabora Ltd.
Packit b00eeb
 *
Packit b00eeb
 * This program is free software; you can redistribute it and/or modify
Packit b00eeb
 * it under the terms of the GNU Lesser General Public License as
Packit b00eeb
 * published by the Free Software Foundation; either version 2.1 of
Packit b00eeb
 * the License, or (at your option) any later version.
Packit b00eeb
 *
Packit b00eeb
 * This program is distributed in the hope that it will be useful, but
Packit b00eeb
 * WITHOUT ANY WARRANTY; without even the implied warranty of
Packit b00eeb
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Packit b00eeb
 * Lesser General Public License for more details.
Packit b00eeb
 *
Packit b00eeb
 * You should have received a copy of the GNU Lesser General Public
Packit b00eeb
 * License along with this program; if not, see <http://www.gnu.org/licenses/>.
Packit b00eeb
 *
Packit b00eeb
 * Author: Stef Walter <stefw@collabora.co.uk>
Packit b00eeb
 */
Packit b00eeb
Packit b00eeb
#include "config.h"
Packit b00eeb
Packit b00eeb
#include "gcr-column.h"
Packit b00eeb
Packit b00eeb
/**
Packit b00eeb
 * SECTION:gcr-column
Packit b00eeb
 * @title: GcrColumn
Packit b00eeb
 * @short_description: Column information for selector or model.
Packit b00eeb
 *
Packit b00eeb
 * A #GcrColumn is used with #GcrTreeSelector or #GcrCollectionModel to define
Packit b00eeb
 * the columns to display.
Packit b00eeb
 */
Packit b00eeb
Packit b00eeb
/**
Packit b00eeb
 * GcrColumnFlags:
Packit b00eeb
 * @GCR_COLUMN_NONE: No column flags
Packit b00eeb
 * @GCR_COLUMN_HIDDEN: Don't display this column.
Packit b00eeb
 * @GCR_COLUMN_SORTABLE: This column is sortable.
Packit b00eeb
 *
Packit b00eeb
 * Flags to be used with #GcrColumn
Packit b00eeb
 */
Packit b00eeb
Packit b00eeb
/**
Packit b00eeb
 * GcrColumn:
Packit b00eeb
 * @property_name: The name of the property this column will display
Packit b00eeb
 * @property_type: The type of the property
Packit b00eeb
 * @column_type: The eventual type of the column
Packit b00eeb
 * @label: The display label for the column
Packit b00eeb
 * @flags: Flags from #GcrColumnFlags
Packit b00eeb
 * @transformer: A transformer function used to convert the value from
Packit b00eeb
 *     the property type to the column type. Can be %NULL if the types
Packit b00eeb
 *     are the same.
Packit b00eeb
 * @user_data: User data associated with the column
Packit b00eeb
 *
Packit b00eeb
 * Represents a column to display in a #GcrCollectionModel or #GcrTreeSelector.
Packit b00eeb
 *
Packit b00eeb
 * The label should be set as a translatable string with a context of
Packit b00eeb
 * "column". This should be done with with this macro:
Packit b00eeb
 *
Packit b00eeb
 * <informalexample><programlisting>
Packit b00eeb
 * NC_("column", "My Column Name")
Packit b00eeb
 * </programlisting></informalexample>
Packit b00eeb
 */