PM Notebook events
aboutToChangePages
The aboutToChangePages event signals that the notebook is about to change pages.
aboutToCloseWidget
The aboutToCloseWidget event signals that the part is about to be closed.
If you need to perform any actions just before the window closes, connect the aboutToCloseWidget event of the Window part to an action in your part.
aboutToMapWidget
The aboutToMapWidget event signals that the part is about to be shown on the screen. If you need to take any actions or set any visual attributes on the part before it is shown, connect to this event. If you hide and show the part rather than closing and opening it (typically for performance reasons), you can use this event to refresh the part data before it appears.
aboutToOpenWidget
The aboutToOpenWidget event signals that the part is about to be opened. This event is signaled just before the part is displayed on the screen.
If you need to perform any actions just before the window opens, connect the aboutToOpenWidget event of the Window part to an action in your part.
aboutToUnmapWidget
The aboutToUnmapWidget event signals that the part is about to be hidden.
backgroundColor
The backgroundColor event signals the part that the background color has changed.
backPagePosition
The backPagePosition event indicates the corner of the notebook where all of the back pages (thin parallel lines) meet, has changed. The possible values are as follows:
XmTOPLEFT
Top left corner
XmTOPRIGHT
Top right corner
XmBOTTOMLEFT
Bottom left corner
XmBOTTOMRIGHT
Bottom right corner
bindingType
The bindingType event indicates that the type of bonding, either spiral or solid, for the notebook part has changed. The possible values are:
XmSPIRAL
Spiral binding
XmSOLID
Solid binding (default)
borderWidth
The borderWidth event signals the part that the width of the border, specified in pixels, has changed.
closedWidget
The closedWidget event signals that the part has been closed.
configuredWidget
The configuredWidget event signals that the part has been moved or resized.
currentPage
The currentPage event indicates that the current page of the notebook part has changed.
currentPageIndex
The currentPageIndex event indicates that the index of the current page of the notebook part has changed.
destroyedPart
The destroyedPart event signals that the part and its children have been destroyed. Any system resources associated with the destroyed parts have been released.
enabled
The enabled event signals that the part is available for selection.
fontName
The fontName event signals the part which font to use for the text displayed in the part.
foregroundColor
The foregroundColor event signals the part the name of the RGB color, to use, for the foreground of the part.
framingSpec
The framingSpec event signals the part that the edge specifications for the part have changed. The edge specifications determine the width, height, and position of the part.
helpFile
A helpFile event indicates that a signal is sent to the part that the help file associated with the part has changed
helpKeysId
A helpKeysId event indicates that the ID of the keys, help has associated with the part, has changed. The ID can be a string or an integer value.
helpRequested
The helpRequested event signals that help has been requested. You can connect the helpRequested event to an action that displays your own help, such as a message box. If the action you connect this event to does not return nil, default help processing occurs, using the specified help file and help topic.
helpTitle
A helpTitle event signals the part that the title of the help window associated with that part has changed
helpTopicId
The helpTopicId event signals a change in the ID of the help topic associated with the part. The ID can be a string or an integer.
hoverHelpEnabled
A hoverHelpEnabled event signals the part to provide hover help for the part and all of its children.
hoverHelpRemoved
The hoverHelpRemoved event indicates that hover help has been removed from the part or one of its children. You can use this event to signal when to remove hover help information in an information area. This event is only signaled if the part has hoverHelpEnabled set to true.
Note:
When the event is signaled, the UI process may be blocked. Therefore, do not send any messages that get processed by the UI process, such as Transcript show.
This event passes a parameter, whose class is AbtEwIconHoverHelpCallbackData. The parameter has the following attributes for specifying settings for the hover help:
hoverArea (AbtBasicView)
Specifies the hover area that contains the item under the mouse pointer
isHoverHelpShown (Boolean)
Specifies whether or not the hover help is shown
item (AbtBasicView)
Specifies the item under the mouse pointer
labelString (String)
Specifies the hover help string to display, if any. If the item under the pointer is a graphic push button, the default hover help string is the item's labelString attribute. Otherwise, the default value is nil. A value of nil causes no hover help to be displayed.
pointerLocation (Point)
Specifies the location of the mouse pointer relative to the screen.
Note:
For Window parts, this event is signalled even if showHoverHelp of hoverHelpDescriptor is set to false, so that the event can still be used to signal when to remove hover help information from an information area.
hoverHelpRequested
The hoverHelpRequested event indicates that hover help is about to be displayed over the part or one of its children. You can use this event to signal when to display hover help information in an information area. This event is only signaled if the part has hoverHelpEnabled set to true.
Note:
When the event is signaled, the UI process may be blocked. Therefore, do not send any messages that get processed by the UI process, such as Transcript show.
This event passes a parameter, whose class is AbtEwIconHoverHelpCallbackData. The parameter has the following attributes for specifying settings for the hover help:
hoverArea (AbtBasicView)
Specifies the hover area that contains the item under the mouse pointer
isHoverHelpShown (Boolean)
Specifies whether or not the hover help is shown
item (AbtBasicView)
Specifies the item under the mouse pointer
labelString (String)
Specifies the hover help string to display, if any. If the item under the pointer is a graphic push button, the default hover help string is the item's labelString attribute. Otherwise, the default value is nil. A value of nil causes no hover help to be displayed.
pointerLocation (Point)
Specifies the location of the mouse pointer relative to the screen.
Note:
For Window parts, this event is signalled even if showHoverHelp of hoverHelpDescriptor is set to false, so that the event can still be used to signal when to remove hover help information from an information area.
majorTabHeight
A majorTabHeight event indicates a change in the height of the major tab of the notebook part.
majorTabWidth
A majorTabWidth event indicates a change in the width of the major tab of the notebook part.
mappedWhenManaged
The mappedWhenManaged event signals the part to be visible if the mappedWhenManaged attribute has been set to true.
mappedWidget
The mappedWidget event signals that the part has been shown on the screen.
minorTabHeight
A minorTabHeight event indicates a change in the height of the minor tab of the notebook part.
minorTabWidth
A minorTabWidth event indicates a change in the width of the minor tab of the notebook part.
openedWidget
The openedWidget event signals that the part has been opened and displayed on the screen.
popUpMenuRequest
The popUpMenuRequest event signals that the pop-up menu for the part has been requested.
If the menu attribute is connected to a Menu part, that menu part is displayed unless you change the menu attribute as a result of this event. You can change the menu attribute to include your own menu or leave it unchanged to use the original setting.
orientation
An orientation event signals a change in which side the binding appears and which side the major tabs appear. Valid values include the following:
•XmHORIZONTAL
•XmVERTICAL
pageButtonHeight
An pageButtonHeight event indicates a change in the height of the notebook's page button in pixels. A value of zero means that there are not button or page labels visible. The default value is 20.
pageButtonWidth
A pageButtonWidth event indicates a change in the width of the notebook's page button in pixels. A value of zero means that only the page buttons are not visible. The default value is 20.
self
A self event indicates that the value of the target part itself has changed.
tabGroup
A tabGroup event signals the part that it is included as a tab stop and can be accessed via the Tab or Backtab keys
traversalOn
The traversalOn property specifies whether users can access the part using the cursor movement keys. If the part is specified as a tab stop by using the tabGroup property, users also can use the Tab and Backtab keys to access the part.
unmappedWidget
The unmappedWidget event signals that the part is about to be hidden.