diff options
Diffstat (limited to 'docs/reference/gtk/tmpl/gtkeditable.sgml')
| -rw-r--r-- | docs/reference/gtk/tmpl/gtkeditable.sgml | 152 |
1 files changed, 76 insertions, 76 deletions
diff --git a/docs/reference/gtk/tmpl/gtkeditable.sgml b/docs/reference/gtk/tmpl/gtkeditable.sgml index 0d292c9e5..087d675bc 100644 --- a/docs/reference/gtk/tmpl/gtkeditable.sgml +++ b/docs/reference/gtk/tmpl/gtkeditable.sgml @@ -264,6 +264,17 @@ widget or not. in the widget. +<!-- ##### SIGNAL GtkEditable::activate ##### --> +<para> +Indicates that the user has activated the widget +in some fashion. Generally, this will be done +with a keystroke. (The default binding for this +action is Return for #GtkEntry and +Control-Return for #GtkText.) +</para> + +@editable: the object which received the signal. + <!-- ##### SIGNAL GtkEditable::changed ##### --> <para> Indicates that the user has changed the contents @@ -272,24 +283,22 @@ of the widget. @editable: the object which received the signal. -<!-- ##### SIGNAL GtkEditable::insert-text ##### --> +<!-- ##### SIGNAL GtkEditable::copy-clipboard ##### --> <para> -This signal is emitted when text is inserted into -the widget by the user. The default handler for -this signal will normally be responsible for inserting -the text, so by connecting to this signal and then -stopping the signal with gtk_signal_emit_stop(), it -is possible to modify the inserted text, or prevent -it from being inserted entirely. +An action signal. Causes the characters in the current selection to +be copied to the clipboard. +</para> + +@editable: the object which received the signal. + +<!-- ##### SIGNAL GtkEditable::cut-clipboard ##### --> +<para> +An action signal. Causes the characters in the current +selection to be copied to the clipboard and then deleted from +the widget. </para> @editable: the object which received the signal. -@new_text: the new text to insert. -@new_text_length: the length of the new text. -@position: the position at which to insert the new text. - this is an in-out paramter. After the signal - emission is finished, it should point after - the newly inserted text. <!-- ##### SIGNAL GtkEditable::delete-text ##### --> <para> @@ -308,64 +317,69 @@ gtk_editable_delete_text() @start_pos: the starting position. @end_pos: the end position. -<!-- ##### SIGNAL GtkEditable::activate ##### --> +<!-- ##### SIGNAL GtkEditable::insert-text ##### --> <para> -Indicates that the user has activated the widget -in some fashion. Generally, this will be done -with a keystroke. (The default binding for this -action is Return for #GtkEntry and -Control-Return for #GtkText.) +This signal is emitted when text is inserted into +the widget by the user. The default handler for +this signal will normally be responsible for inserting +the text, so by connecting to this signal and then +stopping the signal with gtk_signal_emit_stop(), it +is possible to modify the inserted text, or prevent +it from being inserted entirely. </para> @editable: the object which received the signal. +@new_text: the new text to insert. +@new_text_length: the length of the new text. +@position: the position at which to insert the new text. + this is an in-out paramter. After the signal + emission is finished, it should point after + the newly inserted text. -<!-- ##### SIGNAL GtkEditable::set-editable ##### --> +<!-- ##### SIGNAL GtkEditable::kill-char ##### --> <para> -Determines if the user can edit the text in the editable -widget or not. This is meant to be overriden by -child classes and should not generally useful to -applications. +An action signal. Delete a single character. </para> @editable: the object which received the signal. -@is_editable: %TRUE if the user is allowed to edit the text - in the widget. +@direction: the direction in which to delete. Positive + indicates forward deletion, negative, backwards deletion. -<!-- ##### SIGNAL GtkEditable::move-cursor ##### --> +<!-- ##### SIGNAL GtkEditable::kill-line ##### --> <para> -An action signal. Move the cursor position. +An action signal. Delete a single line. </para> @editable: the object which received the signal. -@x: horizontal distance to move the cursor. -@y: vertical distance to move the cursor. +@direction: the direction in which to delete. Positive + indicates forward deletion, negative, backwards deletion. -<!-- ##### SIGNAL GtkEditable::move-word ##### --> +<!-- ##### SIGNAL GtkEditable::kill-word ##### --> <para> -An action signal. Move the cursor by words. +An action signal. Delete a single word. </para> @editable: the object which received the signal. -@num_words: The number of words to move the -cursor. (Can be negative). +@direction: the direction in which to delete. Positive + indicates forward deletion, negative, backwards deletion. -<!-- ##### SIGNAL GtkEditable::move-page ##### --> +<!-- ##### SIGNAL GtkEditable::move-cursor ##### --> <para> -An action signal. Move the cursor by pages. +An action signal. Move the cursor position. </para> @editable: the object which received the signal. -@x: Number of pages to move the cursor horizontally. -@y: Number of pages to move the cursor vertically. +@x: horizontal distance to move the cursor. +@y: vertical distance to move the cursor. -<!-- ##### SIGNAL GtkEditable::move-to-row ##### --> +<!-- ##### SIGNAL GtkEditable::move-page ##### --> <para> -An action signal. Move the cursor to the given row. +An action signal. Move the cursor by pages. </para> @editable: the object which received the signal. -@row: the row to move to. (A negative value indicates - the last row) +@x: Number of pages to move the cursor horizontally. +@y: Number of pages to move the cursor vertically. <!-- ##### SIGNAL GtkEditable::move-to-column ##### --> <para> @@ -376,58 +390,44 @@ An action signal. Move the cursor to the given column. @column: the column to move to. (A negative value indicates the last column) -<!-- ##### SIGNAL GtkEditable::kill-char ##### --> -<para> -An action signal. Delete a single character. -</para> - -@editable: the object which received the signal. -@direction: the direction in which to delete. Positive - indicates forward deletion, negative, backwards deletion. - -<!-- ##### SIGNAL GtkEditable::kill-word ##### --> -<para> -An action signal. Delete a single word. -</para> - -@editable: the object which received the signal. -@direction: the direction in which to delete. Positive - indicates forward deletion, negative, backwards deletion. - -<!-- ##### SIGNAL GtkEditable::kill-line ##### --> +<!-- ##### SIGNAL GtkEditable::move-to-row ##### --> <para> -An action signal. Delete a single line. +An action signal. Move the cursor to the given row. </para> @editable: the object which received the signal. -@direction: the direction in which to delete. Positive - indicates forward deletion, negative, backwards deletion. +@row: the row to move to. (A negative value indicates + the last row) -<!-- ##### SIGNAL GtkEditable::cut-clipboard ##### --> +<!-- ##### SIGNAL GtkEditable::move-word ##### --> <para> -An action signal. Causes the characters in the current -selection to be copied to the clipboard and then deleted from -the widget. +An action signal. Move the cursor by words. </para> @editable: the object which received the signal. +@num_words: The number of words to move the +cursor. (Can be negative). -<!-- ##### SIGNAL GtkEditable::copy-clipboard ##### --> +<!-- ##### SIGNAL GtkEditable::paste-clipboard ##### --> <para> -An action signal. Causes the characters in the current selection to -be copied to the clipboard. +An action signal. Causes the contents of the clipboard to +be pasted into the editable widget at the current cursor +position. </para> @editable: the object which received the signal. -<!-- ##### SIGNAL GtkEditable::paste-clipboard ##### --> +<!-- ##### SIGNAL GtkEditable::set-editable ##### --> <para> -An action signal. Causes the contents of the clipboard to -be pasted into the editable widget at the current cursor -position. +Determines if the user can edit the text in the editable +widget or not. This is meant to be overriden by +child classes and should not generally useful to +applications. </para> @editable: the object which received the signal. +@is_editable: %TRUE if the user is allowed to edit the text + in the widget. <!-- ##### ARG GtkEditable:text_position ##### --> <para> |