## Documentation

Table of Contents
Class Inheritance Tree
Widget Screenshots
Package groups

## Index

Package: Progress_Bar

- Goto spec source

# Description

    package Gtk.Progress_Bar is

The progress bar provides a convenient way of displaying a state of completion for typically lengthy tasks.

Binding from C File version 2.8.17

<testgtk>create_progress.adb</testgtk>

### Screenshot

# Classes

### Gtk_Progress_Bar_Record

- Goto declaration in source
- Goto full declaration in source

    type Gtk_Progress_Bar_Record is new
         Gtk.Progress.Gtk_Progress_Record with private;

#### Ancestors:

Gtk.Progress.Gtk_Progress_Record
Gtk.Widget.Gtk_Widget_Record
Glib.Object.GObject_Record

#### Primitive operations:

Get_Ellipsize

- To API doc
- To spec

Get_Fraction

- To API doc
- To spec

Get_Orientation

- To API doc
- To spec

Get_Pulse_Step

- To API doc
- To spec

Get_Text

- To API doc
- To spec

Glib.Object.Deallocate

- To API doc
- To spec

(Inherited)
Glib.Object.Get_Type

- To API doc
- To spec

(Inherited)
Glib.Object.Notify

- To API doc
- To spec

(Inherited)
Glib.Object.Ref

- To API doc
- To spec

(Inherited)
Glib.Object.Ref_Sink

- To API doc
- To spec

(Inherited)
Glib.Object.Unref

- To API doc
- To spec

(Inherited)
Gtk.Progress.Configure

- To API doc
- To spec

(Inherited)
Gtk.Progress.Get_Activity_Mode

- To API doc
- To spec

(Inherited)
Gtk.Progress.Get_Adjustment

- To API doc
- To spec

(Inherited)
Gtk.Progress.Get_Current_Percentage

- To API doc
- To spec

(Inherited)
Gtk.Progress.Get_Current_Text

- To API doc
- To spec

(Inherited)
Gtk.Progress.Get_Percentage_From_Value

- To API doc
- To spec

(Inherited)
Gtk.Progress.Get_Text_From_Value

- To API doc
- To spec

(Inherited)
Gtk.Progress.Get_Value

- To API doc
- To spec

(Inherited)
Gtk.Progress.Set_Activity_Mode

- To API doc
- To spec

(Inherited)
Gtk.Progress.Set_Adjustment

- To API doc
- To spec

(Inherited)
Gtk.Progress.Set_Format_String

- To API doc
- To spec

(Inherited)
Gtk.Progress.Set_Percentage

- To API doc
- To spec

(Inherited)
Gtk.Progress.Set_Show_Text

- To API doc
- To spec

(Inherited)
Gtk.Progress.Set_Text_Alignment

- To API doc
- To spec

(Inherited)
Gtk.Progress.Set_Value

- To API doc
- To spec

(Inherited)
Gtk.Widget.Activate

- To API doc
- To spec

(Inherited)
Gtk.Widget.Add_Accelerator

- To API doc
- To spec

(Inherited)
Gtk.Widget.Add_Events

- To API doc
- To spec

(Inherited)
Gtk.Widget.Add_Mnemonic_Label

- To API doc
- To spec

(Inherited)
Gtk.Widget.Can_Activate_Accel

- To API doc
- To spec

(Inherited)
Gtk.Widget.Child_Notify

- To API doc
- To spec

(Inherited)
Gtk.Widget.Class_Path

- To API doc
- To spec

(Inherited)
Gtk.Widget.Class_Path_Reversed

- To API doc
- To spec

(Inherited)
Gtk.Widget.Create_Pango_Context

- To API doc
- To spec

(Inherited)
Gtk.Widget.Create_Pango_Layout

- To API doc
- To spec

(Inherited)
Gtk.Widget.Destroy

- To API doc
- To spec

(Inherited)
Gtk.Widget.Draw

- To API doc
- To spec

(Inherited)
Gtk.Widget.Ensure_Style

- To API doc
- To spec

(Inherited)
Gtk.Widget.Error_Bell

- To API doc
- To spec

(Inherited)
Gtk.Widget.Flag_Is_Set

- To API doc
- To spec

(Inherited)
Gtk.Widget.Flags

- To API doc
- To spec

(Inherited)
Gtk.Widget.Freeze_Child_Notify

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_Allocation_Height

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_Allocation_Width

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_Allocation_X

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_Allocation_Y

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_Ancestor

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_Child_Requisition

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_Child_Visible

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_Colormap

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_Composite_Name

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_Direction

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_Events

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_Extension_Events

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_Has_Tooltip

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_Name

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_No_Show_All

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_Pango_Context

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_Parent

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_Parent_Window

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_Pointer

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_Root_Window

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_Size_Request

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_Snapshot

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_State

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_Style

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_Tooltip_Markup

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_Tooltip_Text

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_Tooltip_Window

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_Toplevel

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_Visual

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_Window

- To API doc
- To spec

(Inherited)
Gtk.Widget.Grab_Default

- To API doc
- To spec

(Inherited)
Gtk.Widget.Grab_Focus

- To API doc
- To spec

(Inherited)
Gtk.Widget.Has_Screen

- To API doc
- To spec

(Inherited)
Gtk.Widget.Hide

- To API doc
- To spec

(Inherited)
Gtk.Widget.Hide_All

- To API doc
- To spec

(Inherited)
Gtk.Widget.Input_Shape_Combine_Mask

- To API doc
- To spec

(Inherited)
Gtk.Widget.Intersect

- To API doc
- To spec

(Inherited)
Gtk.Widget.Is_Ancestor

- To API doc
- To spec

(Inherited)
Gtk.Widget.Is_Composited

- To API doc
- To spec

(Inherited)
Gtk.Widget.Is_Focus

- To API doc
- To spec

(Inherited)
Gtk.Widget.Keynav_Failed

- To API doc
- To spec

(Inherited)
Gtk.Widget.List_Mnemonic_Labels

- To API doc
- To spec

(Inherited)
Gtk.Widget.Map

- To API doc
- To spec

(Inherited)
Gtk.Widget.Mnemonic_Activate

- To API doc
- To spec

(Inherited)
Gtk.Widget.Modify_Base

- To API doc
- To spec

(Inherited)
Gtk.Widget.Modify_Bg

- To API doc
- To spec

(Inherited)
Gtk.Widget.Modify_Cursor

- To API doc
- To spec

(Inherited)
Gtk.Widget.Modify_Fg

- To API doc
- To spec

(Inherited)
Gtk.Widget.Modify_Font

- To API doc
- To spec

(Inherited)
Gtk.Widget.Modify_Text

- To API doc
- To spec

(Inherited)
Gtk.Widget.Path

- To API doc
- To spec

(Inherited)
Gtk.Widget.Path_Reversed

- To API doc
- To spec

(Inherited)
Gtk.Widget.Queue_Clear

- To API doc
- To spec

(Inherited)
Gtk.Widget.Queue_Clear_Area

- To API doc
- To spec

(Inherited)
Gtk.Widget.Queue_Draw

- To API doc
- To spec

(Inherited)
Gtk.Widget.Queue_Draw_Area

- To API doc
- To spec

(Inherited)
Gtk.Widget.Queue_Resize

- To API doc
- To spec

(Inherited)
Gtk.Widget.Queue_Resize_No_Redraw

- To API doc
- To spec

(Inherited)
Gtk.Widget.Realize

- To API doc
- To spec

(Inherited)
Gtk.Widget.Region_Intersect

- To API doc
- To spec

(Inherited)
Gtk.Widget.Remove_Accelerator

- To API doc
- To spec

(Inherited)
Gtk.Widget.Remove_Mnemonic_Label

- To API doc
- To spec

(Inherited)
Gtk.Widget.Render_Icon

- To API doc
- To spec

(Inherited)
Gtk.Widget.Reparent

- To API doc
- To spec

(Inherited)
Gtk.Widget.Reset_Rc_Styles

- To API doc
- To spec

(Inherited)
Gtk.Widget.Reset_Shapes

- To API doc
- To spec

(Inherited)
Gtk.Widget.Restore_Default_Style

- To API doc
- To spec

(Inherited)
Gtk.Widget.Send_Expose

- To API doc
- To spec

(Inherited)
Gtk.Widget.Set_Accel_Path

- To API doc
- To spec

(Inherited)
Gtk.Widget.Set_App_Paintable

- To API doc
- To spec

(Inherited)
Gtk.Widget.Set_Child_Visible

- To API doc
- To spec

(Inherited)
Gtk.Widget.Set_Colormap

- To API doc
- To spec

(Inherited)
Gtk.Widget.Set_Composite_Name

- To API doc
- To spec

(Inherited)
Gtk.Widget.Set_Direction

- To API doc
- To spec

(Inherited)
Gtk.Widget.Set_Double_Buffered

- To API doc
- To spec

(Inherited)
Gtk.Widget.Set_Events

- To API doc
- To spec

(Inherited)
Gtk.Widget.Set_Extension_Events

- To API doc
- To spec

(Inherited)
Gtk.Widget.Set_Flags

- To API doc
- To spec

(Inherited)
Gtk.Widget.Set_Has_Tooltip

- To API doc
- To spec

(Inherited)
Gtk.Widget.Set_Name

- To API doc
- To spec

(Inherited)
Gtk.Widget.Set_No_Show_All

- To API doc
- To spec

(Inherited)
Gtk.Widget.Set_Parent

- To API doc
- To spec

(Inherited)
Gtk.Widget.Set_Parent_Window

- To API doc
- To spec

(Inherited)
Gtk.Widget.Set_Redraw_On_Allocate

- To API doc
- To spec

(Inherited)
Gtk.Widget.Set_Scroll_Adjustments

- To API doc
- To spec

(Inherited)
Gtk.Widget.Set_Sensitive

- To API doc
- To spec

(Inherited)
Gtk.Widget.Set_Size_Request

- To API doc
- To spec

(Inherited)
Gtk.Widget.Set_State

- To API doc
- To spec

(Inherited)
Gtk.Widget.Set_Style

- To API doc
- To spec

(Inherited)
Gtk.Widget.Set_Tooltip_Markup

- To API doc
- To spec

(Inherited)
Gtk.Widget.Set_Tooltip_Text

- To API doc
- To spec

(Inherited)
Gtk.Widget.Set_Tooltip_Window

- To API doc
- To spec

(Inherited)
Gtk.Widget.Set_UPosition

- To API doc
- To spec

(Inherited)
Gtk.Widget.Set_USize

- To API doc
- To spec

(Inherited)
Gtk.Widget.Set_Window

- To API doc
- To spec

(Inherited)
Gtk.Widget.Shape_Combine_Mask

- To API doc
- To spec

(Inherited)
Gtk.Widget.Show

- To API doc
- To spec

(Inherited)
Gtk.Widget.Show_All

- To API doc
- To spec

(Inherited)
Gtk.Widget.Show_Now

- To API doc
- To spec

(Inherited)
Gtk.Widget.Size_Allocate

- To API doc
- To spec

(Inherited)
Gtk.Widget.Size_Request

- To API doc
- To spec

(Inherited)
Gtk.Widget.Style_Get_Property

- To API doc
- To spec

(Inherited)
Gtk.Widget.Thaw_Child_Notify

- To API doc
- To spec

(Inherited)
Gtk.Widget.Trigger_Tooltip_Query

- To API doc
- To spec

(Inherited)
Gtk.Widget.Unmap

- To API doc
- To spec

(Inherited)
Gtk.Widget.Unrealize

- To API doc
- To spec

(Inherited)
Gtk.Widget.Unset_Flags

- To API doc
- To spec

(Inherited)
Pulse

- To API doc
- To spec

Set_Ellipsize

- To API doc
- To spec

Set_Fraction

- To API doc
- To spec

Set_Orientation

- To API doc
- To spec

Set_Pulse_Step

- To API doc
- To spec

Set_Text

- To API doc
- To spec

Gtk.Progress is obsolete

# Types

### Gtk_Progress_Bar_Orientation

- Goto declaration in source

    type Gtk_Progress_Bar_Orientation is
         (Progress_Left_To_Right,
          Progress_Right_To_Left,
          Progress_Bottom_To_Top,
          Progress_Top_To_Bottom);

### Gtk_Progress_Bar

- Goto declaration in source

    type Gtk_Progress_Bar is access all Gtk_Progress_Bar_Record'Class;

# Constants & Global variables

### Orientation_Property

- Goto declaration in source

(Gtk.Enums.Property_Gtk_Orientation)

    Orientation_Property     : constant Gtk.Enums.Property_Gtk_Orientation;

### Discrete_Blocks_Property

- Goto declaration in source

(Glib.Properties.Property_Uint)

    Discrete_Blocks_Property : constant Glib.Properties.Property_Uint;

### Fraction_Property

- Goto declaration in source

(Glib.Properties.Property_Double)

    Fraction_Property        : constant Glib.Properties.Property_Double;

### Pulse_Step_Property

- Goto declaration in source

(Glib.Properties.Property_Double)

    Pulse_Step_Property      : constant Glib.Properties.Property_Double;

### Text_Property

- Goto declaration in source

(Glib.Properties.Property_String)

    Text_Property            : constant Glib.Properties.Property_String;

# Subprograms & Entries

### Gtk_New

- Goto spec in source

    procedure Gtk_New (Progress_Bar: out Gtk_Progress_Bar);

### Initialize

- Goto spec in source

    procedure Initialize (Progress_Bar: access Gtk_Progress_Bar_Record'Class);

Creates or initializes a new progress bar.

### Get_Type

- Goto spec in source
- Goto body in source

    function Get_Type return Gtk.Gtk_Type;

Return the internal value associated with a Gtk_Progress_Bar.

### Pulse

- Goto spec in source

    procedure Pulse (Progress_Bar: access Gtk_Progress_Bar_Record);

Indicate that some progress is made, but you don't know how much. Causes the progress bar to enter "activity mode," where a block bounces back and forth. Each call to Pulse causes the block to move by a little bit (the amount of movement per pulse is determined by Set_Pulse_Step).

### Set_Text

- Goto spec in source

    procedure Set_Text (Progress_Bar: access Gtk_Progress_Bar_Record;Text: UTF8_String);

### Get_Text

- Goto spec in source

    function Get_Text (Progress_Bar: access Gtk_Progress_Bar_Record) return UTF8_String;

Causes the given Text to appear superimposed on the progress bar. Text: a UTF-8 string.

### Set_Fraction

- Goto spec in source

    procedure Set_Fraction (Progress_Bar: access Gtk_Progress_Bar_Record;Fraction: Gdouble);

### Get_Fraction

- Goto spec in source

    function Get_Fraction (Progress_Bar: access Gtk_Progress_Bar_Record) return Gdouble;

Cause the progress bar to "fill in" the given fraction of the bar. The fraction should be between 0.0 and 1.0, inclusive.

### Set_Pulse_Step

- Goto spec in source

    procedure Set_Pulse_Step (Progress_Bar: access Gtk_Progress_Bar_Record;Step: Gdouble);

### Get_Pulse_Step

- Goto spec in source

    function Get_Pulse_Step (Progress_Bar: access Gtk_Progress_Bar_Record) return Gdouble;

Set the fraction of total progress bar length to move the bouncing block for each call to Pulse.

### Set_Orientation

- Goto spec in source

    procedure Set_Orientation (Progress_Bar: access Gtk_Progress_Bar_Record;Orientation: Gtk_Progress_Bar_Orientation);

### Get_Orientation

- Goto spec in source

    function Get_Orientation (Progress_Bar: access Gtk_Progress_Bar_Record) return Gtk_Progress_Bar_Orientation;

Cause the progress bar to switch to a different orientation (left-to-right, right-to-left, top-to-bottom, or bottom-to-top).

### Set_Ellipsize

- Goto spec in source

    procedure Set_Ellipsize (Pbar: access Gtk_Progress_Bar_Record;Mode: Pango.Layout.Pango_Ellipsize_Mode);

### Get_Ellipsize

- Goto spec in source

    function Get_Ellipsize (Pbar: access Gtk_Progress_Bar_Record) return Pango.Layout.Pango_Ellipsize_Mode;

Sets the mode used to ellipsize (add an ellipsis: "...") the text if there is not enough space to render the entire string.