Details
struct GnomeIconTextItem
struct GnomeIconTextItem; |
All the fields in the GnomeIconTextItem
structure should be considered private. When the application
needs to know the size and bounds of an icon text item, it should
use the gnome_canvas_item_get_bounds()
function.
gnome_icon_text_item_configure ()
void gnome_icon_text_item_configure (GnomeIconTextItem *iti,
int x,
int y,
int width,
const char *fontname,
const char *text,
gboolean is_editable,
gboolean is_static); |
This routine is used to configure a &GnomeIconTextItem.
x and y specify the cordinates where the item is placed inside the canvas.
The x coordinate should be the leftmost position that the icon text item can
assume at any one time, that is, the left margin of the column in which the
icon is to be placed. The y coordinate specifies the top of the icon text
item.
width is the maximum width allowed for this icon text item. The coordinates
define the upper-left corner of an icon text item with maximum width; this may
actually be outside the bounding box of the item if the text is narrower than
the maximum width.
If is_static is true, it means that there is no need for the item to
allocate memory for the string (it is a guarantee that the text is allocated
by the caller and it will not be deallocated during the lifetime of this
item). This is an optimization to reduce memory usage for large icon sets.
gnome_icon_text_item_select ()
This function is used to control whether an icon text item is displayed as
selected or not. Mouse events are ignored by the item when it is unselected;
when the user clicks on a selected icon text item, it will start the text
editing process.
gnome_icon_text_item_get_text ()
gnome_icon_text_item_stop_editing ()
Terminates the editing state of an icon text item. The accept argument
controls whether the item's current text should be accepted or discarded. If
it is discarded, then the icon's original text will be restored.
Signals
The "text-changed" signal
This signal is emitted when the user has finished editing the text
in an icon text item. Typically this happens when the user
presses Enter. The application has to decide
whether the entered text is valid or not; for example, a file
manager may want to test whether it is legal to rename a file to
the proposed name or not.
Upon receiving this signal, the application should use
gnome_icon_text_item_get_text() to get the
text for validation. The return value of this signal indicates
whether the proposed text is accepted by the application. If the
proposed text is valid, then a signal handler should return
TRUE, otherwise it should return
FALSE. If the change is not accepted, the text
is automatically reset to its original state.
The "height-changed" signal
This signal is emitted when the height of an icon text item
changes, usually due to the user changing the text or the
application selecting a different font. Applications can change
their layout accordingly.
The "width-changed" signal
This signal is emitted when the width of an icon text item
changes, usually due to the user changing the text or the
application selecting a different font. Applications can change
their layout accordingly.
The "editing-started" signal
This signal is emitted when the user begins editing the text in an
icon text item, usually by clicking on it while it is selected.
Applications can use this information to disable drag and drop
signals and update their state accordingly.
The "editing-stopped" signal
This signal is emitted when the user terminates editing the text
in an icon text item, usually by pressing Enter
or Esc. Applications can use this information to
enable drag and drop signals and update their state accordingly.
The "selection-started" signal
This signal is emitted when the user begins a rubberband selection
of text with the mouse in an icon text item. Applications can use
this information to disable drag and drop signals and update their
state accordingly.
The "selection-stopped" signal
This signal is emitted when the user terminates a rubberband
selection of text with the mouse in an icon text item.
Applications can use this information to disable drag and drop
signals and update their state accordingly.