|
Server : Apache/2.2.17 (Unix) mod_ssl/2.2.17 OpenSSL/0.9.8e-fips-rhel5 DAV/2 PHP/5.2.17 System : Linux localhost 2.6.18-419.el5 #1 SMP Fri Feb 24 22:47:42 UTC 2017 x86_64 User : nobody ( 99) PHP Version : 5.2.17 Disable Function : NONE Directory : /usr/share/gtk-doc/html/gtk/ |
Upload File : |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>GtkEditable</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
<link rel="start" href="index.html" title="GTK+ Reference Manual">
<link rel="up" href="NumericEntry.html" title="Numeric/Text Data Entry">
<link rel="prev" href="GtkSpinButton.html" title="GtkSpinButton">
<link rel="next" href="TextWidgetObjects.html" title="Multiline Text Editor">
<meta name="generator" content="GTK-Doc V1.6 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="gtk.html" title="Part I. GTK+ Overview">
<link rel="part" href="gtkbase.html" title="Part II. GTK+ Core Reference">
<link rel="part" href="gtkobjects.html" title="Part III. GTK+ Widgets and Objects">
<link rel="chapter" href="ch01.html" title="Object Hierarchy">
<link rel="chapter" href="ch02.html" title="Widget Gallery">
<link rel="chapter" href="WindowWidgets.html" title="Windows">
<link rel="chapter" href="DisplayWidgets.html" title="Display Widgets">
<link rel="chapter" href="ButtonWidgets.html" title="Buttons and Toggles">
<link rel="chapter" href="NumericEntry.html" title="Numeric/Text Data Entry">
<link rel="chapter" href="TextWidgetObjects.html" title="Multiline Text Editor">
<link rel="chapter" href="TreeWidgetObjects.html" title="Tree, List and Icon Grid Widgets">
<link rel="chapter" href="MenusAndCombos.html" title="Menus, Combo Box, Toolbar">
<link rel="chapter" href="Actions.html" title="Action-based menus and toolbars">
<link rel="chapter" href="SelectorWidgets.html" title="Selectors (File/Font/Color/Input Devices)">
<link rel="chapter" href="LayoutContainers.html" title="Layout Containers">
<link rel="chapter" href="Ornaments.html" title="Ornaments">
<link rel="chapter" href="ScrollingWidgets.html" title="Scrolling">
<link rel="chapter" href="Printing.html" title="Printing">
<link rel="chapter" href="MiscObjects.html" title="Miscellaneous">
<link rel="chapter" href="AbstractObjects.html" title="Abstract Base Classes">
<link rel="chapter" href="PlugSocket.html" title="Cross-process Embedding">
<link rel="chapter" href="SpecialObjects.html" title="Special-purpose features">
<link rel="chapter" href="RecentDocuments.html" title="Recently Used Documents">
<link rel="chapter" href="DeprecatedObjects.html" title="Deprecated">
<link rel="part" href="migrating.html" title="Part IV. Migrating from Previous Versions of GTK+">
<link rel="chapter" href="gtk-migrating-checklist.html" title="Migration Checklist">
<link rel="chapter" href="gtk-migrating-GtkFileChooser.html" title="Migrating from GtkFileSelection to GtkFileChooser">
<link rel="chapter" href="gtk-migrating-GtkAction.html" title="Migrating from old menu and toolbar systems to GtkAction">
<link rel="chapter" href="gtk-migrating-GtkComboBox.html" title="Migrating from GtkOptionMenu and GtkCombo to GtkComboBox and
GtkComboBoxEntry">
<link rel="chapter" href="gtk-migrating-GtkIconView.html" title="Migrating from GnomeIconList to GtkIconView">
<link rel="chapter" href="gtk-migrating-GtkAboutDialog.html" title="Migrating from GnomeAbout to GtkAboutDialog">
<link rel="chapter" href="gtk-migrating-GtkColorButton.html" title="Migrating from GnomeColorPicker to GtkColorButton">
<link rel="chapter" href="gtk-migrating-GtkAssistant.html" title="Migrating from GnomeDruid to GtkAssistant">
<link rel="chapter" href="gtk-migrating-GtkRecentChooser.html" title="Migrating from EggRecent to GtkRecentChooser">
<link rel="chapter" href="gtk-migrating-GtkLinkButton.html" title="Migrating from GnomeHRef to GtkLinkButton">
<link rel="part" href="pt05.html" title="Part V. GTK+ Tools">
<link rel="glossary" href="glossary.html" title="Glossary">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of deprecated symbols">
<link rel="index" href="ix03.html" title="Index of new symbols in 2.2">
<link rel="index" href="ix04.html" title="Index of new symbols in 2.4">
<link rel="index" href="ix05.html" title="Index of new symbols in 2.6">
<link rel="index" href="ix06.html" title="Index of new symbols in 2.8">
<link rel="index" href="ix07.html" title="Index of new symbols in 2.10">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="GtkSpinButton.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="NumericEntry.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GTK+ Reference Manual</th>
<td><a accesskey="n" href="TextWidgetObjects.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2962097" class="shortcut">Top</a>
 | 
<a href="#id2962731" class="shortcut">Description</a>
 | 
<a href="#id2962510" class="shortcut">Object Hierarchy</a>
 | 
<a href="#id2962535" class="shortcut">Known Implementations</a>
 | 
<a href="#id2962578" class="shortcut">Signals</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="GtkEditable"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2962097"></a><span class="refentrytitle">GtkEditable</span>
</h2>
<p>GtkEditable — Interface for text-editing widgets</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
#include <gtk/gtk.h>
<a href="GtkEditable.html#GtkEditable-struct">GtkEditable</a>;
void <a href="GtkEditable.html#gtk-editable-select-region">gtk_editable_select_region</a> (<a href="GtkEditable.html" title="GtkEditable">GtkEditable</a> *editable,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> start,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> end);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="GtkEditable.html#gtk-editable-get-selection-bounds">gtk_editable_get_selection_bounds</a>
(<a href="GtkEditable.html" title="GtkEditable">GtkEditable</a> *editable,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *start,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *end);
void <a href="GtkEditable.html#gtk-editable-insert-text">gtk_editable_insert_text</a> (<a href="GtkEditable.html" title="GtkEditable">GtkEditable</a> *editable,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *new_text,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> new_text_length,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *position);
void <a href="GtkEditable.html#gtk-editable-delete-text">gtk_editable_delete_text</a> (<a href="GtkEditable.html" title="GtkEditable">GtkEditable</a> *editable,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> start_pos,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> end_pos);
<a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a href="GtkEditable.html#gtk-editable-get-chars">gtk_editable_get_chars</a> (<a href="GtkEditable.html" title="GtkEditable">GtkEditable</a> *editable,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> start_pos,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> end_pos);
void <a href="GtkEditable.html#gtk-editable-cut-clipboard">gtk_editable_cut_clipboard</a> (<a href="GtkEditable.html" title="GtkEditable">GtkEditable</a> *editable);
void <a href="GtkEditable.html#gtk-editable-copy-clipboard">gtk_editable_copy_clipboard</a> (<a href="GtkEditable.html" title="GtkEditable">GtkEditable</a> *editable);
void <a href="GtkEditable.html#gtk-editable-paste-clipboard">gtk_editable_paste_clipboard</a> (<a href="GtkEditable.html" title="GtkEditable">GtkEditable</a> *editable);
void <a href="GtkEditable.html#gtk-editable-delete-selection">gtk_editable_delete_selection</a> (<a href="GtkEditable.html" title="GtkEditable">GtkEditable</a> *editable);
void <a href="GtkEditable.html#gtk-editable-set-position">gtk_editable_set_position</a> (<a href="GtkEditable.html" title="GtkEditable">GtkEditable</a> *editable,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> position);
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> <a href="GtkEditable.html#gtk-editable-get-position">gtk_editable_get_position</a> (<a href="GtkEditable.html" title="GtkEditable">GtkEditable</a> *editable);
void <a href="GtkEditable.html#gtk-editable-set-editable">gtk_editable_set_editable</a> (<a href="GtkEditable.html" title="GtkEditable">GtkEditable</a> *editable,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> is_editable);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="GtkEditable.html#gtk-editable-get-editable">gtk_editable_get_editable</a> (<a href="GtkEditable.html" title="GtkEditable">GtkEditable</a> *editable);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2962510"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GInterface
+----GtkEditable
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2962535"></a><h2>Known Implementations</h2>
<p>
GtkEditable is implemented by
<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a>, <a href="GtkOldEditable.html" title="GtkOldEditable">GtkOldEditable</a>, <a href="GtkSpinButton.html" title="GtkSpinButton">GtkSpinButton</a> and <a href="GtkText.html" title="GtkText">GtkText</a>.</p>
</div>
<div class="refsect1" lang="en">
<a name="id2962578"></a><h2>Signals</h2>
<pre class="synopsis">
"<a href="GtkEditable.html#GtkEditable-changed">changed</a>" void user_function (<a href="GtkEditable.html" title="GtkEditable">GtkEditable</a> *editable,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last
"<a href="GtkEditable.html#GtkEditable-delete-text">delete-text</a>"
void user_function (<a href="GtkEditable.html" title="GtkEditable">GtkEditable</a> *editable,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> start_pos,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> end_pos,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last
"<a href="GtkEditable.html#GtkEditable-insert-text">insert-text</a>"
void user_function (<a href="GtkEditable.html" title="GtkEditable">GtkEditable</a> *editable,
<a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *new_text,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> new_text_length,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *position,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2962731"></a><h2>Description</h2>
<p>
The <a href="GtkEditable.html" title="GtkEditable"><span class="type">GtkEditable</span></a> interface is an interface which should be implemented by
text editing widgets, such as <a href="GtkEntry.html" title="GtkEntry"><span class="type">GtkEntry</span></a> and <a href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a>. It contains functions
for generically manipulating an editable widget, a large number of action
signals used for key bindings, and several signals that an application can
connect to to modify the behavior of a widget.
</p>
<p>
As an example of the latter usage, by connecting
the following handler to "insert_text", an application
can convert all entry into a widget into uppercase.
</p>
<div class="example">
<a name="id2962778"></a><p class="title"><b>Example 3. Forcing entry to uppercase.</b></p>
<pre class="programlisting">
<span class="type">include</span> <ctype.h>
void
insert_text_handler (GtkEditable *editable,
const gchar *text,
gint length,
gint *position,
gpointer data)
{
int i;
gchar *result = g_utf8_strup (text, length);
g_signal_handlers_block_by_func (editable,
(gpointer) insert_text_handler, data);
gtk_editable_insert_text (editable, result, length, position);
g_signal_handlers_unblock_by_func (editable,
(gpointer) insert_text_handler, data);
g_signal_stop_emission_by_name (editable, "insert_text");
g_free (result);
}
</pre>
</div>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2961949"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2961960"></a><h3>
<a name="GtkEditable-struct"></a>GtkEditable</h3>
<a class="indexterm" name="id2961973"></a><pre class="programlisting">typedef struct _GtkEditable GtkEditable;</pre>
<p>
The <a href="GtkEditable.html" title="GtkEditable"><span class="type">GtkEditable</span></a> structure contains the following fields.
(These fields should be considered read-only. They should
never be set by an application.)
</p>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td>
<a
href="../glib/glib-Basic-Types.html#guint"
><span class="type">guint</span></a> selection_start;</td>
<td>the starting position of the selected characters
in the widget.</td>
</tr>
<tr>
<td>
<a
href="../glib/glib-Basic-Types.html#guint"
><span class="type">guint</span></a> selection_end;</td>
<td>the end position of the selected characters
in the widget.</td>
</tr>
<tr>
<td>
<a
href="../glib/glib-Basic-Types.html#guint"
><span class="type">guint</span></a> editable;</td>
<td>a flag indicating whether or not the widget is
editable by the user.</td>
</tr>
</tbody>
</table></div>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2962078"></a><h3>
<a name="gtk-editable-select-region"></a>gtk_editable_select_region ()</h3>
<a class="indexterm" name="id2963101"></a><pre class="programlisting">void gtk_editable_select_region (<a href="GtkEditable.html" title="GtkEditable">GtkEditable</a> *editable,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> start,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> end);</pre>
<p>
Selects a region of text. The characters that
are selected are those characters at positions from
<em class="parameter"><code>start_pos</code></em> up to, but not including <em class="parameter"><code>end_pos</code></em>. If
<em class="parameter"><code>end_pos</code></em> is negative, then the the characters selected
will be those characters from <em class="parameter"><code>start_pos</code></em> to the end
of the text.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>editable</code></em> :</span></td>
<td>a <a href="GtkEditable.html" title="GtkEditable"><span class="type">GtkEditable</span></a> widget.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>start</code></em> :</span></td>
<td>the starting position.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>end</code></em> :</span></td>
<td>the end position.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2963225"></a><h3>
<a name="gtk-editable-get-selection-bounds"></a>gtk_editable_get_selection_bounds ()</h3>
<a class="indexterm" name="id2963238"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gtk_editable_get_selection_bounds
(<a href="GtkEditable.html" title="GtkEditable">GtkEditable</a> *editable,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *start,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *end);</pre>
<p>
Gets the current selection bounds, if there is a selection.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>editable</code></em> :</span></td>
<td>a <a href="GtkEditable.html" title="GtkEditable"><span class="type">GtkEditable</span></a> widget.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>start</code></em> :</span></td>
<td>location to store the starting position, or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>end</code></em> :</span></td>
<td>location to store the end position, or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>
<a
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> if there is a selection.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2963377"></a><h3>
<a name="gtk-editable-insert-text"></a>gtk_editable_insert_text ()</h3>
<a class="indexterm" name="id2963390"></a><pre class="programlisting">void gtk_editable_insert_text (<a href="GtkEditable.html" title="GtkEditable">GtkEditable</a> *editable,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *new_text,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> new_text_length,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *position);</pre>
<p>
Inserts text at a given position.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>editable</code></em> :</span></td>
<td>a <a href="GtkEditable.html" title="GtkEditable"><span class="type">GtkEditable</span></a> widget.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>new_text</code></em> :</span></td>
<td>the text to insert.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>new_text_length</code></em> :</span></td>
<td>the length of the text to insert, in bytes
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>position</code></em> :</span></td>
<td>an inout parameter. The caller initializes it to
the position at which to insert the text. After the
call it points at the position after the newly
inserted text.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2963514"></a><h3>
<a name="gtk-editable-delete-text"></a>gtk_editable_delete_text ()</h3>
<a class="indexterm" name="id2963527"></a><pre class="programlisting">void gtk_editable_delete_text (<a href="GtkEditable.html" title="GtkEditable">GtkEditable</a> *editable,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> start_pos,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> end_pos);</pre>
<p>
Deletes a sequence of characters. The characters that
are deleted are those characters at positions from
<em class="parameter"><code>start_pos</code></em> up to, but not including <em class="parameter"><code>end_pos</code></em>. If
<em class="parameter"><code>end_pos</code></em> is negative, then the the characters deleted
will be those characters from <em class="parameter"><code>start_pos</code></em> to the end
of the text.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>editable</code></em> :</span></td>
<td>a <a href="GtkEditable.html" title="GtkEditable"><span class="type">GtkEditable</span></a> widget.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>start_pos</code></em> :</span></td>
<td>the starting position.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>end_pos</code></em> :</span></td>
<td>the end position.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2963652"></a><h3>
<a name="gtk-editable-get-chars"></a>gtk_editable_get_chars ()</h3>
<a class="indexterm" name="id2963665"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* gtk_editable_get_chars (<a href="GtkEditable.html" title="GtkEditable">GtkEditable</a> *editable,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> start_pos,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> end_pos);</pre>
<p>
Retrieves a sequence of characters. The characters that
are retrieved are those characters at positions from
<em class="parameter"><code>start_pos</code></em> up to, but not including <em class="parameter"><code>end_pos</code></em>. If
<em class="parameter"><code>end_pos</code></em> is negative, then the the characters retrieved
will be those characters from <em class="parameter"><code>start_pos</code></em> to the end
of the text.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>editable</code></em> :</span></td>
<td>a <a href="GtkEditable.html" title="GtkEditable"><span class="type">GtkEditable</span></a> widget.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>start_pos</code></em> :</span></td>
<td>the starting position.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>end_pos</code></em> :</span></td>
<td>the end position.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>the characters in the indicated region.
The result must be freed with <a
href="../glib/glib-Memory-Allocation.html#g-free"
><code class="function">g_free()</code></a> when
the application is finished with it.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2963813"></a><h3>
<a name="gtk-editable-cut-clipboard"></a>gtk_editable_cut_clipboard ()</h3>
<a class="indexterm" name="id2963827"></a><pre class="programlisting">void gtk_editable_cut_clipboard (<a href="GtkEditable.html" title="GtkEditable">GtkEditable</a> *editable);</pre>
<p>
Causes the characters in the current selection to
be copied to the clipboard and then deleted from
the widget.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><em class="parameter"><code>editable</code></em> :</span></td>
<td>a <a href="GtkEditable.html" title="GtkEditable"><span class="type">GtkEditable</span></a> widget.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2963883"></a><h3>
<a name="gtk-editable-copy-clipboard"></a>gtk_editable_copy_clipboard ()</h3>
<a class="indexterm" name="id2963896"></a><pre class="programlisting">void gtk_editable_copy_clipboard (<a href="GtkEditable.html" title="GtkEditable">GtkEditable</a> *editable);</pre>
<p>
Causes the characters in the current selection to
be copied to the clipboard.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><em class="parameter"><code>editable</code></em> :</span></td>
<td>a <a href="GtkEditable.html" title="GtkEditable"><span class="type">GtkEditable</span></a> widget.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2963951"></a><h3>
<a name="gtk-editable-paste-clipboard"></a>gtk_editable_paste_clipboard ()</h3>
<a class="indexterm" name="id2963965"></a><pre class="programlisting">void gtk_editable_paste_clipboard (<a href="GtkEditable.html" title="GtkEditable">GtkEditable</a> *editable);</pre>
<p>
Causes the contents of the clipboard to be pasted into
the given widget at the current cursor position.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><em class="parameter"><code>editable</code></em> :</span></td>
<td>a <a href="GtkEditable.html" title="GtkEditable"><span class="type">GtkEditable</span></a> widget.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2964021"></a><h3>
<a name="gtk-editable-delete-selection"></a>gtk_editable_delete_selection ()</h3>
<a class="indexterm" name="id2964035"></a><pre class="programlisting">void gtk_editable_delete_selection (<a href="GtkEditable.html" title="GtkEditable">GtkEditable</a> *editable);</pre>
<p>
Deletes the current contents of the widgets selection and
disclaims the selection.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><em class="parameter"><code>editable</code></em> :</span></td>
<td>a <a href="GtkEditable.html" title="GtkEditable"><span class="type">GtkEditable</span></a> widget.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2964091"></a><h3>
<a name="gtk-editable-set-position"></a>gtk_editable_set_position ()</h3>
<a class="indexterm" name="id2964104"></a><pre class="programlisting">void gtk_editable_set_position (<a href="GtkEditable.html" title="GtkEditable">GtkEditable</a> *editable,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> position);</pre>
<p>
Sets the cursor position.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>editable</code></em> :</span></td>
<td>a <a href="GtkEditable.html" title="GtkEditable"><span class="type">GtkEditable</span></a> widget.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>position</code></em> :</span></td>
<td>the position of the cursor. The cursor is displayed
before the character with the given (base 0) index
in the widget. The value must be less than or
equal to the number of characters in the widget.
A value of -1 indicates that the position should
be set after the last character in the entry.
Note that this position is in characters, not in
bytes.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2964187"></a><h3>
<a name="gtk-editable-get-position"></a>gtk_editable_get_position ()</h3>
<a class="indexterm" name="id2964201"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> gtk_editable_get_position (<a href="GtkEditable.html" title="GtkEditable">GtkEditable</a> *editable);</pre>
<p>
Retrieves the current cursor position.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>editable</code></em> :</span></td>
<td>a <a href="GtkEditable.html" title="GtkEditable"><span class="type">GtkEditable</span></a> widget.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>the position of the cursor. The cursor is displayed
before the character with the given (base 0) index
in the widget. The value will be less than or
equal to the number of characters in the widget.
Note that this position is in characters, not in
bytes.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2964270"></a><h3>
<a name="gtk-editable-set-editable"></a>gtk_editable_set_editable ()</h3>
<a class="indexterm" name="id2964284"></a><pre class="programlisting">void gtk_editable_set_editable (<a href="GtkEditable.html" title="GtkEditable">GtkEditable</a> *editable,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> is_editable);</pre>
<p>
Determines if the user can edit the text in the editable
widget or not.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>editable</code></em> :</span></td>
<td>a <a href="GtkEditable.html" title="GtkEditable"><span class="type">GtkEditable</span></a> widget.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>is_editable</code></em> :</span></td>
<td>
<a
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> if the user is allowed to edit the text
in the widget.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2964370"></a><h3>
<a name="gtk-editable-get-editable"></a>gtk_editable_get_editable ()</h3>
<a class="indexterm" name="id2964384"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gtk_editable_get_editable (<a href="GtkEditable.html" title="GtkEditable">GtkEditable</a> *editable);</pre>
<p>
Retrieves whether <em class="parameter"><code>editable</code></em> is editable. See
<a href="GtkEditable.html#gtk-editable-set-editable"><code class="function">gtk_editable_set_editable()</code></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>editable</code></em> :</span></td>
<td> a <a href="GtkEditable.html" title="GtkEditable"><span class="type">GtkEditable</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> <a
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> if <em class="parameter"><code>editable</code></em> is editable.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2964486"></a><h2>Signal Details</h2>
<div class="refsect2" lang="en">
<a name="id2964496"></a><h3>
<a name="GtkEditable-changed"></a>The "changed" signal</h3>
<a class="indexterm" name="id2964506"></a><pre class="programlisting">void user_function (<a href="GtkEditable.html" title="GtkEditable">GtkEditable</a> *editable,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last</pre>
<p>
Indicates that the user has changed the contents
of the widget.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>editable</code></em> :</span></td>
<td>the object which received the signal.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2964576"></a><h3>
<a name="GtkEditable-delete-text"></a>The "delete-text" signal</h3>
<a class="indexterm" name="id2964586"></a><pre class="programlisting">void user_function (<a href="GtkEditable.html" title="GtkEditable">GtkEditable</a> *editable,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> start_pos,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> end_pos,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last</pre>
<p>
This signal is emitted when text is deleted from
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 <a href="gtk-Signals.html#gtk-signal-emit-stop"><code class="function">gtk_signal_emit_stop()</code></a>, it
is possible to modify the inserted text, or prevent
it from being inserted entirely. The <em class="parameter"><code>start_pos</code></em>
and <em class="parameter"><code>end_pos</code></em> parameters are interpreted as for
<a href="GtkEditable.html#gtk-editable-delete-text"><code class="function">gtk_editable_delete_text()</code></a>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>editable</code></em> :</span></td>
<td>the object which received the signal.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>start_pos</code></em> :</span></td>
<td>the starting position.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>end_pos</code></em> :</span></td>
<td>the end position.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2964737"></a><h3>
<a name="GtkEditable-insert-text"></a>The "insert-text" signal</h3>
<a class="indexterm" name="id2964748"></a><pre class="programlisting">void user_function (<a href="GtkEditable.html" title="GtkEditable">GtkEditable</a> *editable,
<a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *new_text,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> new_text_length,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *position,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last</pre>
<p>
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 <a href="gtk-Signals.html#gtk-signal-emit-stop"><code class="function">gtk_signal_emit_stop()</code></a>, it
is possible to modify the inserted text, or prevent
it from being inserted entirely.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>editable</code></em> :</span></td>
<td>the object which received the signal.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>new_text</code></em> :</span></td>
<td>the new text to insert.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>new_text_length</code></em> :</span></td>
<td>the length of the new text, in bytes,
or -1 if new_text is nul-terminated
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>position</code></em> :</span></td>
<td>the position, in characters, at which to insert
the new text. this is an in-out parameter.
After the signal emission is finished, it should
point after the newly inserted text.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</body>
</html>