## SwamiguiBar SwamiguiBar — Canvas item for displaying multiple pointers or ranges. |

## Synopsis

                        SwamiguiBar;
    void                swamigui_bar_create_pointer         (SwamiguiBar *bar,
                                                             const char *id,
                                                             const char *first_property_name,
                                                             ...);
    void                swamigui_bar_add_pointer            (SwamiguiBar *bar,
                                                             SwamiguiBarPtr *barptr,
                                                             const char *id);
    GnomeCanvasItem *   swamigui_bar_get_pointer            (SwamiguiBar *bar,
                                                             const char *id);
    void                swamigui_bar_set_pointer_position   (SwamiguiBar *bar,
                                                             const char *id,
                                                             int position);
    void                swamigui_bar_set_pointer_range      (SwamiguiBar *bar,
                                                             const char *id,
                                                             int start,
                                                             int end);
    int                 swamigui_bar_get_pointer_order      (SwamiguiBar *bar,
                                                             const char *id);
    void                swamigui_bar_set_pointer_order      (SwamiguiBar *bar,
                                                             const char *id,
                                                             int pos);
    void                swamigui_bar_raise_pointer_to_top   (SwamiguiBar *bar,
                                                             const char *id);
    void                swamigui_bar_lower_pointer_to_bottom
                                                            (SwamiguiBar *bar,
                                                             const char *id);

## Object Hierarchy

      GObject
       +----GInitiallyUnowned
             +----GtkObject
                   +----GnomeCanvasItem
                         +----GnomeCanvasGroup
                               +----SwamiguiBar

## Properties

      "max-height"               gint                  : Read / Write
      "min-height"               gint                  : Read / Write

## Description

Horizontal bar canvas item for displaying multiple pointers and/or ranges. A SwamiguiBar is composed of one or more SwamiguiBarPtr items.

## Details

### SwamiguiBar

    typedef struct _SwamiguiBar SwamiguiBar;

### swamigui_bar_create_pointer ()

    void                swamigui_bar_create_pointer         (SwamiguiBar *bar,
                                                             const char *id,
                                                             const char *first_property_name,
                                                             ...);

Creates a new SwamiguiBarPtr, sets properties and adds it to a bar canvas item.

`bar` : | Bar canvas item
`id` : | String identifier to use for this pointer
`first_property_name` : | Name of first SwamiguiBarPtr property to assign to or `NULL` to not set any pointer properties.
`...` : | First value to assign to `first_property_name` followed by additional name/value pairs, terminated with a `NULL` name argument.

### swamigui_bar_add_pointer ()

    void                swamigui_bar_add_pointer            (SwamiguiBar *bar,
                                                             SwamiguiBarPtr *barptr,
                                                             const char *id);

Add an existing bar pointer to a bar canvas item.

`bar` : | Bar canvas item
`barptr` : | Existing bar pointer to add to bar canvas item.
`id` : | String identifier to use for this pointer

### swamigui_bar_get_pointer ()

    GnomeCanvasItem *   swamigui_bar_get_pointer            (SwamiguiBar *bar,
                                                             const char *id);

### swamigui_bar_set_pointer_position ()

    void                swamigui_bar_set_pointer_position   (SwamiguiBar *bar,
                                                             const char *id,
                                                             int position);

Set the position of a SwamiguiBarPtr item in a bar canvas item. Pointer is centered on the given `position` regardless of mode (position or range).

`bar` : | Bar canvas item
`id` : | String identifier of pointer to set position of
`position` : | Position in pixels to set pointer to

### swamigui_bar_set_pointer_range ()

    void                swamigui_bar_set_pointer_range      (SwamiguiBar *bar,
                                                             const char *id,
                                                             int start,
                                                             int end);

Set the range of a SwamiguiBarPtr item in a bar canvas item. Pointer is set to the range defined by `start` and `end`.

`bar` : | Bar canvas item
`id` : | String identifier of pointer to set position of
`start` : | Position in pixels of start of range
`end` : | Position in pixels of end of range

### swamigui_bar_get_pointer_order ()

    int                 swamigui_bar_get_pointer_order      (SwamiguiBar *bar,
                                                             const char *id);

Get the stacking order of a pointer.

`bar` : | Bar canvas item
`id` : | String identifier of pointer to get stacking order position of
Returns : | Stacking order of pointer (0 = top, -1 if pointer not found).

### swamigui_bar_set_pointer_order ()

    void                swamigui_bar_set_pointer_order      (SwamiguiBar *bar,
                                                             const char *id,
                                                             int pos);

Set the stacking order of a pointer to `pos`.

`bar` : | Bar canvas item
`id` : | String identifier of pointer to set stacking order position of
`pos` : | Absolute position in stacking order (0 = top, -1 = bottom)

### swamigui_bar_raise_pointer_to_top ()

    void                swamigui_bar_raise_pointer_to_top   (SwamiguiBar *bar,
                                                             const char *id);

Raise a pointer to the top of the stacking order.

`bar` : | Bar canvas item
`id` : | String identifier of pointer to raise to top of stacking order

### swamigui_bar_lower_pointer_to_bottom ()

    void                swamigui_bar_lower_pointer_to_bottom
                                                            (SwamiguiBar *bar,
                                                             const char *id);

Lower a pointer to the bottom of the stacking order.

`bar` : | Bar canvas item
`id` : | String identifier of pointer to lower to bottom of stacking order

## Property Details

### The `"max-height"` property

      "max-height"               gint                  : Read / Write

Maximum height of pointers.

Allowed values: >= 1

Default value: 48

### The `"min-height"` property

      "min-height"               gint                  : Read / Write

Minimum height of pointers.

Allowed values: >= 1

Default value: 16

## See Also

#SwamiguiBarPtr