Gtk.Calendar.Set_Detail_Func_User_Data

Entities

Generic formal parameters

Access Types

Subprograms

Description

Destroy

procedure Destroy (Data : in out User_Data_Type)
Parameters
Data

Gtk_Calendar_Detail_Func

type Gtk_Calendar_Detail_Func is access function
  (Calendar  : not null access Gtk.Calendar.Gtk_Calendar_Record'Class;
   Year      : Guint;
   Month     : Guint;
   Day       : Guint;
   User_Data : User_Data_Type) return UTF8_String;

This kind of functions provide Pango markup with detail information for the specified day. Examples for such details are holidays or appointments. The function returns null when no information is available. Since: gtk+ 2.14

Parameters
Calendar

a Gtk.Calendar.Gtk_Calendar.

Year

the year for which details are needed.

Month

the month for which details are needed.

Day

the day of Month for which details are needed.

User_Data

the data passed with Gtk.Calendar.Set_Detail_Func.

Return Value

Newly allocated string with Pango markup with details for the specified day or null.

Set_Detail_Func

procedure Set_Detail_Func
   (Calendar : not null access Gtk.Calendar.Gtk_Calendar_Record'Class;
    Func     : Gtk_Calendar_Detail_Func;
    Data     : User_Data_Type)

Installs a function which provides Pango markup with detail information for each day. Examples for such details are holidays or appointments. That information is shown below each day when Gtk.Calendar.Gtk_Calendar:show-details is set. A tooltip containing with full detail information is provided, if the entire text should not fit into the details area, or if Gtk.Calendar.Gtk_Calendar:show-details is not set. The size of the details area can be restricted by setting the Gtk.Calendar.Gtk_Calendar:detail-width-chars and Gtk.Calendar.Gtk_Calendar:detail-height-rows properties. Since: gtk+ 2.14

Parameters
Calendar
Func

a function providing details for each day.

Data

data to pass to Func invokations.

User_Data_Type

type User_Data_Type (<>) is private;