Commit c5eedc04 authored by Matthias Clasen's avatar Matthias Clasen

Doc fixups

parent fe59413c
2005-05-02 Matthias Clasen <mclasen@redhat.com>
* gtk/gtkselection.c: Small doc fixes.
* gtk/gtkmenushell.c (gtk_menu_shell_set_take_focus):
(gtk_menu_shell_get_take_focus): Fix up the docs a bit.
......
2005-05-02 Matthias Clasen <mclasen@redhat.com>
* gtk/gtkselection.c: Small doc fixes.
* gtk/gtkmenushell.c (gtk_menu_shell_set_take_focus):
(gtk_menu_shell_get_take_focus): Fix up the docs a bit.
......
2005-05-02 Matthias Clasen <mclasen@redhat.com>
* gtk/gtkselection.c: Small doc fixes.
* gtk/gtkmenushell.c (gtk_menu_shell_set_take_focus):
(gtk_menu_shell_get_take_focus): Fix up the docs a bit.
......
2005-05-02 Matthias Clasen <mclasen@redhat.com>
* gtk/tmpl/gtkselection.sgml: Remove inlined docs.
* gtk/gtk-sections.txt: Remove nonexisting functions.
2005-04-29 Matthias Clasen <mclasen@redhat.com>
......
......@@ -85,50 +85,44 @@ selection handling code.
<!-- ##### FUNCTION gtk_target_list_new ##### -->
<para>
Creates a new #GtkTargetList from an array of #GtkTargetEntry.
</para>
@targets: Pointer to an array of #GtkTargetEntry
@ntargets: number of entries in @targets.
@Returns: the new #GtkTargetList.
@targets:
@ntargets:
@Returns:
<!-- ##### FUNCTION gtk_target_list_ref ##### -->
<para>
Increases the reference count of a #GtkTargetList by one.
</para>
@list: a #GtkTargetList
@list:
<!-- ##### FUNCTION gtk_target_list_unref ##### -->
<para>
Decreases the reference count of a #GtkTargetList by one.
If the resulting reference count is zero, frees the list.
</para>
@list: a #GtkTargetList
@list:
<!-- ##### FUNCTION gtk_target_list_add ##### -->
<para>
Adds another target to a #GtkTargetList.
</para>
@list: a #GtkTargetList
@target: the interned atom representing the target
@flags: the flags for this target
@info: an ID that will be passed back to the application
@list:
@target:
@flags:
@info:
<!-- ##### FUNCTION gtk_target_list_add_table ##### -->
<para>
Adds a table of #GtkTargetEntry into a target list.
</para>
@list: a #GtkTargetList
@targets: the table of #GtkTargetEntry
@ntargets: number of targets in the table
@list:
@targets:
@ntargets:
<!-- ##### FUNCTION gtk_target_list_add_text_targets ##### -->
......@@ -161,22 +155,20 @@ Adds a table of #GtkTargetEntry into a target list.
<!-- ##### FUNCTION gtk_target_list_remove ##### -->
<para>
Removes a target from a target list.
</para>
@list: a #GtkTargetList
@target: the interned atom representing the target
@list:
@target:
<!-- ##### FUNCTION gtk_target_list_find ##### -->
<para>
Looks up a given target in a #GtkTargetList.
</para>
@list: a #GtkTargetList
@target: an interned atom representing the target to search for
@info: a pointer to the location to store application info for target
@Returns: %TRUE if the target was found, otherwise %FALSE
@list:
@target:
@info:
@Returns:
<!-- ##### FUNCTION gtk_selection_owner_set ##### -->
......@@ -203,26 +195,22 @@ Looks up a given target in a #GtkTargetList.
<!-- ##### FUNCTION gtk_selection_add_target ##### -->
<para>
Adds specified target to the list of supported targets for a
given widget and selection.
</para>
@widget: a #GtkTarget
@selection: the selection
@target: target to add.
@info: A unsigned integer which will be passed back to the application.
@widget:
@selection:
@target:
@info:
<!-- ##### FUNCTION gtk_selection_add_targets ##### -->
<para>
Adds a table of targets to the list of supported targets
for a given widget and selection.
</para>
@widget: a #GtkWidget
@selection: the selection
@targets: a table of targets to add
@ntargets: number of entries in @targets
@widget:
@selection:
@targets:
@ntargets:
<!-- ##### FUNCTION gtk_selection_clear_targets ##### -->
......@@ -236,32 +224,24 @@ for a given widget and selection.
<!-- ##### FUNCTION gtk_selection_convert ##### -->
<para>
Requests the contents of a selection. When received,
a "selection_received" signal will be generated.
</para>
@widget: The widget which acts as requestor
@selection: Which selection to get
@target: Form of information desired (e.g., STRING)
@time_: Time of request (usually of triggering event)
In emergency, you could use #GDK_CURRENT_TIME
@Returns: %TRUE if requested succeeded. %FALSE if we could not process
request. (e.g., there was already a request in process for
this widget).
@widget:
@selection:
@target:
@time_:
@Returns: x
<!-- ##### FUNCTION gtk_selection_data_set ##### -->
<para>
Stores new data into a #GtkSelectionData object. Should
<emphasis>only</emphasis> be called from a selection handler callback.
Zero-terminates the stored data.
</para>
@selection_data:
@type: the type of selection data
@format: format (number of bits in a unit)
@data: pointer to the data (will be copied)
@length: length of the data
@type:
@format:
@data:
@length:
<!-- ##### FUNCTION gtk_selection_data_set_text ##### -->
......@@ -354,13 +334,9 @@ Zero-terminates the stored data.
<!-- ##### FUNCTION gtk_selection_remove_all ##### -->
<para>
Removes all handlers and unsets ownership of all
selections for a widget. Called when widget is being
destroyed. This function will not generally be
called by applications.
</para>
@widget: a #GtkWidget
@widget:
<!-- ##### FUNCTION gtk_selection_clear ##### -->
......@@ -374,19 +350,16 @@ called by applications.
<!-- ##### FUNCTION gtk_selection_data_copy ##### -->
<para>
Makes a copy of a #GtkSelectionData structure and its data.
</para>
@data: a pointer to a #GtkSelectionData structure.
@Returns: a pointer to a copy of @data.
@data:
@Returns:
<!-- ##### FUNCTION gtk_selection_data_free ##### -->
<para>
Frees a #GtkSelectionData structure returned from
gtk_selection_data_copy().
</para>
@data: a pointer to a #GtkSelectionData structure.
@data:
......@@ -2553,26 +2553,26 @@ gtk_selection_default_handler (GtkWidget *widget,
/**
* gtk_selection_data_copy:
* @selection_data: a pointer to a #GtkSelectionData structure.
* @data: a pointer to a #GtkSelectionData structure.
*
* Makes a copy of a #GtkSelectionData structure and its data.
*
* Return value: a pointer to a copy of @data.
**/
GtkSelectionData*
gtk_selection_data_copy (GtkSelectionData *selection_data)
gtk_selection_data_copy (GtkSelectionData *data)
{
GtkSelectionData *new_data;
g_return_val_if_fail (selection_data != NULL, NULL);
g_return_val_if_fail (data != NULL, NULL);
new_data = g_new (GtkSelectionData, 1);
*new_data = *selection_data;
if (selection_data->data)
if (data->data)
{
new_data->data = g_malloc (selection_data->length + 1);
memcpy (new_data->data, selection_data->data, selection_data->length + 1);
new_data->data = g_malloc (data->length + 1);
memcpy (new_data->data, data->data, data->length + 1);
}
return new_data;
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment