| Top | |
|
|
|
| CtkEntryBuffer * | ctk_entry_buffer_new () |
| const gchar * | ctk_entry_buffer_get_text () |
| void | ctk_entry_buffer_set_text () |
| gsize | ctk_entry_buffer_get_bytes () |
| guint | ctk_entry_buffer_get_length () |
| gint | ctk_entry_buffer_get_max_length () |
| void | ctk_entry_buffer_set_max_length () |
| guint | ctk_entry_buffer_insert_text () |
| guint | ctk_entry_buffer_delete_text () |
| void | ctk_entry_buffer_emit_deleted_text () |
| void | ctk_entry_buffer_emit_inserted_text () |
The CtkEntryBuffer class contains the actual text displayed in a CtkEntry widget.
A single CtkEntryBuffer object can be shared by multiple CtkEntry widgets which will then share the same text content, but not the cursor position, visibility attributes, icon etc.
CtkEntryBuffer may be derived from. Such a derived class might allow text to be stored in an alternate location, such as non-pageable memory, useful in the case of important passwords. Or a derived class could integrate with an application’s concept of undo/redo.
CtkEntryBuffer * ctk_entry_buffer_new (const gchar *initial_chars,gint n_initial_chars);
Create a new CtkEntryBuffer object.
Optionally, specify initial text to set in the buffer.
initial_chars |
initial buffer text, or |
[allow-none] |
n_initial_chars |
number of characters in |
Since: 2.18
const gchar *
ctk_entry_buffer_get_text (CtkEntryBuffer *buffer);
Retrieves the contents of the buffer.
The memory pointer returned by this call will not change unless this object emits a signal, or is finalized.
a pointer to the contents of the widget as a string. This string points to internally allocated storage in the buffer and must not be freed, modified or stored.
Since: 2.18
void ctk_entry_buffer_set_text (CtkEntryBuffer *buffer,const gchar *chars,gint n_chars);
Sets the text in the buffer.
This is roughly equivalent to calling ctk_entry_buffer_delete_text()
and ctk_entry_buffer_insert_text().
Note that n_chars
is in characters, not in bytes.
Since: 2.18
gsize
ctk_entry_buffer_get_bytes (CtkEntryBuffer *buffer);
Retrieves the length in bytes of the buffer.
See ctk_entry_buffer_get_length().
Since: 2.18
guint
ctk_entry_buffer_get_length (CtkEntryBuffer *buffer);
Retrieves the length in characters of the buffer.
Since: 2.18
gint
ctk_entry_buffer_get_max_length (CtkEntryBuffer *buffer);
Retrieves the maximum allowed length of the text in
buffer
. See ctk_entry_buffer_set_max_length().
Since: 2.18
void ctk_entry_buffer_set_max_length (CtkEntryBuffer *buffer,gint max_length);
Sets the maximum allowed length of the contents of the buffer. If the current contents are longer than the given length, then they will be truncated to fit.
buffer |
||
max_length |
the maximum length of the entry buffer, or 0 for no maximum. (other than the maximum length of entries.) The value passed in will be clamped to the range 0-65536. |
Since: 2.18
guint ctk_entry_buffer_insert_text (CtkEntryBuffer *buffer,guint position,const gchar *chars,gint n_chars);
Inserts n_chars
characters of chars
into the contents of the
buffer, at position position
.
If n_chars
is negative, then characters from chars will be inserted
until a null-terminator is found. If position
or n_chars
are out of
bounds, or the maximum buffer text length is exceeded, then they are
coerced to sane values.
Note that the position and length are in characters, not in bytes.
buffer |
||
position |
the position at which to insert text. |
|
chars |
the text to insert into the buffer. |
|
n_chars |
the length of the text in characters, or -1 |
Since: 2.18
guint ctk_entry_buffer_delete_text (CtkEntryBuffer *buffer,guint position,gint n_chars);
Deletes a sequence of characters from the buffer. n_chars
characters are
deleted starting at position
. If n_chars
is negative, then all characters
until the end of the text are deleted.
If position
or n_chars
are out of bounds, then they are coerced to sane
values.
Note that the positions are specified in characters, not bytes.
Since: 2.18
void ctk_entry_buffer_emit_deleted_text (CtkEntryBuffer *buffer,guint position,guint n_chars);
Used when subclassing CtkEntryBuffer
Since: 2.18
void ctk_entry_buffer_emit_inserted_text (CtkEntryBuffer *buffer,guint position,const gchar *chars,guint n_chars);
Used when subclassing CtkEntryBuffer
buffer |
||
position |
position at which text was inserted |
|
chars |
text that was inserted |
|
n_chars |
number of characters inserted |
Since: 2.18
“length” property “length” guint
The length (in characters) of the text in buffer.
Owner: CtkEntryBuffer
Flags: Read
Allowed values: <= 65535
Default value: 0
Since: 2.18
“max-length” property “max-length” int
The maximum length (in characters) of the text in the buffer.
Owner: CtkEntryBuffer
Flags: Read / Write
Allowed values: [0,65535]
Default value: 0
Since: 2.18
“deleted-text” signalvoid user_function (CtkEntryBuffer *buffer, guint position, guint n_chars, gpointer user_data)
This signal is emitted after text is deleted from the buffer.
buffer |
||
position |
the position the text was deleted at. |
|
n_chars |
The number of characters that were deleted. |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run First
Since: 2.18
“inserted-text” signalvoid user_function (CtkEntryBuffer *buffer, guint position, char *chars, guint n_chars, gpointer user_data)
This signal is emitted after text is inserted into the buffer.
buffer |
||
position |
the position the text was inserted at. |
|
chars |
The text that was inserted. |
|
n_chars |
The number of characters that were inserted. |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run First
Since: 2.18