## Documentation

Table of Contents
Class Inheritance Tree
Widget Screenshots
Package groups

## Index

Package: Ruler

- Goto spec source

# Description

    package Gtk.Ruler is

This widget is generally put on the sides of a drawing area to help the user measure distances. It indicates the current position of the mouse cursor within the drawing area, and can be graduated in multiple units.

### Screenshot

<testgtk>create_rulers.adb</testgtk>

# Packages

### Implements_Buildable (new Glib.Types.Implements)

    package Implements_Buildable is new Glib.Types.Implements
         (Gtk.Buildable.Gtk_Buildable, Gtk_Ruler_Record, Gtk_Ruler);

### Implements_Orientable (new Glib.Types.Implements)

    package Implements_Orientable is new Glib.Types.Implements
         (Gtk.Orientable.Gtk_Orientable, Gtk_Ruler_Record, Gtk_Ruler);

# Classes

### Gtk_Ruler_Record

- Goto declaration in source

    type Gtk_Ruler_Record is new Gtk_Widget_Record with null record;

#### Ancestors:

Gtk.Widget.Gtk_Widget_Record
Glib.Object.GObject_Record

#### Immediate Children:

Gtk.Ruler.Gtk_Hruler_Record
Gtk.Ruler.Gtk_Vruler_Record

#### Primitive operations:

Draw_Pos

- To API doc
- To spec

Draw_Ticks

- To API doc
- To spec

Get_Metric

- To API doc
- To spec

Get_Orientation

- To API doc
- To spec

Get_Range

- 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.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)
Set_Metric

- To API doc
- To spec

Set_Orientation

- To API doc
- To spec

Set_Range

- To API doc
- To spec

# Types

### Gtk_Ruler

- Goto declaration in source

    type Gtk_Ruler is access all Gtk_Ruler_Record'Class;

### Gtk_Vruler_Record

- Goto declaration in source

    subtype Gtk_Vruler_Record is Gtk_Ruler_Record;

### Gtk_Vruler

- Goto declaration in source

    subtype Gtk_Vruler is Gtk_Ruler;

### Gtk_Hruler_Record

- Goto declaration in source

    subtype Gtk_Hruler_Record is Gtk_Ruler_Record;

### Gtk_Hruler

- Goto declaration in source

    subtype Gtk_Hruler is Gtk_Ruler;

# Constants & Global variables

### Lower_Property

- Goto declaration in source

(Glib.Properties.Property_Double)

    Lower_Property : constant Glib.Properties.Property_Double;

### Max_Size_Property

- Goto declaration in source

(Glib.Properties.Property_Double)

    Max_Size_Property : constant Glib.Properties.Property_Double;

### Metric_Property

- Goto declaration in source

(Gtk.Enums.Property_Metric_Type)

    Metric_Property : constant Gtk.Enums.Property_Metric_Type;

### Position_Property

- Goto declaration in source

(Glib.Properties.Property_Double)

    Position_Property : constant Glib.Properties.Property_Double;

### Upper_Property

- Goto declaration in source

(Glib.Properties.Property_Double)

    Upper_Property : constant Glib.Properties.Property_Double;

# Subprograms & Entries

### Get_Type

- Goto spec in source
- Goto body in source

    function Get_Type return Glib.GType;

### Gtk_New_Vruler

- Goto spec in source

    procedure Gtk_New_Vruler (Ruler: out Gtk_Vruler);

### Initialize_Vruler

- Goto spec in source

    procedure Initialize_Vruler (Ruler: access Gtk_Vruler_Record'Class);

Creates a new vertical ruler unmaintained and too specialized. There is no replacement.

### Vruler_Get_Type

- Goto spec in source
- Goto body in source

    function Vruler_Get_Type return Glib.GType;

### Gtk_New_Hruler

- Goto spec in source

    procedure Gtk_New_Hruler (Ruler: out Gtk_Hruler);

### Initialize_Hruler

- Goto spec in source

    procedure Initialize_Hruler (Ruler: access Gtk_Hruler_Record'Class);

### Hruler_Get_Type

- Goto spec in source
- Goto body in source

    function Hruler_Get_Type return Glib.GType;

### Draw_Pos

- Goto spec in source

    procedure Draw_Pos (Ruler: access Gtk_Ruler_Record);

### Draw_Ticks

- Goto spec in source

    procedure Draw_Ticks (Ruler: access Gtk_Ruler_Record);

### Get_Metric

- Goto spec in source

    function Get_Metric (Ruler: access Gtk_Ruler_Record) return Gtk.Enums.Gtk_Metric_Type;

### Set_Metric

- Goto spec in source

    procedure Set_Metric (Ruler: access Gtk_Ruler_Record;Metric: Gtk.Enums.Gtk_Metric_Type);

Set or get the units used for a Gtk_Ruler. See Set_Metric

### Get_Range

- Goto spec in source

    procedure Get_Range (Ruler: access Gtk_Ruler_Record;Lower: out Gdouble;Upper: out Gdouble;Position: out Gdouble;Max_Size: out Gdouble);

### Set_Range

- Goto spec in source

    procedure Set_Range (Ruler: access Gtk_Ruler_Record;Lower: Gdouble;Upper: Gdouble;Position: Gdouble;Max_Size: Gdouble);

This sets the range of the ruler. unmaintained and too specialized. There is no replacement. "lower": the lower limit of the ruler "upper": the upper limit of the ruler "position": the mark on the ruler "max_size": the maximum size of the ruler used when calculating the space to leave for the text

### Get_Orientation

- Goto spec in source

    function Get_Orientation (Self: access Gtk_Ruler_Record) return Gtk.Enums.Gtk_Orientation;

### Set_Orientation

- Goto spec in source

    procedure Set_Orientation (Self: access Gtk_Ruler_Record;Orientation: Gtk.Enums.Gtk_Orientation);

### +

- Goto spec in source

    function "+" (Widget: access Gtk_Ruler_Record'Class) return Gtk.Buildable.Gtk_Buildable renames Implements_Buildable.To_Interface;

### -

- Goto spec in source

    function "-" (Interf: Gtk.Buildable.Gtk_Buildable) return Gtk_Ruler renames Implements_Buildable.To_Object;

### +

- Goto spec in source

    function "+" (Widget: access Gtk_Ruler_Record'Class) return Gtk.Orientable.Gtk_Orientable renames Implements_Orientable.To_Interface;

### -

- Goto spec in source

    function "-" (Interf: Gtk.Orientable.Gtk_Orientable) return Gtk_Ruler renames Implements_Orientable.To_Object;