Tweak

Path

Actions

Menu

Session

Player Events

---

Event Icons

The following icons are used in the class browser to show which methods are triggered by events. Most of these icons should be replaced with nicer looking ones. If you are interested, the icons need to be 11x11 px in 8bit depth. Yes they need to be that small. If you have a nice set of icons, please email them to the tweak mailing list.

• - change event
• - structure related event
• - mouse related event
• - keyboard related event
• - collection/list related event
• - button related event
• - window related event
• - text related event
• - ticking event
• - generic event (all others)

For completeness, the following icons are used in Tweak browsers in addition to the event icons (so if you want to make your own set, keep these in mind, too):

• - method overrides implementation in superclass
• - method is overridden in subclass
• - method is both, implemented in super- as well as in subclass
• - method has some problem which should be fixed ASAP.
• - method has been flagged using "self flag: #foo".

By the way, the overrides will not be shown if there is either a trigger, a warning of a flag defined for a method - the other markers take precedence and there is not enough space to more than one.

---

Mouse Events

Generic mouse events:

• mouseDown: Signaled when the mouse is pressed inside a player.
• mouseEnter: Signaled when the mouse enters a player.
• mouseMove: Signaled when the mouse moves inside a player.
• mouseStillDown: Repeatedly signaled while the mouse is pressed inside a player.
• mouseLeave: Signaled when the mouse leaves a player.
• mouseUp: Signaled when the mouse goes up inside a player.

Synthesized events:

• mouseClick: Signaled to distinguish between single click, double click and mouse drag, this event denotes that a single click occured.
• mouseDoubleClick: Signaled to distinguish between single click, double click and mouse drag, this event denotes that a double click occured.
• mouseDrag: Signaled to distinguish between single click, double click and mouse drag, this event denotes that a drag occured.

Drag and Drop:

• dragEnter: Signaled when a hand holding an object in a drag and drop transaction enters a player.
• dragMove: Signaled when a hand holding an object in a drag and drop transaction moves inside a player.
• dragLeave: Signaled when a hand holding an object in a drag and drop transaction leaves a player.
• dragDrop: Signaled when an object in a drag and drop transaction was dropped on a player.
• dropAccept: Signaled by the receiver of a dragDrop event to indicate that the drop operation completed successfully.
• dropReject: Signaled by the receiver of a dragDrop event to indicate the the drop operation should be aborted. By default, this will put the dropped object back to its former position.

Specialty mouse events:

• redButtonDown: Signaled specifically when the red (left) button is pressed.
• redButtonMove: Signaled specifically when the mouse moves while the red (left) button is pressed.
• redButtonUp: Signaled specifically when the red (left) button is released.
• yellowButtonDown: Signaled specifically when the yellow button is pressed.
• yellowButtonMove: Signaled specifically when the mouse moves while the yellow button is pressed.
• yellowButtonUp: Signaled specifically when the yellow button is released.
• blueButtonDown: Signaled specifically when the blue button is pressed.
• blueButtonMove: Signaled specifically when the mouse moves while the blue button is pressed.
• blueButtonUp: Signaled specifically when the blue button is released.

Other:

• buttonFocusLost: Signaled when the mouse focus gets transferred while a mouse button is being pressed. The name comes directly from the effect observable in buttons which may have to know that they are no longer the mouse focus when they are currently active (and tracking the mouse).

---

Keyboard Events

• keyboardFocusEnter: Signaled when a player aquires the keyboard focus.
• keyboardFocusLeave: Signaled when a player looses the keyboard focus.
• keyDown: Signaled when a key was pressed.
• keyStroke: Signaled when a character has been input.
• keyUp: Signaled when a key is released.

---

Aspect Events

Aspect events are events generated when one of the player's aspects changes. Typically, the aspect will not specify what exactly has changed but broadcast a generic "this aspect has changed" message.

• flagsChanged: Signaled when any of the following properties changes:
  - clipping, floating, infinite, locked, sticky, userDraw, visible.
• fillChanged: Signaled whenever any of the fill properties changes:
  - color, fillAlpha, fillAngle, fillColor, fillColors, fillOffset, fillStyle.
• geometryChanged: Signaled whenever any of the geometry properties changes:
  - angle, scale, aspectRatio, position, extent, bounds, heading, ...
• borderChanged: Signaled whenever any of the border properties changes:
  - borderColor, borderWidth, borderStyle.
• textChanged: Signaled whenever any of the text properties changes:
  - textAnchorPoint, textAttributes, textBorderColor, textBorderWidth, textColor, textEmphasis, textFont, textInset, textOffset, textWrap.
• graphicChanged: Signaled whenever any of the graphic properties changes:
  - graphicAnchorPoint, graphicFit, graphicForm, graphicOffset.

---

Text Events

• textChanged: Signaled whenever any of the text properties changes.
• textModified: Signaled whenever the text is modified, be that by adding or removing text, changing the formatting or other means that affect the text contents.
• textSelectionChanged: Signaled whenever the text's selection has changed.

---

Layout Events

• layoutChanged: Signaled when the receiver's layout needs to be recomputed [FIXME: This name is horrible]
• containerLayoutChanged: Signaled when the receiver's container has changed its layout.

---

Structure Events

• open: Signaled when an object appears on the screen (regardless whether it is visible or not).
• close Signaled when an object disappears from the screen (regardless whether it is visible or not).
• structureChanged: Signaled when the object's structure has changed, e.g., when there have been elements added or removed.

---

Geometry Events

• geometryChanged: Signaled when any of the receiver's geometry properties change. This includes the angle, scale, aspectRatio, position, extent, bounds, heading, and other derived properties (origin, center, bottomLeft...)
• extentChanged: Signaled when a player's extent changes. Note that when this happens, both geometryChanged as well as extentChanged are being signaled. extentChanged is provided for convenience, so that client code can for example, cache the contents of a player and recompute the cached contents when that player's extent changes (as opposed to a change in the position which would not affect the cache but still be signaled via #geometryChanged)
• frameChanged: Signaled, when any of the containers of an object changed its position, scale, or angle (the name originates from the object's frame of reference being changed). This event is mostly useful if one needs to track an embedded player's global position or size.

---

Other Events

• dropFiles: Signaled when a set of files are dropped from the OS on some player.
• scriptStatusChanged: Signaled when a script's status has changed (started, stopped, paused, resumed). The event has one argument, the name of the script.
• invalidate: Signaled when a player needs to be redrawn, either full or partially. The event is signaled at most once between redraws (redrawing a player resets the flag so clients can simply react to the event). The event is intended for objects which have the need to view other objects and must be informed if any part of the vieweee needs to be redrawn.

---

Widget Events

This is a set of widget-specific events which are likely to be important enough for you to list them explicitly here:

CTextEditor Events:

• save: Signaled when a text editor is about to accept the entered text. If this event is handled by a client, the client is responsible for accepting the text properly.
• textModified: Signaled whenever the text is modified, be that by adding or removing text, changing the formatting or other means that affect the text contents.
• textSelectionChanged: Signaled whenever the text's selection has changed.

CButton Events:

• fire: Signaled when a button should execute its associated action. All buttons must handle the fire event appropriately.

CWindow Events:

• closeRequest: Signaled when a window should be closed. If this event is handled it is the handler's responsibility to ultimately close the window by calling #close.
• expandRequest: Signaled when a window should be maximized. If this event is handled it is the handler's responsibility to ultimately maximize the window.
• collapseRequest: Signaled when a window should be minimized. If this event is handled it is the handler's responsibility to ultimately minimize the window.
• activate: Signaled when a window has become the active window.
• passivate: Signaled when a window is no longer the active window.

CCollection and CList Events:

• cursorChanged: Signaled when the cursor (e.g., the selection) in a list has changed.
• changed: Signaled when an item in the collection was added to, moved inside, or removed from the collection/list. The arguments of the event provide the type (#insert, #remove, or #replace), the firstIndex and the lastIndex of the changed elements. Check out the Cookbook for an example of how to handle those.

---

Changes from 3.6

If you are using Tweak versions prior to 3.8 (either from Jasmine or the TCAR release) be aware that the following event names have changed:

• opened, closed: Deprecated. Use open and close instead.
• click: No longer supported. Use mouseClick instead.
• doubleClick: No longer supported. Use mouseDoubleClick instead.
• dragStart: No longer supported. Use mouseDrag instead.
• dropped: No longer supported. Use dropAccept instead.

---