1.65.3 Send methods

gesture ->cancel: event

Cancel this gesture and try the next one. This method implements the necessary event-focus consequences. It is currently used by class click_gesture. See click_gesture->cancel and click_gesture<-max_drag_distance.

It performs the following steps:

• Set recogniser->active: @off
• Set window->focus of the associated window
• Resent the original down event to the window
• Resent the current (drag) event to the window
• Set recogniser->active: @on

gesture ->drag: event

This method is send by gesture->event if the gesture<-status attribute is active and the event is a drag event (i.e. the mouse is moved with one of the buttons held down).

gesture->drag just succeeds. Intended to be redefined by gesture's subclasses.

See also

gesture->event

gesture ->event: event

Accepts the following events:

• ms_{left,middle,right}_down If the position of shift-, control- and meta-keys match the gesture<->modifier, the button matches gesture<->button, the gesture<->condition message is @nil or executed successfully and gesture->verify succeeds, the gesture will perform the following steps:

1. invoke gesture->initiate: Event on itself to initiate
2. set gesture<-status to active
3. invoke window->focus to grab the event-focus

• ms_{left,middle,right}_drag If gesture<-status equals active, invokes gesture->drag: event to itself
• ms_{left,middle,right}_up If gesture<-status equals active and the button matches the gesture<->button of the gesture, invoke gesture->terminate on itself and set gesture<->status to inactive.

  Fails when recogniser<->active equals @off.

  See also

  - gesture->drag
  - gesture->initiate
  - gesture->terminate
  - gesture->verify
  - gesture-status

gesture ->initialise: button=[button_name], modifier=[modifier]

Create a gesture. The arguments are the name of the button to react upon and a modifier object to specify the shift-, control- and meta-keys. When these arguments are omitted, they are read from their related class-variables.

Specification through class_variable/4 is advised as this allows the user to set his/her own preferences and it will give all similar gestures consistent user-interface.

Creating instances of this class is no common use. Note however that a recogniser for a specific application may be created by creating an instance of class recogniser and attaching the necessary gesture->initiate, gesture->verify, gesture->drag and/or gesture->terminate methods to it using object->send_method.

See also

- gesture.modifier
- gesture.button

gesture ->initiate: event

Invoked by gesture->event on a button-down event when all conditions are verified. This method should perform necessary initialisation for the gesture.

gesture->initiate just succeeds. Intended to be redefined by gesture's subclasses.

See also

- gesture->event
- gesture->verify

gesture ->terminate: event

Invoked by gesture->event when the matching button-up event that terminates the gesture action occurs.

gesture->terminate just succeeds. Intended to be redefined by gesture's subclasses.

See also

gesture->event

gesture ->verify: event

Invoked by gesture->event on the button-down event after the button, modifier and condition have been verified. This method may do additional verification. It is supposed to succeed or fail without side-effects. Side-effects necessary during initiation of the gesture should be defined at gesture->initiate.

gesture->verify just succeeds. Intended to be redefined by gesture's subclasses.

See also

- gesture->event
- gesture->initiate