* Purple is the legal property of its developers, whose names are too numerous * to list here. Please refer to the COPYRIGHT file distributed with this * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * This program 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 General Public License for more details. * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA #ifndef PURPLE_REQUEST_DATA_H #define PURPLE_REQUEST_DATA_H * SECTION:request-datasheet * @section_id: libpurple-request-datasheet * @short_description: <filename>request-datasheet.h</filename> * @title: Request Datasheet API typedef struct _PurpleRequestDatasheet PurpleRequestDatasheet; typedef struct _PurpleRequestDatasheetRecord PurpleRequestDatasheetRecord; typedef struct _PurpleRequestDatasheetAction PurpleRequestDatasheetAction; typedef void (*PurpleRequestDatasheetActionCb)( PurpleRequestDatasheetRecord *rec, gpointer user_data); typedef gboolean (*PurpleRequestDatasheetActionCheckCb)( PurpleRequestDatasheetRecord *rec, gpointer user_data); * PurpleRequestDatasheetColumnType: * @PURPLE_REQUEST_DATASHEET_COLUMN_STRING: The column displays strings. * @PURPLE_REQUEST_DATASHEET_COLUMN_IMAGE: The column displays images. * The type of data to be shown in a column. PURPLE_REQUEST_DATASHEET_COLUMN_STRING, PURPLE_REQUEST_DATASHEET_COLUMN_IMAGE } PurpleRequestDatasheetColumnType; /**************************************************************************/ /**************************************************************************/ * purple_request_datasheet_new: * Returns: The new datasheet. purple_request_datasheet_new(void); * purple_request_datasheet_free: * Destroys datasheet with all its contents. purple_request_datasheet_free(PurpleRequestDatasheet *sheet); * purple_request_datasheet_add_column: * @type: The column type. * @title: The column title (may be %NULL). * Adds a column to the datasheet. * You cannot add a column if datasheet contains any data. purple_request_datasheet_add_column(PurpleRequestDatasheet *sheet, PurpleRequestDatasheetColumnType type, const gchar *title); * purple_request_datasheet_get_column_count: * Returns the column count of datasheet. * Returns: The column count. purple_request_datasheet_get_column_count(PurpleRequestDatasheet *sheet); * purple_request_datasheet_get_column_type: * @col_no: The column number (0 is the first one). * Returns the column type for a datasheet. * Returns: The column type. PurpleRequestDatasheetColumnType purple_request_datasheet_get_column_type(PurpleRequestDatasheet *sheet, * purple_request_datasheet_get_column_title: * @col_no: The column number (0 is the first one). * Returns the column title for a datasheet. * Returns: The column title. purple_request_datasheet_get_column_title(PurpleRequestDatasheet *sheet, * purple_request_datasheet_get_records: * Returns the list of records in a datasheet. * You shouldn't modify datasheet's data while iterating through it. * Returns: (element-type PurpleRequestDatasheetRecord) (transfer none): The list of records. purple_request_datasheet_get_records(PurpleRequestDatasheet *sheet); * purple_request_datasheet_add_action: * Adds an action to the datasheet. * Action object is owned by the datasheet since this call. purple_request_datasheet_add_action(PurpleRequestDatasheet *sheet, PurpleRequestDatasheetAction *action); * purple_request_datasheet_get_actions: * Returns the list of actions in a datasheet. * Returns: (element-type PurpleRequestDatasheetAction) (transfer none): The list of actions. purple_request_datasheet_get_actions(PurpleRequestDatasheet *sheet); /**************************************************************************/ /* Datasheet actions API */ /**************************************************************************/ * purple_request_datasheet_action_new: * Creates new datasheet action. * Returns: The new action. PurpleRequestDatasheetAction * purple_request_datasheet_action_new(void); * purple_request_datasheet_action_free: * Destroys the datasheet action. purple_request_datasheet_action_free(PurpleRequestDatasheetAction *act); * purple_request_datasheet_action_set_label: * Sets the localized label for the action. purple_request_datasheet_action_set_label(PurpleRequestDatasheetAction *act, * purple_request_datasheet_action_get_label: * Gets the label of action. * Returns: The localized label text. purple_request_datasheet_action_get_label(PurpleRequestDatasheetAction *act); * purple_request_datasheet_action_set_cb: * @cb: The callback function. * @user_data: The data to be passed to the callback function. * Sets the callback for the action. purple_request_datasheet_action_set_cb(PurpleRequestDatasheetAction *act, PurpleRequestDatasheetActionCb cb, gpointer user_data); * purple_request_datasheet_action_call: * @rec: The user selected record. * Calls the callback of the action. purple_request_datasheet_action_call(PurpleRequestDatasheetAction *act, PurpleRequestDatasheetRecord *rec); * purple_request_datasheet_action_set_sens_cb: * @cb: The callback function, may be %NULL. * @user_data: The data to be passed to the callback function. * Sets the sensitivity checker for the action. * If there is no callback set, default is used: the action is enabled, if any purple_request_datasheet_action_set_sens_cb( PurpleRequestDatasheetAction *act, PurpleRequestDatasheetActionCheckCb cb, gpointer user_data); * purple_request_datasheet_action_is_sensitive: * Checks, if the action is enabled for the active record. * Returns: %TRUE, if the action is enabled, %FALSE otherwise. purple_request_datasheet_action_is_sensitive(PurpleRequestDatasheetAction *act, PurpleRequestDatasheetRecord *rec); /**************************************************************************/ /* Datasheet record API */ /**************************************************************************/ * purple_request_datasheet_record_get_key: * Returns the key of a record. purple_request_datasheet_record_get_key( const PurpleRequestDatasheetRecord *rec); * purple_request_datasheet_record_get_datasheet: * Returns the datasheet of a record. * Returns: The datasheet. purple_request_datasheet_record_get_datasheet( PurpleRequestDatasheetRecord *rec); * purple_request_datasheet_record_find: * Looks up for a record in datasheet. * Returns: The record if found, %NULL otherwise. PurpleRequestDatasheetRecord * purple_request_datasheet_record_find(PurpleRequestDatasheet *sheet, * purple_request_datasheet_record_add: * Adds a record to the datasheet. * If the specified key already exists in datasheet, old record is returned. PurpleRequestDatasheetRecord * purple_request_datasheet_record_add(PurpleRequestDatasheet *sheet, * purple_request_datasheet_record_remove: * Removes a record from a datasheet. purple_request_datasheet_record_remove(PurpleRequestDatasheet *sheet, * purple_request_datasheet_record_remove_all: * Removes all records from a datasheet. purple_request_datasheet_record_remove_all(PurpleRequestDatasheet *sheet); * purple_request_datasheet_record_mark_all_for_rem: * Marks all records for removal. Record will be unmarked, when touched with * purple_request_datasheet_record_add. * See purple_request_datasheet_record_add(). purple_request_datasheet_record_mark_all_for_rem(PurpleRequestDatasheet *sheet); * purple_request_datasheet_record_remove_marked: * Removes all marked records. * See purple_request_datasheet_record_mark_all_for_rem(). purple_request_datasheet_record_remove_marked(PurpleRequestDatasheet *sheet); * purple_request_datasheet_record_set_string_data: * Sets data for a string column of specified record. purple_request_datasheet_record_set_string_data( PurpleRequestDatasheetRecord *rec, guint col_no, const gchar *data); * purple_request_datasheet_record_set_image_data: * @stock_id: The stock identifier of a image. * Sets data for a image column of specified record. purple_request_datasheet_record_set_image_data( PurpleRequestDatasheetRecord *rec, guint col_no, const gchar *stock_id); * purple_request_datasheet_record_get_string_data: * Returns data for a string column of specified record. purple_request_datasheet_record_get_string_data( const PurpleRequestDatasheetRecord *rec, guint col_no); * purple_request_datasheet_record_get_image_data: * Returns data for an image column of specified record. * Returns: The stock id of an image. purple_request_datasheet_record_get_image_data( const PurpleRequestDatasheetRecord *rec, guint col_no); #endif /* PURPLE_REQUEST_DATA_H */