com.livecode.widget

Typemodule
DictionaryLCB
LibraryLiveCode Builder
Associationscom.livecode.widget
Summary

This library consists of the operations on widgets provided by LiveCode Builder.

Description

This library consists of the operations on widgets provided by LiveCode Builder.

TypeNameSummarySyntax
expressionIsEditMode

Determines whether the IDE is in edit mode.

in edit mode

- - -IsPoppedUp

Tests if the current widget is in a popup window. Resturns:True if the current widget is in a popup window, False otherwise.

currently popped up

- - -MyBounds

Returns the bounds of the widget.

my bounds

- - -MyChildren

The currently placed child widgets of this widget.

my children

- - -MyDisabled

Returns the disabled state of the widget.

my disabled

- - -MyEnabled

Returns the enabled state of the widget.

my enabled

- - -MyFont

Returns the font of the widget.

my font

- - -MyHeight

Returns the height of the widget.

my height

- - -MyName

Returns the name of the widget's script object

my name

- - -MyNativeLayer

Get the current widget's native layer pointer

my native layer

- - -MyPaint

Returns a particular paint of the widget.

my ( foreground | background | highlight | border | top | bottom | shadow | focus ) paint

- - -MyPixelScale

Returns the scaling factor of pixels for the widget

my pixel scale

- - -MyRectangle

Returns the rectangle of the widget in the parent

my rectangle

- - -MyScriptObject

Returns the widget script object.

my script object

- - -MyWidth

Returns the width of the widget.

my width

- - -TheClickButton

Determines the mouse button which started the mouse click.

the ( current ) click button

- - -TheClickCount

Determines the number of successive clicks within the click distance.

the ( current ) click count

- - -TheClickLocation

Determines the location of a mouse click.

the ( current ) click position

- - -TheMouseLocation

Determines the location of the mouse pointer relative to the widget.

the ( current ) mouse position

- - -TheNumberOfTouches

The number of touches

the number of touches

- - -TheTarget

The child widget that started the current execution.

the target

- - -TheTouchId

The id of the current touch

the touch id

- - -TheTouchIDs

The touch IDs

the touch ids

- - -TheTouchLocation

The location of the current touch

the touch position

- - -ThisWidget

Returns the current widget.

this widget

messageOnActionKeyPress

Sent when an action key is pressed while the widget has focus.

OnActionKeyPress <keyText>

- - -OnAttach

Sent when the widget is attached.

OnAttach

- - -OnClick

Sent when the widget is clicked.

OnClick

- - -OnClose

Sent when card containing the widget is navigated away from.

OnClose

- - -OnCreate

Sent when the widget is created.

OnCreate

- - -OnDestroy

Sent when the widget is deleted.

OnDestroy

- - -OnDetach

Sent when the widget is detached.

OnDetach

- - -OnDoubleClick

Sent when the widget is double-clicked.

OnDoubleClick

- - -OnDragDrop

Sent when a dragged object is released within the widget rect.

OnDragDrop

- - -OnDragEnter

Sent when an object is dragged onto the widget rect.

OnDragEnter

- - -OnDragFinish

Sent when the widget finishes being dragged

OnDragFinish

- - -OnDragLeave

Sent when an object is dragged outside of the widget rect.

OnDragLeave

- - -OnDragMove

Sent when a dragged object is moved within the widget rect.

OnDragMove

- - -OnDragStart

Sent when the widget begins to be dragged

OnDragStart

- - -OnFocusEnter

Sent when the widget gains focus.

OnFocusEnter

- - -OnFocusLeave

Sent when the widget loses focus.

OnFocusLeave

- - -OnGeometryChanged

Sent when the widget geometry changed.

OnGeometryChanged

- - -OnKeyPress

Sent when a key is pressed while the widget has focus.

OnKeyPress <keyText>

- - -OnLayerChanged

Sent when the widget layer is changed.

OnLayerChanged

- - -OnLoad

Sent when the widget is loaded.

OnLoad

- - -OnModifiersChanged

Sent when the keyboard modifiers are changed.

OnModifiersChanged

- - -OnMouseCancel

Sent when something happens which should cause the previous mouse down action to be considered cancelled. For example, opening a popup during OnMouseDown.

OnMouseCancel

- - -OnMouseCancelHover

Sent when the mouse pointer continues to hover outside of the widget's rect.

OnMouseCancelHover

- - -OnMouseDown

Sent when the mouse button is pushed within the widget's rect.

OnMouseDown

- - -OnMouseEnter

Sent when the mouse pointer enters the widget's rect.

OnMouseEnter

- - -OnMouseHover

Sent when the mouse pointer hovers over the widget's rect.

OnMouseHover

- - -OnMouseLeave

Sent when the mouse pointer leaves the widget's rect.

OnMouseLeave

- - -OnMouseMove

Sent when the mouse pointer moves within the widget's rect.

OnMouseMove

- - -OnMouseScroll

Sent when the mouse wheel is scrolled within the widget's rect.

OnMouseScroll

- - -OnMouseStillHover

Sent when the mouse pointer continues to hover over the widget's rect.

OnMouseStillHover

- - -OnMouseUp

Sent when the user releases the mouse button.

OnMouseUp

- - -OnOpen

Sent when the card containing the widget becomes the current card.

OnOpen

- - -OnPaint

Sent when the widget is to be drawn.

OnPaint

- - -OnParentPropertyChanged

Sent when a property of the widget parent is changed.

OnParentPropertyChanged

- - -OnSave

Sent when the widget is saved.

OnSave

- - -OnStartEditing

Sent when the pointer tool is selected.

OnStartEditing

- - -OnStopEditing

Sent when the browse tool is selected.

OnStopEditing

- - -OnTimer

Sent when a timer message has been scheduled.

OnTimer

- - -OnTouchCancel

Sent to the target for touch events when a touch event is cancelled.

OnTouchCancel

- - -OnTouchFinish

Sent to the target for touch events when a touch event ends.

OnTouchFinish

- - -OnTouchMove

Sent to the target for touch events when a touch moves.

OnTouchMove

- - -OnTouchStart

Sent when the widget is the target for touch events and a touch is started.

OnTouchStart

- - -OnVisibilityChanged

Sent when the widget visibility changed.

OnVisibilityChanged <isVisible>

modulecom.livecode.widget

This library consists of the operations on widgets provided by LiveCode Builder.

OnVisibilityChanged <isVisible>

operatorANewWidget

Create a widget object of the specified kind

a new widget <mKind>

- - -AnnotationOfWidget

Manipulates an annotation of a child widget

annotation <mName> of <mWidget>

- - -IsPointNotWithinRect

Determines whether a point is within a rectangle.

<Point> is not within <Rect>

- - -IsPointWithinRect

Determines whether a point is within a rectangle.

<Point> is within <Rect>

- - -NativeLayerOfWidget

Get a widget's native layer pointer

native layer of <Widget>

- - -PropertyOfWidget

Manipulates a property implemented by a child widget.

property <mName> of <mWidget>

- - -TheLocationOfTouch

The location of a specific touch

the position of touch <Id>

- - -WidgetDisabledProperty

Manipulates the disabled property of a child widget

the disabled of <mWidget>

- - -WidgetEnabledProperty

Manipulates the enabled property of a child widget

the enabled of <mWidget>

- - -WidgetFontProperty

The font of a widget

the font of <Widget>

- - -WidgetHeightProperty

Manipulates the height property of a child widget

the height of <mWidget>

- - -WidgetLocationProperty

Manipulates the location property of a child widget

the location of <mWidget>

- - -WidgetRectangleProperty

Manipulates the rectangle property of a child widget

the rectangle of <mWidget>

- - -WidgetWidthProperty

Manipulates the height property of a child widget

the width of <mWidget>

statementCancelTimer

Cancels a timer.

cancel timer

- - -ClosePopupWithResult

Closes the current widget popup.

close popup [ returning <Result> ]

- - -PlaceWidget

Add a child widget to the parent.

place <mWidget>

- - -PlaceWidgetAt

Add a child widget to the parent on the top or bottom layer

place <mWidget> at ( bottom | top )

- - -PlaceWidgetRelative

Add a child widget to the parent on a layer relative to that of a previously placed child.

place <mWidget> ( below | above ) <mOtherWidget>

- - -PopupMenu

Displays a popup menu. Menu:An expression that evaluates to a string, which describes the menu items. Location:An expression that evaluates to a Point relative to the current widget. The topleft corner of the popup window will be placed here.

popup menu <mMenu> at <mAt>

- - -PopupWidget

Opens a widget within a popup window.

popup widget <Kind> at <Location> [ with properties <Properties> ]

- - -RedrawAll

Redraws the widget.

redraw all

- - -ScheduleTimerIn

Schedules a timer.

schedule timer in <Time> seconds

- - -TriggerAll

Causes all of a widget's property triggers to be fired.

trigger all [ in <mWidget> ]

- - -UnplaceWidget

Remove a child widget from the parent.

unplace <mWidget>