1.55.4 Get methods

event <-area_position: relative_to=[graphical] -> point

Returns the location of the event relative to the area<-x and area<-y of the argument graphical.

Note that both event<-position and event<-area_position reuse the point object in the slot -position.

Defaults: The default graphical is the event<-receiver of the event.

See also

- event-position
- event<-position

event <-button: -> button_name

Returns the name of the button to which the event is associated. The predefined button-names are left, middle and right. Fails with a warning if the event was not associated to a button.

event <-click_displacement: -> pixels=int

Number of pixels the pointer has moved since the last down event. See also event<-click_time, event->is_up, event<-multiclick and class click_gesture.

event <-click_time: -> milliseconds=int

Returns the time in milliseconds of this event object since the last down event. See also event<-click_displacement, event<-multiclick, event->is_up and class click_gesture.

event <-convert: [any] -> event

Converts the constant @default into the var object @event. This conversion function allow us to omit specifying the event if this is the current event.

event <-display: -> display

Display object on which the event occurred. When using only a single display, this will be @display. Computed using graphical<-display on the associated event<-window.

event <-distance: to=event -> int

Rounded integer distance between events. Both events must be in the same event<-window.

event <-inside_sub_window: [display|frame|window] -> frame|window

This method may be used to relate an event to an XPCE window. Normally event<-window refers to the window in which the event occurred. If a window has the event focus however, event<-window returns the window that has the focus rather than the window where the pointer is.

get(Event, inside_sub_window, Frame)

will return the XPCE frame in which the event occurred.

get(Event, inside_sub_window, Frame, Window)

will return the window in which the event occurred, where Frame is the return value of the previous call. This call returns the actual window (not the window_decorator object) if the event occurred in a normal window. If the event occurred in a decoration (scroll_bar object, window-label) the window_decorator is returned.

This method is used by the Prolog defined class drag_and_drop_gesture to locate the target for the drop operation which may be in another window. See $PCEHOME/prolog/lib/pce_drag_and_drop.pl.

event <-key: -> name

Key(-binding) description of event. If the event is not a keyboard event, this is the same as event<-id. Otherwise it is a symbolic description of the depressed key. The key-description is described with key_binding->function.

event <-master: -> any

The master of an event is the master of its event<-receiver. See‘visual event<-master’for details.

event <-multiclick: -> {single,double,triple}

Detect multiclick. It yields one of the names single, double or triple. Multiclick detection is based on the time interval between this button-down event and the previous and the distance between these events.

Clicking is normally handled using a click_gesture object.

NOTE: When there are both recognisers for single- and double-click,

• both* will be executed on a double click! Defaults: A click is regarded as the next step in a multiclick sequence if it the down event is within 400 milliseconds of previous down event and within 4 pixels displaced.

  Bugs: These methods should read the corresponding X-resources.

  See also

  class click_gesture

event <-name: -> event_id

Synonym for event<-id. Backwards compatibility only.

event <-x: relative_to=[graphical|frame|display] -> int

event <-y: relative_to=[graphical|frame|display] -> int

event <-position: relative_to=[graphical|frame|display] -> point

Position of the event relative to the given object. The argument may be any graphical object, frame object or the display provided it is displayed on the same display object as where the event occurred.

For device objects (and windows), the returned position is relative to the origin (device<-offset) of the device. For other graphicals it is relative to the area<-x and area<-y of the graphical's area. For a display object it is relative to the top-left corner of the display. See also event<-area_position.

The returned value is also stored in the -position slot.

See also

- event-position
- event<-area_position
- point<-convert