hmCal_INSTALL CALLBACK
hmCal_INSTALL CALLBACK(area;methodname)
Parameter Type Description
area Longint -> hmCal area
methodname String -> callback-method
With the command hmCal_INSTALL CALLBACK you can set or change the callback-method. If you put an empty string as the parameter methodname, an existing callbach-method is deleting.
The callback-method is necessary if you want to react to certain events, which the user in the calendar causes.
All events have to be actived explicitly with hmCal_SET EVENT STATE.
Parameter Type Description
$1 Longint -> hmCal area
$2 Longint -> event
$3 Longint -> appointment-id
$4 Datum -> from-date
$5 Datum -> till-date
$6 Longint -> from-time in seconds
$7 Longint -> till-time in seconds
$8 Longint -> full-day
$9 Longint -> user-id
$0 Longint <- result
You must to be defined the method as indicated. You must always return a valid value in $0.
The event is called, if you call an command, which changes the visible time range by programming language. Also the manual command hmCal_UPDATE APPOINTMENTS releases this event. In $4 to $7 you get the time intervall. Now you can create appointments with the command hmCal_Add Appointment. All existing appointments are removed, so that you only create all appointments applicable on the time intervall.
The parameters full-day is always 0. You have to return 0 as result.
Notice: You can deactivate this mechanism with the command hmCal_SET AREA PROPERTY and the selector hmCal_prop_AutoUpdateApp.
The event is called, if the user moved an appointment in the calendar. The date data refer to the recent time. The parameter full-day indicates whether the date is or became a full-day-appointment. If the parameter full-day is 0, then the date is not a full-day-appointment. If the parameter full-day is 1, then the date is a full-day-appointment.
If you accept the movement of the appointment, then you return in result a 0. If you do not want to permit the movement of the appointment, then you return -1.
The event is called, if the user extended or shortened an appointment. The parameter specifications correspond to the event hmCal_DragAppointment.
The event is called, if the user creates a new appointment. This is possible in all views, except the monthly view. The parameter full-day indicates whether the date is a full-day-appointment. If the parameter full-day is 0, then the date is not a full-day-appointment. If the parameter full-day is 1, then the date is a full-day-appointment. In user views the parameter user-id returns your user-id, in which the appointment was created. In all other cases the parameter returns 0.
If you do not want to permit the creation of the appointment, you return -1 as the result. If you want to permit the creation of the appointment, then you must return your internal appointment-id as the result.
The event is called, if the user liked to delete an appointment by the erase key (del) or the backspace key. The parameters full-day and user-id are always 0. If you do not accept the deletion of the appointment, then you return -1, otherwise 0.
If you did not like that the user deletes an appointment, then you can use also the command hmCal_SET AREA PROPERTY with the selector hmCal_prop_DeleteKey. However, then the callback-event will not be executing.
The event is called, if you doubleclick on an appointment. The parameter full-day indicates whether the appointment is a full-day-appointment. The result should be always 0.
The event is called, if you click on an appointment. The parameter full-day indicates whether the date is a full-day-appointment. The result should be alwyays 0.
The event is called, if you the user doubleclicked in the calendar. In parameters $4 and $6 the date and time is returned, on which was doubleclicked. The parameter full-day indicates whether the user clicked in the full-day area of the calendar. The parameter user-id indicates in multi-user views, on which user was clicked. The result should be 0.
The event is called, if you the user clicked in the calendar. In parameters $4 and $6 the date and time is returned, on which was clicked. The parameter full-day indicates whether the user clicked in the full-day area of the calendar. The parameter user-id indicates in multi-user views, on which user was clicked. The result should be 0.
The event is called, if an element were droped into the calendar. The calendar-area must have the property dropable in the 4D design mode. In parameters $4 and $6 the date and time is returned, on which the element was released. The parameter full-day indicates whether the element was released within the full-day area of the calendar. The parameter user-id indicates in multi-user views, on which user the element was released. In the parameter appointment-id the reference of the appointment is returned, on which the element was droped.
With the help of the command hmCal_DRAG AND DROP PROPERTIES you can get further information about the source element.
The event is called before an user creates a new appointment in the calendar with drag and drop. hmCal asks you, if the creation of appointments in this context is allowed. If you deny the creation of an appointment, return -1 as result. Otherwise return 0. The event is only called if the creation of new appointments is allowed (see chapterhmCal_SET AREA PROPERTY selector hmCal_prop_AllowDragNew).
The event is called before an user drags an appointments in the calendar. If you deny the modification of an appointment, return -1 as result. Otherwise return 0.
The event is called before an user resizes an appointments in the calendar. If you deny the modification of an appointment, return -1 as result. Otherwise return 0.
The event is called if an error occurs. Here you can handle all erros. The error code is in the parameter $3.
The event is called if hmCal changes internally the rules for an recurrence appointment. Here you have the chance to get the rule properties and save them into your database.
The rule for the exdate list is changed, if the user changes the starttime of the main appointment or the user deletes any child appointments.
The event is called, if the user double clicks on a relation. The relation ID is in the parameter $3.
The event is called, if the user clicks on a relation. The relation ID is in the parameter $3.
The event is called, if the user tries to create a new relationwith drag & drop. You get the source appointment reference in the parameter $3 and the target appointment reference in the parameter $8.
The parameter $9 returns the relation type.
The result is your relation id. If you pass -1 as a result, the relation is not created.
The event is called, if the user tries to delete a relation with the delete-key.
If you want to deny the deletion of the relation, just pass -1 as a result. If you accept the deletion, just return 0.
If you generelly deny any deletion of relations, you can call the command hmCal_SET AREA PROPERTY with the selector hmCal_prop_DeleteKey. Then the event is not called any more.
The event is called, if the user clicks on the second appointment bar in the project view.
Here is an example of a second bar under the regular bar:
The event is called, if the user doubleclicks on the second appointment bar in the project view.
The event is called, if the user drags an object or area. The event is called multiple times while the object is dragging by the user. If the parameter $3 returns a 1, the size of the multi-day area hast changed.
The event is called, if an appointment was sorted by drag and drop. Sorting is only available in the project area. The event is called after the sort, if the mouse button was released. You get the dragged appointment in the parameter $3. You get the appointment id of the appointment, after where the dragged appointment was released in the parameter $9.
This event is called, if the user clicks in the "more"-icon in the month view. The icon appears, if there are too much appointments for a day. The parameter $4 returns the date where the user clicked.
This event is called, if the user double clicks in the "more"-icon in the month view. The icon appears, if there are too much appointments for a day. The parameter $4 returns the date where the user double clicked.
The event is called, if the user moved an appointment in the calendar and don't released the mouse button. The date data refer to the recent time. The parameter full-day indicates whether the date is or became a full-day-appointment. If the parameter full-day is 0, then the date is not a full-day-appointment. If the parameter full-day is 1, then the date is a full-day-appointment. Pass a non null value in $0 to indicate a not allowed-cursor to the user.
The event is called, if the user selects an edit menu item: Undo (1), Cut (2), Copy (3), Paste (4), Clear (5), Select all (6) and Redo (7). $3 returns the item number (see number behind).
If you return in $0 an other value as 0, hmCal does not executes standard actions.
These following standard actions are executed:
Clear: Same as the delete key: it deletes the current selected appointments. The event hmCal_DeleteAppointment is called for every appointment where you can deny the action for each appointment
Select all: Selects all appointments in the current view
The event is called, before the user drags a new appointment. Within this event you can set default properties (texts, colors, etc.) before the appointment is shown. This event is called after hmCal_TryNewAppointment. The appointment ID is a placeholder for the new appointment id, which will be set, if you accept the creation with hmCal_NewAppointment. By default the ID is -1, but can be changed with the area property hmCal_prop_NewAppointmentID. So this ID, is valid within this event only.
The event is called, before a tooltip for an appointment is shown. If you return in $0 not 0, the tooltip will not be shown.
The event is called, after the user scrolls with the scrollbar. The event is not fired while dragging the thumb, because of performance issues. In $3 you will get the scrollbar type:
- Type 1: vertical scrollbar
- Type 2: vertical scrollbar of the full day area
- Type 3: horizontal scrollbar
- Type 4: horizontal scrollbar of the column area
In $4-$7 you will get the current visible time range.
The event is called, after the user sorts a user row in the user multi day view. In the parameter $3 you will get the user reference which will be sorted. In $9 you will get the destination user reference (where the user released the mouse button).
If you return in $0 not 0, the sort action will be rejected.
The event is called at the beginning of the drag & drop action of the time-indicator. You will get the current time indicator in the parameter $3.
The event is called during the drag & drop action of the time-indicator. You will get the current time indicator in the parameter $3.
The event is called after the drag & drop action of the time-indicator. You will get the current time indicator in the parameter $3.
The event is called, if the user clicks on a column header. The parameter $3 returns the column ID.
The event is called, if the user double clicks on a column header. The parameter $3 returns the column ID.
C_LONGINT($0;$1;$2;$3;$6;$7;$8;$9;$vl_area;$vl_event;$vl_appointment;$vl_time1;$vl_time2;$vl_ganztag; $vl_user;$vl_return)
C_DATE($vd_date1;$vd_date2)
C_TIME($vu_time1;$vu_time2)
$vl_return:=0
$vl_area:=$1
$vl_event:=$2
$vl_appointment:=$3
$vd_date1:=$4
$vd_date2:=$5
$vl_time1:=$6
$vl_time2:=$7
$vl_ganztag:=$8
$vl_user:=$9
$vu_time1:=00:00:00+$vl_time1
$vu_time2:=00:00:00+$vl_time2
Case of
:($vl_event=hmCal_UpdateAppointments )
:($vl_event=hmCal_DragAppointment )
:($vl_event=hmCal_ResizeAppointment )
:($vl_event=hmCal_NewAppointment )
:($vl_event=hmCal_DeleteAppointment )
:($vl_event=hmCal_DoubleClickApp )
:($vl_event=hmCal_ClickAppointment )
End case
$0:=$vl_return