GnomeIconTextItem

GnomeIconTextItem

Functions

Signals

Types and Values

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkObject
            ╰── GnomeCanvasItem
                ╰── GnomeIconTextItem

Includes

#include <libgnomeui/libgnomeui.h>

Description

Functions

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);

gnome_icon_text_item_configure is deprecated and should not be used in newly-written code.

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.

Parameters

iti

An icon text item.

 

x

X position in which to place the item.

 

y

Y position in which to place the item.

 

width

Maximum width allowed for this item, to be used for word wrapping.

 

fontname

Ignored.

 

text

Text that is going to be displayed.

 

is_editable

Deprecated.

 

is_static

Whether text points to a static string or not.

 

gnome_icon_text_item_setxy ()

void
gnome_icon_text_item_setxy (GnomeIconTextItem *iti,
                            int x,
                            int y);

gnome_icon_text_item_setxy is deprecated and should not be used in newly-written code.

Sets the coordinates at which the icon text item should be placed.

See also: gnome_icon_text_item_configure().

Parameters

iti

An icon text item.

 

x

X position.

 

y

Y position.

 

gnome_icon_text_item_select ()

void
gnome_icon_text_item_select (GnomeIconTextItem *iti,
                             gboolean sel);

gnome_icon_text_item_select is deprecated and should not be used in newly-written code.

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.

Parameters

iti

An icon text item

 

sel

Whether the icon text item should be displayed as selected.

 

gnome_icon_text_item_focus ()

void
gnome_icon_text_item_focus (GnomeIconTextItem *iti,
                            gboolean focused);

gnome_icon_text_item_focus is deprecated and should not be used in newly-written code.

Sets or unsets the focus on the icon text item depending on focused .

Parameters

iti

An icon text item.

 

focused

whether to set or unset the icon text item focus.

 

gnome_icon_text_item_get_text ()

const char *
gnome_icon_text_item_get_text (GnomeIconTextItem *iti);

gnome_icon_text_item_get_text is deprecated and should not be used in newly-written code.

Returns the current text string in an icon text item. The client should not free this string, as it is internal to the icon text item.

Parameters

iti

An icon text item.

 

gnome_icon_text_item_start_editing ()

void
gnome_icon_text_item_start_editing (GnomeIconTextItem *iti);

gnome_icon_text_item_start_editing is deprecated and should not be used in newly-written code.

Starts the editing state of an icon text item.

Parameters

iti

An icon text item.

 

gnome_icon_text_item_stop_editing ()

void
gnome_icon_text_item_stop_editing (GnomeIconTextItem *iti,
                                   gboolean accept);

gnome_icon_text_item_stop_editing is deprecated and should not be used in newly-written code.

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.

Parameters

iti

An icon text item.

 

accept

Whether to accept the current text or to discard it.

 

gnome_icon_text_item_get_editable ()

GtkEditable *
gnome_icon_text_item_get_editable (GnomeIconTextItem *iti);

gnome_icon_text_item_get_editable is deprecated and should not be used in newly-written code.

Retrieves the entry widget associated with the icon text.

Parameters

iti

An icon text item.

 

Returns

a GtkEditable if the entry widget is initialised, NULL otherwise.

Types and Values

struct GnomeIconTextItem

struct GnomeIconTextItem;

GnomeIconTextItem is deprecated and should not be used in newly-written code.

Signal Details

The “editing-started” signal

void
user_function (GnomeIconTextItem *icontextitem,
               gpointer           user_data)

Flags: Run Last


The “editing-stopped” signal

void
user_function (GnomeIconTextItem *icontextitem,
               gpointer           user_data)

Flags: Run Last


The “height-changed” signal

void
user_function (GnomeIconTextItem *icontextitem,
               gpointer           user_data)

Flags: Run Last


The “selection-started” signal

void
user_function (GnomeIconTextItem *icontextitem,
               gpointer           user_data)

Flags: Run First


The “selection-stopped” signal

void
user_function (GnomeIconTextItem *icontextitem,
               gpointer           user_data)

Flags: Run First


The “text-changed” signal

gboolean
user_function (GnomeIconTextItem *icontextitem,
               gpointer           user_data)

Flags: Run Last


The “width-changed” signal

void
user_function (GnomeIconTextItem *icontextitem,
               gpointer           user_data)

Flags: Run Last