home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
OS/2 Shareware BBS: 10 Tools
/
10-Tools.zip
/
VSCPPv4.zip
/
VACPP
/
IBMCPP
/
HELP
/
CPPVBREF.INF
(
.txt
)
< prev
next >
Wrap
OS/2 Help File
|
1995-06-02
|
2MB
|
31,845 lines
ΓòÉΓòÉΓòÉ 1. About this Reference ΓòÉΓòÉΓòÉ
Topics:
Welcome!
Notices
Trademarks
How to Use the Contents
How to Obtain Additional Information
How to Use Action Bar Choices
How to Cut and Paste Examples
Other Information You Might Find Helpful
Communicating Your Comments to IBM
Who Should Use This Reference
How to Use This Reference
How to Use Part Information
What Parts Are Here?
ΓòÉΓòÉΓòÉ 1.1. Welcome! ΓòÉΓòÉΓòÉ
Welcome to the Visual Builder Parts Reference. This reference provides
information about parts and classes you can use to build applications. It
describes parts you can work with on the free-form surface in the Composition
Editor.
Before you begin to use this information, it would be helpful to understand how
to navigate through it. You can use the Table of Contents and Index facility to
locate topics and the Search facility to search the text of this document. You
can use hypertext links to acquire related information on the current topic.
Hypertext links appear in a different color (which you can customize using the
OS/2 Scheme Palette). For example, here is a link to another panel:
Communicating Your Comments to IBM. By double-clicking on the text of the link
or by pressing Enter on a highlighted link, you will open a panel of related
information. When you open a panel, the first link has the focus; to shift the
focus to other links, use the Tab key.
You should also understand:
How to Use the Contents
How to Obtain Additional Information
How to Use Action Bar Choices
How to Cut and Paste Examples
You can navigate forward and backward through primary topics by using the
Forward and Back buttons. Chapter group introductions and chapters are primary
topics in this reference. To go to the primary topic after the current one,
click on the Forward button (or select it and press Enter). To go to the
primary topic before the current one, do the following:
If the current primary topic is presented in a split window, first select
the menu pane.
Click on the Back button (or select it and press Enter).
You can return to the window you previously viewed by using the Previous
button or the Escape key.
ΓòÉΓòÉΓòÉ 1.2. Notices ΓòÉΓòÉΓòÉ
Any reference to an IBM licensed program is not intended to state or imply that
only IBM's licensed program may be used. Any functionally equivalent product,
program, or service that does not infringe any of IBM's intellectual property
rights can be used instead of the IBM product, program, or service. Evaluation
and verification of operation in conjunction with other products, programs, or
services, except those expressly designated by IBM, is the user's
responsibility.
IBM might have patents or pending patent applications covering subject matter
in this document. The furnishing of this document does not give you any license
to these patents. You can send license inquiries, in writing, to:
IBM Director of Licensing
IBM Corporation
500 Columbus Avenue
Thornwood, NY 10594 USA
This publication contains examples of data and reports used in daily business
operations. To illustrate them as completely as possible, the examples include
the names of individuals, companies, brands, and products. All of these names
are fictitious and any similarity to the names and addresses used by an actual
business enterprise is entirely coincidental.
ΓòÉΓòÉΓòÉ 1.3. Trademarks ΓòÉΓòÉΓòÉ
The following terms are trademarks or service marks of the IBM Corporation in
the United States or other countries:
BookManager
Common User Access
CUA
IBM
IBMLink
Library Reader
Open Class
OS/2
Presentation Manager
PROFS
VisualAge
Workplace Shell
The following terms are trademarks of other companies:
C++ American Telephone & Telegraph Company
ΓòÉΓòÉΓòÉ 1.4. Who Should Use This Reference ΓòÉΓòÉΓòÉ
Programmers who want to develop C++ applications using Visual Builder should
read this reference. It is written primarily for the programmer building
applications from Visual Builder parts using the Composition Editor.
ΓòÉΓòÉΓòÉ 1.5. How to Use This Reference ΓòÉΓòÉΓòÉ
Use this reference to find detailed information about Visual Builder parts.
Visual Builder concepts
If you are not familiar with parts, features, and connections, read Basic
Concepts.
Part chapters
Part chapters are organized alphabetically in two sections:
Visual and Nonvisual Parts All visual and nonvisual parts and any class
interface parts on the parts palette.
Class Interface Parts All class interface parts except those on the parts
palette.
If you want to use a part you are not familiar with, read the part description
first. Then, read the part building guidelines to learn how to use the part in
your own composite part.
You can review the topics on attributes, actions, and events for information
on part features. Part feature tables contain information about
implementation, such as data types, parameter lists, and event information.
These tables contain all attributes, actions, or events of the part, including
those inherited from other parts. Locally defined feature names are emphasized
for identification.
You can find settings information in the topics for part settings pages.
See How to Use Part Information for details on the information available in a
part chapter.
Class information
If you need more information on the class that supports a part or on a class
member that implements a feature, you can use hypertext links to the IBM Open
Class Library Reference.
Highlighting conventions
Key terms are emphasized as follows:
When a conceptual term is introduced and defined, it appears in italics.
User interface elements appear in bold type.
Part features (attributes, actions, and events) appear in italics.
Code segments appear in a Courier font.
ΓòÉΓòÉΓòÉ 1.6. How to Use Part Information ΓòÉΓòÉΓòÉ
Part chapters cover the following topics:
Part Description
Building Guidelines
Personal Notes
Attributes
Actions
Events
Settings
Some of these topics do not apply to all parts. Most parts have attributes and
actions, but some do not have events. Class interface parts do not support
notification and, therefore, have no events. Generally, class interface parts
do not have settings defined. Part building guidelines are provided for fully
enabled parts and for class interface parts on the parts palette, but they are
not provided for other class interface parts.
ΓòÉΓòÉΓòÉ <hidden> Part Description ΓòÉΓòÉΓòÉ
The part description topic provides model, graphic, and text descriptions of
the part.
Model description
The following part model information is provided:
Title The part title appears in the status area of the
Composition Editor when the part is selected on the parts
palette.
Class name Identifies the class supporting the part. The class name
provides a link to the class description in the IBM Open
Class Library Reference.
Base part Identifies the parent part.
Part type Identifies the part as a class interface, nonvisual, or
visual part.
Part file Identifies the data file containing the part definition.
You load this data file into the Composition Editor to use
the part.
Graphic description
For fully enabled parts and for class interface parts on the parts palette, a
graphic representation of the part as it appears on the free-form surface is
included.
Text description
The text description of the part covers the following points:
What the part is
What the user can do with the part
What to use the part for in your applications
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines ΓòÉΓòÉΓòÉ
The building guidelines give you information about using Visual Builder part
settings and features for some common tasks related to building composite
parts. The guidelines describe the use of many attributes, actions, events, and
settings in support of these tasks.
These guidelines are intended to be representative rather than comprehensive.
They focus on common building tasks particularly applicable to each part. You
can generally perform many tasks when building with a Visual Builder part that
are not described for the part. For example, enabling and disabling actions are
common to controls in general but are described only for buttons, check boxes,
and menu items.
ΓòÉΓòÉΓòÉ <hidden> Personal Notes ΓòÉΓòÉΓòÉ
You can add personal documentation notes for Visual Builder parts. Use the
personal notes icon at the bottom of the part menu to open a file for the part.
ΓòÉΓòÉΓòÉ <hidden> Attributes ΓòÉΓòÉΓòÉ
The attributes section contains a table of all attributes of the part. The
table includes attributes inherited by the part from its parent hierarchy. The
attributes are listed in alphabetical order.
The Attribute column gives the name of each attribute. The attribute name is
also the name of the get member function for the attribute. The get member
function retrieves the attribute value. The names of attributes defined in this
part are emphasized as follows: localAttribute.
A hypertext link on the attribute name provides access to the get member
function description in the IBM Open Class Library Reference.
The S column indicates whether the attribute can be set. If the attribute can
be set, a Γûá appears in the S column. This means that you can add a connection
in the Composition Editor to set the value. A set member function assigns the
attribute value.
A hypertext link on the Γûá provides access to the set member function
description in the IBM Open Class Library Reference.
The E column indicates whether the attribute supports connections that provide
the new attribute value when the value changes. If the attribute supports these
connections, a Γûá appears in the E column. This means that you can add a
connection in the Composition Editor to get the new value when the value
changes. When the attribute value changes, an attribute-change event is sent. A
notification ID identifies the attribute-change event.
A hypertext link on the Γûá provides access to the notification ID description in
the IBM Open Class Library Reference.
The Data type column gives the data type of each attribute.
Visual Builder provides attribute implementation information, including member
function signatures, in the Composition Editor. To view this information, open
the part contextual menu by clicking mouse button 2 on the part. Then, select
the Browse Part Features choice on the menu.
ΓòÉΓòÉΓòÉ <hidden> Actions ΓòÉΓòÉΓòÉ
The actions section contains a table of all actions of the part. The table
includes actions inherited by the part from its parent hierarchy. The actions
are listed in alphabetical order.
The Action column gives the name of each action. The action name is also the
name of the action member function. The action member function performs the
action. The names of actions defined in this part are emphasized as follows:
localAction.
A hypertext link on the action name provides access to the action member
function description in the IBM Open Class Library Reference.
The Parameters column shows parameters for the action. The parameter list shows
the type of each parameter. If the action has no parameters, "None" appears in
the Parameters column.
Visual Builder provides action implementation information, including member
function signatures, in the Composition Editor. To view this information, open
the part contextual menu by clicking mouse button 2 on the part. Then, select
the Browse Part Features choice on the menu.
ΓòÉΓòÉΓòÉ <hidden> Events ΓòÉΓòÉΓòÉ
The events section contains a table of all events of the part. The table
includes events inherited by the part from its parent hierarchy. The events are
listed in alphabetical order.
The Event column gives the name of each event. The names of events defined in
this part are emphasized as follows: localEvent.
The Notification ID column shows the notification ID that identifies the event.
Notification IDs provided by the class appear in mixed case. Notification IDs
implemented by Visual Builder appear in upper case.
For notification IDs provided by the class, a hypertext link provides access to
the notification ID description in the IBM Open Class Library Reference.
Visual Builder provides event implementation information, including any
parameters, in the Composition Editor. To view this information, open the part
contextual menu by clicking mouse button 2 on the part. Then, select the Browse
Part Features choice on the menu.
ΓòÉΓòÉΓòÉ <hidden> Settings ΓòÉΓòÉΓòÉ
Part settings information describes the settings on each of the following
settings pages defined for the part:
General
Control
Styles
Handlers
Color
Size/Position
Font
Settings pages are presented in their order of appearance in the settings
notebook.
Some parts have only a single part settings page, named as the part type.
These settings pages are not described.
The settings for each settings page are presented in the order of their
appearance on the page. Each setting is briefly described and its default
value, if any, is indicated.
ΓòÉΓòÉΓòÉ 1.7. What Parts Are Here? ΓòÉΓòÉΓòÉ
This reference covers parts from the following part data files:
vbbase.vbb
vbmm.vbb
This reference does not discuss abstract parts unless they are implemented by
Visual Builder and presented on the parts palette. A few concrete parts used
by Visual Builder are also omitted. You should not use these parts:
IFlyText
IMenuBar
INotebook::PageSettings
IPopUpMenu
IStandardNotifier
ISubmenu
IVBMinSize
IVBTitle
A few parts are provided as handlers that you can specify on the Handlers
settings page of various parts. You should not use these handler parts in any
other way:
IVBCheckMenuHandler
IVBDragDropHandler
IVBMinSizeViewPortHandler
IVBPopupMenuHandler
ΓòÉΓòÉΓòÉ 1.8. How to Use the Contents ΓòÉΓòÉΓòÉ
When the Contents window first appears, some topics have a plus (+) sign beside
them. The plus sign indicates that additional topics are available.
To expand the Contents if you are using a mouse, click on the plus sign. If
you are using the keyboard, use the Up or Down arrow key to highlight the
topic, and press the plus (+) key. For example, How to Use the Contents has a
plus sign beside it. To see additional topics for that heading, click on the
plus sign or highlight that topic and press the plus (+) key.
To view a topic, double-click on the topic (or press the Up or Down arrow key
to highlight the topic, and then press the Enter key).
ΓòÉΓòÉΓòÉ 1.9. How to Obtain Additional Information ΓòÉΓòÉΓòÉ
After you select a topic, the information for that topic appears in a window.
Highlighted words or phrases indicate that additional information is available.
Certain words and phrases are highlighted in a different color from the
surrounding text. These are called hypertext terms.
If you are using a mouse, double-click on the highlighted word. If you are
using a keyboard, press the Tab key to move to the highlighted word, and then
press the Enter key. Additional information then appears in a window.
ΓòÉΓòÉΓòÉ 1.10. How to Use Action Bar Choices ΓòÉΓòÉΓòÉ
Several choices are available for managing the information presented in this
document. There are three menus on the action bar: the Services menu, the
Options menu, and the Help menu.
The actions that are selectable from the Services menu operate on the active
window currently displayed on the screen. These actions include the following:
Placing Bookmarks
You can set a placeholder so you can retrieve information of interest to
you.
Searching for Information
You can find occurrences of a word or phrase in the current topic, selected
topics, or all topics.
Printing Information
You can print one or more topics. You can also print a set of topics by
first marking the topics in the Contents list.
Copying Information to a File
You can copy a topic that you are viewing to the System Clipboard or to a
file that you can edit. This method is particularly useful for copying
syntax definitions and program samples into the application that you are
developing.
Using the actions that are selectable from the Options menu, you can change
the way your Contents list is displayed. To expand the Contents and show all
levels for all topics, choose Expand all from the Options pull-down. You can
also press the Ctrl and * keys together.
The actions that are selectable from the Help menu allow you to select
different types of help information.
For information about any of the menu choices, highlight the choice in the
menu and press F1.
ΓòÉΓòÉΓòÉ <hidden> Placing Bookmarks ΓòÉΓòÉΓòÉ
When you place a bookmark on a topic, it is added to a list of bookmarks you
have previously set. You can view the list, and you can remove one or all
bookmarks from the list. If you have not set any bookmarks, the list is empty.
To set a bookmark, do the following:
1. Select a topic from the Contents.
2. When that topic appears, select the Bookmark option from the Services
menu.
3. If you want to change the name used for the bookmark, type the new name
in the field.
4. Click on the Place radio button (or press the Up or Down arrow key to
select it).
5. Click on OK (or select it and press Enter). The bookmark is then added to
the bookmark list.
ΓòÉΓòÉΓòÉ <hidden> Searching for Information ΓòÉΓòÉΓòÉ
You can specify a word or phrase to be searched. You can also limit the search
to a set of topics by first marking the topics in the Contents list.
To search for a word or phrase in all topics, do the following:
1. Select the Search option from the Services menu.
2. Type the word or words to be searched for.
3. Click on All sections (or press the Up or Down arrow keys to select it).
4. Click on Search (or select it and press Enter) to begin the search.
5. The list of topics where the word or phrase appears is displayed.
ΓòÉΓòÉΓòÉ <hidden> Printing Information ΓòÉΓòÉΓòÉ
You can print one or more topics, the index, or the table of contents. Make
sure that your printer is connected to the serial port, configured correctly,
and ready for input. To print:
1. Select Print from the Services pull-down.
2. Select what you want to print. Note that the "This section" and "Marked
sections" choices are only available if you are viewing a topic or if you
have marked topics, respectively. To mark topics in the table of
contents, press the Ctrl key and click on the topics, or use the arrow
keys.
3. Select Print to print what you've chosen on your printer.
ΓòÉΓòÉΓòÉ <hidden> Copying Information to a File ΓòÉΓòÉΓòÉ
You can copy a topic that you are viewing in two ways:
Copy copies the topic that you are viewing into the System Clipboard. If
you are using a Presentation Manager (PM) editor (for example, the
Enhanced Editor) that copies or cuts (or both) to the System Clipboard,
and pastes to the System Clipboard, you can easily add the copied
information to your program source module.
Copy to file copies the topic that you are viewing into a temporary file
named TEXT.TMP. You can later edit that file by using any editor.
TEXT.TMP is placed in the directory where your viewable document resides.
To copy a topic, do the following:
1. Expand the Contents list and select a topic.
2. When the topic appears, select Copy to file from the Services menu.
3. The system puts the text pertaining to that topic into the temporary file
TEXT.TMP.
ΓòÉΓòÉΓòÉ 1.11. How to Cut and Paste Examples ΓòÉΓòÉΓòÉ
You can copy examples (or information) from this reference/guide/book to
compile, link, and run them, or to paste them into your own code.
To copy an example or information:
1. Make the topic you want to copy the active window.
2. From the Services menu, select Copy to file. The text in that topic is
placed in the temporary file TEXT.TMP, in the same directory as this
reference.
3. You can then modify or use TEXT.TMP as you want.
Note: Because the system copies the entire contents of the topic to the file,
you may need to edit it to remove additional text. Most examples in this
reference are ready to compile, link, and run as they appear, and do not
require any editing.
ΓòÉΓòÉΓòÉ 1.12. Other Information You Might Find Helpful ΓòÉΓòÉΓòÉ
This product provides a number of online guides and references that we hope
you'll find helpful as you develop applications. This information includes
User's Guides, References, and How Do I help that gives you specific
instructions for performing common tasks. You can get to this online
information from the Information folder inside the main product folder. You
can also get to it from the Help menu in any of the components of the product.
ΓòÉΓòÉΓòÉ 1.13. Communicating Your Comments to IBM ΓòÉΓòÉΓòÉ
If there is something you like, or dislike, about this book, please let us
know. You can use one of the methods listed below to send your comments to
IBM. Please be sure to include the complete title of the publication that you
are commenting on.
The comments you send should only pertain to the information in this document
and its presentation. To request additional publications or to ask questions
or make comments about the functions of IBM products or systems, you should
talk to your IBM representative or you authorized IBM remarketer.
When you send comments to IBM, you grant IBM a nonexclusive right to use or
distribute your comments in any way it believes appropriate without incurring
any obligation to you.
You can send your comments to IBM in the following ways:
By mail to the following address:
IBM Canada Ltd. Laboratory
Information Development
2G/345/1150/TOR
1150 EGLINTON AVENUE EAST
NORTH YORK, ONTARIO
CANADA M3C 1H7
By FAX to the following number:
- United States and Canada: (416) 448-6161
- Other countries (+1) 416-448-6161
By electronic mail to one of the following IDs. Be sure to include your
entire network address if you wish to get a reply.
- Internet: torrcf@vnet.ibm.com
- IBMLink: toribm(torrcf)
- IBM/PROFS: torolab4(torrcf)
- IBMMAIL: ibmmail(caibmwt9
ΓòÉΓòÉΓòÉ 2. Basic Concepts ΓòÉΓòÉΓòÉ
The following chapters introduce concepts related to the part interface and the
notification framework.
ΓòÉΓòÉΓòÉ 2.1. The Part Interface ΓòÉΓòÉΓòÉ
Topics:
The Part Interface
Features
Connections
ΓòÉΓòÉΓòÉ <hidden> The Part Interface ΓòÉΓòÉΓòÉ
Visual Builder packages classes as parts. The part interface gives you the
means to work visually with classes through standard features and connections.
Fully enabled parts can notify each other of value or state changes that occur
in them. Class interface parts provide limited features and support connections
but cannot send notifications.
For information on implementing parts and features, refer to Building
VisualAge C++ Parts for Fun and Profit.
ΓòÉΓòÉΓòÉ <hidden> Features ΓòÉΓòÉΓòÉ
Part interface features organize class members as elements of attributes,
actions, and events. These features have the following characteristics:
An attribute is a property of a part. Class member functions enable you
to get and set the property. Most attributes can be set as well as
queried. Many attributes also have notification IDs that are used to
report attribute changes.
An action is a behavior of a part. A class member function performs the
part behavior.
An event informs other parts of an occurrence in a part. A notification
ID identifies the event.
ΓòÉΓòÉΓòÉ <hidden> Connections ΓòÉΓòÉΓòÉ
Part connections give you the ability to visually relate part features in the
following ways:
An attribute-to-action connection maps an attribute to an action. When
the attribute value is changed, the action is performed.
An attribute-to-attribute connection maps an attribute to another
attribute. When the source attribute value is changed, the other
attribute is updated with the same value.
An event-to-action connection maps an event to an action. When the event
occurs, the action is performed.
An event-to-attribute connection maps an event to an attribute. When the
event occurs, the attribute is updated with a new value.
An event-to-member-function connection maps an event to a class member
function. When the event occurs, the member function is called.
A parameter connection maps a value to a parameter on another connection.
The parameter connection can be made between the parameter and any of the
following:
- an attribute
- an action
- a member function
- custom logic
For more information on connections, refer to the Visual Builder User's Guide.
The Notification Framework describes class support for these connections.
ΓòÉΓòÉΓòÉ 2.2. The Notification Framework ΓòÉΓòÉΓòÉ
Topics:
The Notification Framework
Events, Notifiers, and Observers
Attribute Notifications
Event Notifications
ΓòÉΓòÉΓòÉ <hidden> The Notification Framework ΓòÉΓòÉΓòÉ
The notification framework supports communication among parts for attribute
changes and other events. This communication enables visual connections in the
Composition Editor.
As a visual application builder, you need not be concerned with implementation
details of the notification framework. Visual Builder provides this support for
visual connections. Be aware, however, that you can make connections only from
attributes with notification IDs and from events. All part interface events
have notification IDs.
For more information on implementing notifications, refer to Building
VisualAge C++ Parts for Fun and Profit.
ΓòÉΓòÉΓòÉ <hidden> Events, Notifiers, and Observers ΓòÉΓòÉΓòÉ
In this section, "event" is used in the general sense. It represents either an
attribute-change event or an event feature of the part interface.
A part in which an event occurs can notify other parts about the event. The
reporting part is called the notifier. Each part to be notified of an event is
registered as an observer of the event. The addObserver action performs this
function.
The notifier informs observers of an event by using the notifyObservers action.
A notification ID identifies the event, and notification data, if any, provides
additional information.
A notifier can enable and disable notification of observers. The
enableNotification action turns on notification for a part, and
disableNotification turns it off.
ΓòÉΓòÉΓòÉ <hidden> Attribute Notifications ΓòÉΓòÉΓòÉ
Notifications are commonly used to inform observers when an attribute value
changes. A notifier sends this notification when an attribute is changed and
the attribute has a notification ID. The notifier sends the new attribute value
as notification data.
ΓòÉΓòÉΓòÉ <hidden> Event Notifications ΓòÉΓòÉΓòÉ
Notifications are used to inform observers when an event defined by the part
interface occurs. The notifier can send information about some events as
notification data.
ΓòÉΓòÉΓòÉ 3. Visual and Nonvisual Parts ΓòÉΓòÉΓòÉ
The following chapters provide information on visual and nonvisual parts, which
are fully enabled parts. Chapters on class interface parts on the parts palette
also appear in this section.
ΓòÉΓòÉΓòÉ 3.1. IAnimatedButton ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Events
Settings Pages
General
Control
Styles
Handlers
Color
Size/Position
Font
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IAnimatedButton ΓòÉΓòÉΓòÉ
Title: IBM animated button control
Class name: IAnimatedButton
Base part: ICustomButton
Part type: Visual part
Part file: vbbase.vbb
An IAnimatedButton part is a selection button for an action. The choice is
identified by a graphic on the animated button.
The user can click the animated button to perform the indicated function. When
the action is selected, the graphic on the button is replaced by a cyclic
series of graphics. This gives the appearance of animation on the button while
the requested action is performed.
Use an IAnimatedButton part to give the user an action choice that shows
action when it is selected. A multimedia play button with a disk that spins
when pressed is an example of an animated button.
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - IAnimatedButton ΓòÉΓòÉΓòÉ
When building with an IAnimatedButton part, you can do the following:
Assign animation bitmaps to the animated button. Do this by setting the
Bitmap field on the IAnimatedButton General settings page. You can either
select a bitmap identifier, such as the play identifier, or specify a
resource range to set the Bitmap field.
Set the animation rate for the graphic sequence on the button. Do this by
setting the Animation rate field on the IAnimatedButton General settings
page.
Give the button the appearance of remaining latched down while it is
active. This simulates the behavior of such controls as a play button. Do
this by setting the latchable field on the IAnimatedButton Styles
settings page.
Allow the user to reach the button by using a tab key. Do this by setting
the tabStop field to On on the IAnimatedButton Styles settings page.
If the button is the first control in a group, allow the user to use
cursor keys to move between the button and follow controls in the group.
Do this by setting the group field to On on the IAnimatedButton Styles
settings page.
Start the action represented by the button. Do this by connecting the
IAnimatedButton buttonClickEvent feature to the action on the target
part. For example, to start the play action of an IMMAudioCD, connect the
IAnimatedButton buttonClickEvent feature to the IMMAudioCD play action.
Enable or disable the animated button when an event occurs.
Enable the button as follows:
1. Connect the event to the IAnimatedButton enable action.
2. The button is enabled by default. If you have changed this default,
open settings for the connection, press the Set parameters push
button, and check the Enabled setting.
Disable the button by connecting the event to the IAnimatedButton disable
action.
ΓòÉΓòÉΓòÉ <hidden> Attributes - IAnimatedButton ΓòÉΓòÉΓòÉ
Attribute S E Data type
activeColor Γûá Γûá IColor
allowsMouseClickFocus Γûá Boolean
animatedWhenLatched Boolean
animationRate Γûá unsigned long
animationStarted Boolean
asDebugInfo IString
asString IString
autoDeleteObject Γûá Boolean
autoDestroyWindow Γûá Boolean
autoLatchEnabled Γûá Boolean
backgroundColor Γûá Γûá IColor
bidiSupported Boolean
bitmap IBitmapHandle
bitmapCount unsigned long
borderColor Γûá Γûá IColor
characterSize ISize
clipboardHasTextFormat Boolean
currentBitmapIndex unsigned long
defaultPushButton IWindowHandle
disabledBackgroundColor Γûá Γûá IColor
disabledForegroundColor Γûá Γûá IColor
displaySize ISize
enabled Γûá Γûá Boolean
enabledForNotification Γûá Boolean
focus Γûá Boolean
font Γûá Γûá IFont
foregroundColor Γûá Γûá IColor
frameWindow Boolean
group Γûá Boolean
handle IWindowHandle
highlighted Boolean
hiliteBackgroundColor Γûá Γûá IColor
hiliteForegroundColor Γûá Γûá IColor
id Γûá unsigned long
inactiveColor Γûá Γûá IColor
isDigits Γûá
itemProvider Γûá IDMItemProvider*
latched Γûá Γûá Boolean
latchedBackgroundColor Γûá IColor
latchedBackgroundColorHalftone Boolean
latchedForegroundColor Γûá IColor
latchingEnabled Γûá Boolean
layoutAdjustment IRectangle
menu
messageQueue IMessageQueueHandle
minimumSize Γûá ISize
nativeRect IRectangle
owner Γûá IWindow*
parent Γûá IWindow*
parentSize ISize
pointerCaptured Boolean
position Γûá Γûá IPoint
presSpace IPresSpaceHandle
rect Γûá IRectangle
shadowColor Γûá Γûá IColor
showing Boolean
size Γûá Γûá ISize
tabStop Γûá Boolean
text Γûá Γûá IString
textLength Γûá unsigned long
userData Γûá unsigned long
valid Boolean
valueAsDouble Γûá Γûá
valueAsInt Γûá Γûá
valueAsUnsigned Γûá Γûá
visible Γûá Γûá Boolean
visibleRectangle IRectangle
ΓòÉΓòÉΓòÉ <hidden> Actions - IAnimatedButton ΓòÉΓòÉΓòÉ
Action Parameters
applyBidiSettings BidiSettings&, Boolean, Boolean
capturePointer Boolean
click None
convertToGUIStyle IBitFlag&, Boolean
disable None
disableAnimateWhenLatched None
disableAutoLatch None
disableGroup None
disableLatching None
disableMouseClickFocus None
disableNotification None
disableTabStop None
disableUpdate None
dispatchRemainingHandlers IEvent&, Boolean
enable Boolean
enableAnimateWhenLatched Boolean
enableUpdate Boolean
handleException IException&, IEvent&
hide None
hideSourceEmphasis None
highlight Boolean
isLayoutDistorted unsigned long
matchForMnemonic unsigned short
notifyObservers INotificationEvent&
positionBehindSibling IWindowHandle&
positionBehindSiblings None
positionOnSiblings None
postEvent unsigned long, IEventParameter1&,
IEventParameter2&
refresh IRectangle&
releasePointer None
releasePresSpace IPresSpaceHandle&
resetActiveColor None
resetBackgroundColor None
resetBorderColor None
resetDisabledBackgroundColor None
resetDisabledForegroundColor None
resetFont None
resetForegroundColor None
resetHiliteBackgroundColor None
resetHiliteForegroundColor None
resetInactiveColor None
resetLatchedBackgroundColor None
resetLatchedForegroundColor None
resetMinimumSize None
resetShadowColor None
sendEvent unsigned long, IEventParameter1&,
IEventParameter2&
setBitmaps IResourceId&, unsigned long
setFocus None
setLayoutDistorted unsigned long, unsigned long
show Boolean
showSourceEmphasis Boolean
startAnimation unsigned long
stopAnimation None
unhighlight None
unlatch None
ΓòÉΓòÉΓòÉ <hidden> Events - IAnimatedButton ΓòÉΓòÉΓòÉ
Event Notification ID
buttonClickEvent buttonClickId
commandEvent commandId
gotFocusEvent FOCUSTRUEID
inputDisabledEvent ENABLEFALSEID
inputEnabledEvent ENABLETRUEID
lostFocusEvent FOCUSFALSEID
systemCommandEvent systemCommandId
visibilityDisabledEvent VISIBLEFALSEID
visibilityEnabledEvent VISIBLETRUEID
ΓòÉΓòÉΓòÉ <hidden> General Settings - IAnimatedButton ΓòÉΓòÉΓòÉ
Subpart name Sets the name of the subpart (a part placed on a composite part).
Default value: The name of the part
Text Sets the text for the part.
Default value: The name of the part
Latched Sets the part to the latched state.
Default value: Not selected
Animation rate Sets the current animation rate for the part.
Default value: 1,000
Bitmap Specifies the bitmap to be used.
Default value: Identifier
Identifier list Sets a list of identifers for the part.
Default value: The first item in the list is selected by default.
DLL name Specifies the name of the resource .dll that contains the bitmap.
Default value: None
Resource ID Specifies the resource identifier of the bitmap.
Default value: None
Bitmap count Specifies the number of bitmaps to be used.
Default value: 1
ΓòÉΓòÉΓòÉ <hidden> Control Settings - IAnimatedButton ΓòÉΓòÉΓòÉ
Fly over short text Specifies the short text for the fly-over text control.
Default value: None
Fly over long text Specifies the long text for the fly-over text control.
Default value: None
Window id Sets the window identifier.
Default value: None
Help panel id Sets the help panel identifier for the part.
Default value: None
Enabled Enables the handler by default.
Default value: Selected
ΓòÉΓòÉΓòÉ <hidden> Styles Settings - IAnimatedButton ΓòÉΓòÉΓòÉ
defaultStyle() Resets the part to the original default style.
Default value: Selected
animateWhenLatched Sets the style for the part to the latched state.
Default value: Not selected
latchable Sets the default style to the latchable state.
Default value: The Default radio button is selected.
autoLatch Sets the default style for the part the automatic latch state.
Default value: The Default radio button is selected.
noPointerFocus Allows the cursor stay on a control for which information is
required, rather than moving to the button. Buttons with this style do not
set the focus to themselves when the user clicks on them using the mouse.
This has no effect on keyboard interaction.
Default value: The Default radio button is selected.
group Identifies the control as being the first in a group. No other controls
in the group can have this style. Controls in the group must be siblings
that are constructed following the first control. The group can be cursored
and when the last control in the group is reached, the cursor returns the
first control in the group.
Default value: The default is off, and the Default radio button is selected.
tabStop Identifies the control as one to which the user can tab.
Default value: The default is off, and the Default radio button is selected.
clipChildren Excludes the area occupied by the children of the window when
drawing in the window. Child windows are always "clipped" to their parent
window. When a parent window is painted, the clipChildren style controls
whether the invalidated region of the parent window includes the area
occupied by its children, thus preventing a window from painting over its
child windows.
Default value: The Default radio button is selected.
clipSiblings Controls which sibling window is displayed on top when multiple
siblings are displayed. Sibling windows are windows that share the same
parent window. Assign the clipSiblings style to the sibling window that you
want displayed on top of the other siblings, in Z-order.
Default value: The Default radio button is selected.
clipToParent Allows a window to paint outside of its window boundary up to the
window boundary of its parent.
Default value: The Default radio button is selected.
saveBits Optimizes the painting of a window by saving the screen image of the
area under the window as a bitmap and then using the bitmap to redraw the
window, when necessary.
Default value: The Default radio button is selected.
synchPaint Synchronously repaints the window. Without this style, painting
only occurs if there are no other events waiting to be processed.
Default value: The Default radio button is selected.
visible Makes the window visible. In general, controls are constructed as
visible, and frame windows are constructed as invisible.
Default value: The default is on, and the Default radio button is selected.
ΓòÉΓòÉΓòÉ <hidden> Handlers Settings - IAnimatedButton ΓòÉΓòÉΓòÉ
Handler name Sets the name of the default handler.
Default value: None
Handler list Sets the name of the handler for the MLE control.
Default value: None
Add after Adds the new choice after the selected choice in the list. If no
choice is selected, the new choice is added after the first choice in the
list.
Default value: Highlighted
Add before Adds the new choice before the selected choice in the list. If no
choice is selected, the new choice is added before the first choice in the
list.
Default value: Not highlighted
Move Determines whether a part and its descendants can be moved to a new
location.
Default value: Not highlighted
Remove Removes one item from the part and returns the count of the number of
items that remain.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ <hidden> Color Settings - IAnimatedButton ΓòÉΓòÉΓòÉ
Color area Sets the color of the given area. Choices are as follows:
Foreground
Sets the color for foreground text
Background
Sets the color for background text
Latched foreground
Sets the foreground color for latched text
Latched background
Sets the background color for latched text
Default value: Foreground is selected
Color selection Enables color selection by either color values or RGB values.
Select Colors or RGB. If you select Colors, you can set the Color values. If
you select RGB, you can set the RGB values.
Default value: RGB selected
Color values Sets the color value of the window area, or sets the passed
default if no color for the area has been set.
Default value: None
RGB values Sets the color values for the window area.
Default value: Not set
ΓòÉΓòÉΓòÉ <hidden> Size/Position Settings - IAnimatedButton ΓòÉΓòÉΓòÉ
X field Sets the X coordinate of the part.
Default value: The x coordinate of the part currently positioned on the
free-form surface
Y field Sets the Y coordinate of the point.
Default value: The y coordinate of the part currently positioned on the
free-form surface
Width Sets the width of the text.
Default value: None
Height Sets the height of the text.
Default value: None
Minimum size Determines the minimum size of the part.
Select Calculate at execution time or Set value here. If you select
Calculate at execution time, the minimum size is determined dynamically. If
you select Set value here, you can set the Minimum size Width and Height
fields to define a fixed minimum size.
Default value: Calculate at execution time is selected
Width Sets the minimum-allowable width, which is set by the user's class.
Default value: None (calculated at execution time)
Height Sets the minimum-allowable height, which is set by the user's class.
Default value: None (calculated at execution time)
ΓòÉΓòÉΓòÉ <hidden> Font Settings - IAnimatedButton ΓòÉΓòÉΓòÉ
Name Sets the name of the font.
Default value: System proportional
Point size Sets the point size of the font.
Default value: 10
Style Sets the style for the part.
Default value: None
Emphasis Gives the part emphasis. If a part is specified, the emphasis is
drawn around the part.
Default value: None
Edit Opens an edit field on a part or setting.
Default value: Highlighted
Default font Sets the current default font style.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ 3.2. IBitmapControl ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Events
Settings Pages
General
Control
Styles
Handlers
Color
Size/Position
Font
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IBitmapControl ΓòÉΓòÉΓòÉ
Title: IBM bitmap control
Class name: IBitmapControl
Base part: IStaticText
Part type: Visual part
Part file: vbbase.vbb
An IBitmapControl part draws a graphical image on the background of another
part.
The user does not use the bitmap for any action.
Use an IBitmapControl part to provide a picture for graphical application
data. Be aware that a bitmap is resized on either a set canvas or a multicell
canvas when the canvas is resized.
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - IBitmapControl ΓòÉΓòÉΓòÉ
When building with an IBitmapControl part, you can do the following:
Assign a bitmap to the control. Do this by setting the DLL name and
Resource ID fields on the IBitmapControl General settings page.
Show or hide the bitmap when an event occurs.
Show the bitmap as follows:
1. Connect the event to the IBitmapControl show action.
2. Open settings for the connection, press the Set parameters push
button, and check the visible setting.
Hide the bitmap by connecting the event to the IBitmapControl disable
action.
ΓòÉΓòÉΓòÉ <hidden> Attributes - IBitmapControl ΓòÉΓòÉΓòÉ
Attribute S E Data type
activeColor Γûá Γûá IColor
alignment Γûá Alignment
asDebugInfo IString
asString IString
autoDeleteObject Γûá Boolean
autoDestroyWindow Γûá Boolean
backgroundColor Γûá Γûá IColor
bidiSupported Boolean
bitmap Γûá IBitmapHandle
borderColor Γûá Γûá IColor
characterSize ISize
clipboardHasTextFormat Boolean
defaultPushButton IWindowHandle
disabledBackgroundColor Γûá Γûá IColor
disabledForegroundColor Γûá Γûá IColor
displaySize ISize
enabled Γûá Γûá Boolean
enabledForNotification Γûá Boolean
fillBackground Γûá Γûá Boolean
fillColor Γûá Γûá IColor
focus Γûá Boolean
font Γûá Γûá IFont
foregroundColor Γûá Γûá IColor
frameWindow Boolean
group Γûá Boolean
halftone Γûá Γûá Boolean
handle IWindowHandle
hiliteBackgroundColor Γûá Γûá IColor
hiliteForegroundColor Γûá Γûá IColor
id Γûá unsigned long
inactiveColor Γûá Γûá IColor
isDigits Γûá
itemProvider Γûá IDMItemProvider*
layoutAdjustment IRectangle
limit Γûá Γûá unsigned long
menu
messageQueue IMessageQueueHandle
minimumSize Γûá ISize
nativeRect IRectangle
owner Γûá IWindow*
parent Γûá IWindow*
parentSize ISize
pointerCaptured Boolean
position Γûá Γûá IPoint
presSpace IPresSpaceHandle
rect Γûá IRectangle
shadowColor Γûá Γûá IColor
showing Boolean
size Γûá Γûá ISize
strikeout Γûá Γûá Boolean
tabStop Γûá Boolean
text Γûá Γûá IString
textLength Γûá unsigned long
underscore Γûá Γûá Boolean
valid Boolean
valueAsDouble Γûá Γûá
valueAsInt Γûá Γûá
valueAsUnsigned Γûá Γûá
visible Γûá Γûá Boolean
visibleRectangle IRectangle
ΓòÉΓòÉΓòÉ <hidden> Actions - IBitmapControl ΓòÉΓòÉΓòÉ
Action Parameters
applyBidiSettings BidiSettings&, Boolean, Boolean
capturePointer Boolean
convertToGUIStyle IBitFlag&, Boolean
disable None
disableFillBackground None
disableGroup None
disableHalftone None
disableNotification None
disableStrikeout None
disableTabStop None
disableUnderscore None
disableUpdate None
dispatchRemainingHandlers IEvent&, Boolean
enable Boolean
enableUpdate Boolean
handleException IException&, IEvent&
hide None
hideSourceEmphasis None
isLayoutDistorted unsigned long
matchForMnemonic unsigned short
notifyObservers INotificationEvent&
positionBehindSibling IWindowHandle&
positionBehindSiblings None
positionOnSiblings None
postEvent unsigned long, IEventParameter1&,
IEventParameter2&
refresh IRectangle&
releasePointer None
releasePresSpace IPresSpaceHandle&
resetActiveColor None
resetBackgroundColor None
resetBorderColor None
resetDisabledBackgroundColor None
resetDisabledForegroundColor None
resetFillColor None
resetFont None
resetForegroundColor None
resetHiliteBackgroundColor None
resetHiliteForegroundColor None
resetInactiveColor None
resetMinimumSize None
resetShadowColor None
sendEvent unsigned long, IEventParameter1&,
IEventParameter2&
setFocus None
setLayoutDistorted unsigned long, unsigned long
show Boolean
showSourceEmphasis Boolean
ΓòÉΓòÉΓòÉ <hidden> Events - IBitmapControl ΓòÉΓòÉΓòÉ
Event Notification ID
commandEvent commandId
gotFocusEvent FOCUSTRUEID
inputDisabledEvent ENABLEFALSEID
inputEnabledEvent ENABLETRUEID
lostFocusEvent FOCUSFALSEID
systemCommandEvent systemCommandId
visibilityDisabledEvent VISIBLEFALSEID
visibilityEnabledEvent VISIBLETRUEID
ΓòÉΓòÉΓòÉ <hidden> General Settings - IBitmapControl ΓòÉΓòÉΓòÉ
DLL name Sets the name of the DLL file to be loaded.
Default value: None
Resource Id Sets the resource identifier for the part.
Default value: 0
Subpart name Sets the name of the subpart (a part placed on a composite part).
Default value: The name of the part
Text Sets the text for the part.
Default value: The name of the part
Limit Sets the length (in bytes) of the longest text the part can hold.
Default value: 0
Alignment Changes the alignment of the part.
Default value: Upper left
Word wrap Enables word wrap of text around at the end of a line.
Default value: Not selected
ΓòÉΓòÉΓòÉ <hidden> Control Settings - IBitmapControl ΓòÉΓòÉΓòÉ
Fly over short text Specifies the short text for the fly-over text control.
Default value: None
Fly over long text Specifies the long text for the fly-over text control.
Default value: None
Window id Sets the window identifier.
Default value: None
Help panel id Sets the help panel identifier for the part.
Default value: None
Enabled Enables the handler by default.
Default value: Selected
ΓòÉΓòÉΓòÉ <hidden> Styles Settings - IBitmapControl ΓòÉΓòÉΓòÉ
defaultStyle() Resets the part to the original default style.
Default value: Selected
sizeToBitmap Sizes the window to the size of the currently set bitmap.
Default value: The Default radio button is selected.
mnemonic Draws the next character with mnemonic emphasis if a mnemonic prefix
character is found.
Default value: The Default radio button is selected.
fillBackground Erases the background, using the currently set fill color
before drawing the text.
Default value: The default is on, and the Default radio button is selected.
halftone Draws the text in halftone color.
Default value: The default is off, and the Default radio button is selected.
strikeout Draws the text with overstriking.
Default value: The default is off, and the Default radio button is selected.
underscore Draws the text with underscoring.
Default value: The default is off, and the Default radio button is selected.
group Identifies the control as being the first in a group. No other controls
in the group can have this style. Controls in the group must be siblings
that are constructed following the first control. The group can be cursored
and when the last control in the group is reached, the cursor returns the
first control in the group.
Default value: The default is off, and the Default radio button is selected.
tabStop Identifies the control as one to which the user can tab.
Default value: The default is off, and the Default radio button is selected.
clipChildren Excludes the area occupied by the children of the window when
drawing in the window. Child windows are always "clipped" to their parent
window. When a parent window is painted, the clipChildren style controls
whether the invalidated region of the parent window includes the area
occupied by its children, thus preventing a window from painting over its
child windows.
Default value: The Default radio button is selected.
clipSiblings Controls which sibling window is displayed on top when multiple
siblings are displayed. Sibling windows are windows that share the same
parent window. Assign the clipSiblings style to the sibling window that you
want displayed on top of the other siblings, in Z-order.
Default value: The Default radio button is selected.
clipToParent Allows a window to paint outside of its window boundary up to the
window boundary of its parent.
Default value: The Default radio button is selected.
saveBits Optimizes the painting of a window by saving the screen image of the
area under the window as a bitmap and then using the bitmap to redraw the
window, when necessary.
Default value: The Default radio button is selected.
synchPaint Synchronously repaints the window. Without this style, painting
only occurs if there are no other events waiting to be processed.
Default value: The Default radio button is selected.
visible Makes the window visible. In general, controls are constructed as
visible, and frame windows are constructed as invisible.
Default value: The default is on, and the Default radio button is selected.
ΓòÉΓòÉΓòÉ <hidden> Handlers Settings - IBitmapControl ΓòÉΓòÉΓòÉ
Handler name Sets the name of the default handler.
Default value: None
Handler list Sets the name of the handler for the MLE control.
Default value: None
Add after Adds the new choice after the selected choice in the list. If no
choice is selected, the new choice is added after the first choice in the
list.
Default value: Highlighted
Add before Adds the new choice before the selected choice in the list. If no
choice is selected, the new choice is added before the first choice in the
list.
Default value: Not highlighted
Move Determines whether a part and its descendants can be moved to a new
location.
Default value: Not highlighted
Remove Removes one item from the part and returns the count of the number of
items that remain.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ <hidden> Color Settings - IBitmapControl ΓòÉΓòÉΓòÉ
Color area Sets the color of the given area. Choices are as follows:
Foreground
Sets the color for foreground text
Background
Sets the color for background text that surrounds the part
Fill
Sets the color for the area of the part that is not occupied by
text
Default value: Foreground is selected
Color selection Enables color selection by either color values or RGB values.
Select Colors or RGB. If you select Colors, you can set the Color values. If
you select RGB, you can set the RGB values.
Default value: RGB selected
Color values Sets the color value of the window area, or sets the passed
default if no color for the area has been set.
Default value: None
RGB values Sets the color values for the static text.
Default value: Red=0, Green=0, Blue=170
ΓòÉΓòÉΓòÉ <hidden> Size/Position Settings - IBitmapControl ΓòÉΓòÉΓòÉ
X field Sets the X coordinate of the part.
Default value: The x coordinate of the part currently positioned on the
free-form surface
Y field Sets the Y coordinate of the point.
Default value: The y coordinate of the part currently positioned on the
free-form surface
Width Sets the width of the text.
Default value: None
Height Sets the height of the text.
Default value: None
Minimum size Determines the minimum size of the part.
Select Calculate at execution time or Set value here. If you select
Calculate at execution time, the minimum size is determined dynamically. If
you select Set value here, you can set the Minimum size Width and Height
fields to define a fixed minimum size.
Default value: Calculate at execution time is selected
Width Sets the minimum-allowable width, which is set by the user's class.
Default value: None (calculated at execution time)
Height Sets the minimum-allowable height, which is set by the user's class.
Default value: None (calculated at execution time)
ΓòÉΓòÉΓòÉ <hidden> Font Settings - IBitmapControl ΓòÉΓòÉΓòÉ
Name Sets the name of the font.
Default value: System proportional
Point size Sets the point size of the font.
Default value: 10
Style Sets the style for the part.
Default value: None
Emphasis Gives the part emphasis. If a part is specified, the emphasis is
drawn around the part.
Default value: None
Edit Opens an edit field on a part or setting.
Default value: Highlighted
Default font Sets the current default font style.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ 3.3. ICanvas ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Events
Settings Pages
General
Control
Styles
Handlers
Color
Size/Position
Font
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - ICanvas ΓòÉΓòÉΓòÉ
Title: ICanvas
Class name: ICanvas
Base part: IControl
Part type: Visual part
Part file: vbbase.vbb
An ICanvas part is a background part for the client area of a frame window.
Think of a canvas as a drawing board for the placement of control parts.
The user interacts with controls placed on a canvas, not with the canvas
itself.
Use an ICanvas part to fill in a framework, such as one of the following:
The client area of a frame window
A view port
A notebook page
You can then place other parts on the canvas, effectively placing the parts
within the framework.
You can also use a canvas as the base part for a composite part. Then, you can
add the canvas with its controls as a subpart on a canvas in another composite
part.
The placement and size of controls on an ICanvas is fixed. They are not
adjustable for different display resolutions or for national language support.
Alternatively, use one of the following canvases:
ISplitCanvas for split windows
ISetCanvas for canvas cells in uniform rows or columns
IMultiCellCanvas to provide freely arranged canvas cells
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - ICanvas ΓòÉΓòÉΓòÉ
When building with an ICanvas part, you can do the following:
Add a handler for all parts on the canvas. Do this as follows:
- Add the handler name and parameters in the Handler list field on the
ICanvas Handlers settings page.
- Type the .hpp file name for the handler in the Class Editor Required
include files field.
Change the font for all parts on the canvas. Do this by selecting a font
on the ICanvas Font settings page.
Change the background color of the canvas. Do this by selecting a color
from the Colors field or by setting RGB values in the RGB values field on
the ICanvas Color settings page.
ΓòÉΓòÉΓòÉ <hidden> Attributes - ICanvas ΓòÉΓòÉΓòÉ
Attribute S E Data type
activeColor Γûá Γûá IColor
asDebugInfo IString
asString IString
autoDeleteObject Γûá Boolean
autoDestroyWindow Γûá Boolean
backgroundColor Γûá Γûá IColor
bidiSupported Boolean
borderColor Γûá Γûá IColor
characterSize ISize
defaultPushButton IWindowHandle
disabledBackgroundColor Γûá Γûá IColor
disabledForegroundColor Γûá Γûá IColor
enabled Γûá Γûá Boolean
enabledForNotification Γûá Boolean
focus Γûá Boolean
font Γûá Γûá IFont
foregroundColor Γûá Γûá IColor
frameWindow Boolean
group Γûá Boolean
handle IWindowHandle
hiliteBackgroundColor Γûá Γûá IColor
hiliteForegroundColor Γûá Γûá IColor
id Γûá unsigned long
inactiveColor Γûá Γûá IColor
itemProvider Γûá IDMItemProvider*
layoutAdjustment IRectangle
menu
messageQueue IMessageQueueHandle
minimumSize Γûá ISize
nativeRect IRectangle
origDefaultButtonHandle IWindowHandle
owner Γûá IWindow*
parent Γûá IWindow*
parentSize ISize
pointerCaptured Boolean
position Γûá Γûá IPoint
presSpace IPresSpaceHandle
rect Γûá IRectangle
shadowColor Γûá Γûá IColor
showing Boolean
size Γûá Γûá ISize
tabStop Γûá Boolean
valid Boolean
visible Γûá Γûá Boolean
visibleRectangle IRectangle
ΓòÉΓòÉΓòÉ <hidden> Actions - ICanvas ΓòÉΓòÉΓòÉ
Action Parameters
applyBidiSettings BidiSettings&, Boolean, Boolean
capturePointer Boolean
convertToGUIStyle IBitFlag&, Boolean
disable None
disableGroup None
disableNotification None
disableTabStop None
disableUpdate None
dispatchRemainingHandlers IEvent&, Boolean
enable Boolean
enableUpdate Boolean
handleException IException&, IEvent&
hide None
hideSourceEmphasis None
isLayoutDistorted unsigned long
matchForMnemonic unsigned short
notifyObservers INotificationEvent&
positionBehindSibling IWindowHandle&
positionBehindSiblings None
positionOnSiblings None
postEvent unsigned long, IEventParameter1&,
IEventParameter2&
refresh IRectangle&
releasePointer None
releasePresSpace IPresSpaceHandle&
resetActiveColor None
resetBackgroundColor None
resetBorderColor None
resetDisabledBackgroundColor None
resetDisabledForegroundColor None
resetFont None
resetForegroundColor None
resetHiliteBackgroundColor None
resetHiliteForegroundColor None
resetInactiveColor None
resetMinimumSize None
resetShadowColor None
sendEvent unsigned long, IEventParameter1&,
IEventParameter2&
setFocus None
setLayoutDistorted unsigned long, unsigned long
show Boolean
showSourceEmphasis Boolean
ΓòÉΓòÉΓòÉ <hidden> Events - ICanvas ΓòÉΓòÉΓòÉ
Event Notification ID
commandEvent commandId
gotFocusEvent FOCUSTRUEID
inputDisabledEvent ENABLEFALSEID
inputEnabledEvent ENABLETRUEID
lostFocusEvent FOCUSFALSEID
systemCommandEvent systemCommandId
visibilityDisabledEvent VISIBLEFALSEID
visibilityEnabledEvent VISIBLETRUEID
ΓòÉΓòÉΓòÉ <hidden> General Settings - ICanvas ΓòÉΓòÉΓòÉ
Subpart name Sets the name of the subpart (a part placed on a composite part).
Default value: The name of the part
ΓòÉΓòÉΓòÉ <hidden> Control Settings - ICanvas ΓòÉΓòÉΓòÉ
Fly over short text Specifies the short text for the fly-over text control.
Default value: None
Fly over long text Specifies the long text for the fly-over text control.
Default value: None
Window id Sets the window identifier.
Default value: None
Help panel id Sets the help panel identifier for the part.
Default value: None
Enabled Enables the handler by default.
Default value: Selected
ΓòÉΓòÉΓòÉ <hidden> Styles Settings - ICanvas ΓòÉΓòÉΓòÉ
defaultStyle() Resets the part to the original default style.
Default value: Selected
clipChildren Excludes the area occupied by the children of the window when
drawing in the window. Child windows are always "clipped" to their parent
window. When a parent window is painted, the clipChildren style controls
whether the invalidated region of the parent window includes the area
occupied by its children, thus preventing a window from painting over its
child windows.
Default value: The Default radio button is selected.
clipSiblings Controls which sibling window is displayed on top when multiple
siblings are displayed. Sibling windows are windows that share the same
parent window. Assign the clipSiblings style to the sibling window that you
want displayed on top of the other siblings, in Z-order.
Default value: The Default radio button is selected.
clipToParent Allows a window to paint outside of its window boundary up to the
window boundary of its parent.
Default value: The Default radio button is selected.
saveBits Optimizes the painting of a window by saving the screen image of the
area under the window as a bitmap and then using the bitmap to redraw the
window, when necessary.
Default value: The Default radio button is selected.
synchPaint Synchronously repaints the window. Without this style, painting
only occurs if there are no other events waiting to be processed.
Default value: The Default radio button is selected.
visible Makes the window visible. In general, controls are constructed as
visible, and frame windows are constructed as invisible.
Default value: The default is on, and the Default radio button is selected.
ΓòÉΓòÉΓòÉ <hidden> Handlers Settings - ICanvas ΓòÉΓòÉΓòÉ
Handler name Sets the name of the default handler.
Default value: None
Handler list Sets the name of the handler for the MLE control.
Default value: None
Add after Adds the new choice after the selected choice in the list. If no
choice is selected, the new choice is added after the first choice in the
list.
Default value: Highlighted
Add before Adds the new choice before the selected choice in the list. If no
choice is selected, the new choice is added before the first choice in the
list.
Default value: Not highlighted
Move Determines whether a part and its descendants can be moved to a new
location.
Default value: Not highlighted
Remove Removes one item from the part and returns the count of the number of
items that remain.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ <hidden> Color Settings - ICanvas ΓòÉΓòÉΓòÉ
Color area Sets the color of the given area. Choices are as follows:
Background
Sets the color for background text
Default value: Background is selected
Color selection Enables color selection by either color values or RGB values.
Select Colors or RGB. If you select Colors, you can set the Color values. If
you select RGB, you can set the RGB values.
Default value: Colors selected
Color values Sets the color value of the window area, or sets the passed
default if no color for the area has been set.
Default value: None
RGB values Sets the color values for the canvas.
Default value: Red=255, Green=255, Blue=255
ΓòÉΓòÉΓòÉ <hidden> Size/Position Settings - ICanvas ΓòÉΓòÉΓòÉ
X field Sets the X coordinate of the part if it is not the client part.
Default value: Not available
Y field Sets the Y coordinate of the part if it is not the client part.
Default value: Not available
Width Sets the width of the canvas, if it is not the client part.
Default value: Not available
Height Sets the height of the canvas, if it is not the client part.
Default value: Not available
Minimum size Determines the minimum size of the part.
Select Calculate at execution time or Set value here. If you select
Calculate at execution time, the minimum size is determined dynamically. If
you select Set value here, you can set the Minimum size Width and Height
fields to define a fixed minimum size.
Default value: Calculate at execution time is selected
Width Sets the minimum-allowable width, which is set by the user's class.
Default value: None (calculated at execution time)
Height Sets the minimum-allowable height, which is set by the user's class.
Default value: None (calculated at execution time)
ΓòÉΓòÉΓòÉ <hidden> Font Settings - ICanvas ΓòÉΓòÉΓòÉ
Name Sets the name of the font.
Default value: System proportional
Point size Sets the point size of the font.
Default value: 10
Style Sets the style for the part.
Default value: None
Emphasis Gives the part emphasis. If a part is specified, the emphasis is
drawn around the part.
Default value: None
Edit Opens an edit field on a part or setting.
Default value: Highlighted
Default font Sets the current default font style.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ 3.4. ICheckBox ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Events
Settings Pages
General
Control
Styles
Handlers
Color
Size/Position
Font
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - ICheckBox ΓòÉΓòÉΓòÉ
Title: IBM 2-state check-box control
Class name: ICheckBox
Base part: ISettingButton
Part type: Visual part
Part file: vbbase.vbb
An ICheckBox part is a square box with text that represents a settings choice.
A mark in the check box indicates that the choice is selected.
The user can select a choice by selecting an unmarked check box. The user can
deselect the choice by selecting it again, unmarking the check box.
Use an ICheckBox part to provide a settings choice that has two clearly
distinguishable states, for example, on and off.
Use check boxes in a group to provide multiple choices that are not mutually
exclusive. Alternatively, use a group of IRadioButton parts for a set of
mutually exclusive choices.
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - ICheckBox ΓòÉΓòÉΓòÉ
When building with an ICheckBox part, you can do the following:
Set the text for the check box. Do this by entering the text you want in
the Text field on the ICheckBox General settings page.
Set the initial state of the check box. Do this by selecting or
deselecting the Selected field on the ICheckBox General settings page.
To initially select your check box, make sure the Selected field check
box is checked. If it is not checked, click on it with mouse button 1 to
select it.
To initially not select your check box, make sure the Selected field
check box is not checked. If it is checked, click on it with mouse
button1 to deselect it.
Allow the user to reach the check box by using a tab key. Do this by
setting the tabStop field to On on the ICheckBox Styles settings page.
If the check box is the first control in a group, allow the user to use
cursor keys to move between the check box and follow controls in the
group. Do this by setting the group field to On on the ICheckBox Styles
settings page.
Enable or disable another control when the user selects the check box.
Enable the other control by connecting the ICheckBox selected attribute
to the enabled attribute of the other control. When the user deselects
the check box, the other control is disabled.
Disable the other control by connecting the ICheckBox selected attribute
to the value attribute of an IVBBooleanPart and then connecting the
IVBBooleanPart notValue attribute to the enabled attribute of the other
control. When the user deselects the check box, the other control is
enabled.
IVBBooleanPart is available in the vbsample.vbb file.
Enable or disable the check box when an event occurs.
Enable the check box as follows:
1. Connect the event to the ICheckBox enable action.
2. The check box is enabled by default. If you have changed this
default, open settings for the connection, press the Set parameters
push button, and check the Enabled setting.
Disable the check box by connecting the event to the ICheckBox disable
action.
ΓòÉΓòÉΓòÉ <hidden> Attributes - ICheckBox ΓòÉΓòÉΓòÉ
Attribute S E Data type
activeColor Γûá Γûá IColor
allowsMouseClickFocus Γûá Boolean
asDebugInfo IString
asString IString
autoDeleteObject Γûá Boolean
autoDestroyWindow Γûá Boolean
autoSelect Γûá Boolean
backgroundColor Γûá Γûá IColor
bidiSupported Boolean
borderColor Γûá Γûá IColor
characterSize ISize
clipboardHasTextFormat Boolean
defaultPushButton IWindowHandle
disabledBackgroundColor Γûá Γûá IColor
disabledForegroundColor Γûá Γûá IColor
displaySize ISize
enabled Γûá Γûá Boolean
enabledForNotification Γûá Boolean
focus Γûá Boolean
font Γûá Γûá IFont
foregroundColor Γûá Γûá IColor
frameWindow Boolean
group Γûá Boolean
handle IWindowHandle
highlighted Boolean
hiliteBackgroundColor Γûá Γûá IColor
hiliteForegroundColor Γûá Γûá IColor
id Γûá unsigned long
inactiveColor Γûá Γûá IColor
isDigits Γûá
itemProvider Γûá IDMItemProvider*
layoutAdjustment IRectangle
menu
messageQueue IMessageQueueHandle
minimumSize Γûá ISize
nativeRect IRectangle
owner Γûá IWindow*
parent Γûá IWindow*
parentSize ISize
pointerCaptured Boolean
position Γûá Γûá IPoint
presSpace IPresSpaceHandle
rect Γûá IRectangle
selected Γûá Boolean
shadowColor Γûá Γûá IColor
showing Boolean
size Γûá Γûá ISize
tabStop Γûá Boolean
text Γûá Γûá IString
textLength Γûá unsigned long
valid Boolean
valueAsDouble Γûá Γûá
valueAsInt Γûá Γûá
valueAsUnsigned Γûá Γûá
visible Γûá Γûá Boolean
visibleRectangle IRectangle
ΓòÉΓòÉΓòÉ <hidden> Actions - ICheckBox ΓòÉΓòÉΓòÉ
Action Parameters
applyBidiSettings BidiSettings&, Boolean, Boolean
capturePointer Boolean
click None
convertToGUIStyle IBitFlag&, Boolean
deselect None
disable None
disableAutoSelect None
disableGroup None
disableMouseClickFocus None
disableNotification None
disableTabStop None
disableUpdate None
dispatchRemainingHandlers IEvent&, Boolean
enable Boolean
enableUpdate Boolean
handleException IException&, IEvent&
hide None
hideSourceEmphasis None
highlight Boolean
isLayoutDistorted unsigned long
matchForMnemonic unsigned short
notifyObservers INotificationEvent&
positionBehindSibling IWindowHandle&
positionBehindSiblings None
positionOnSiblings None
postEvent unsigned long, IEventParameter1&,
IEventParameter2&
refresh IRectangle&
releasePointer None
releasePresSpace IPresSpaceHandle&
resetActiveColor None
resetBackgroundColor None
resetBorderColor None
resetDisabledBackgroundColor None
resetDisabledForegroundColor None
resetFont None
resetForegroundColor None
resetHiliteBackgroundColor None
resetHiliteForegroundColor None
resetInactiveColor None
resetMinimumSize None
resetShadowColor None
sendEvent unsigned long, IEventParameter1&,
IEventParameter2&
setFocus None
setLayoutDistorted unsigned long, unsigned long
show Boolean
showSourceEmphasis Boolean
unhighlight None
ΓòÉΓòÉΓòÉ <hidden> Events - ICheckBox ΓòÉΓòÉΓòÉ
Event Notification ID
buttonClickEvent buttonClickId
commandEvent commandId
gotFocusEvent FOCUSTRUEID
inputDisabledEvent ENABLEFALSEID
inputEnabledEvent ENABLETRUEID
lostFocusEvent FOCUSFALSEID
systemCommandEvent systemCommandId
visibilityDisabledEvent VISIBLEFALSEID
visibilityEnabledEvent VISIBLETRUEID
ΓòÉΓòÉΓòÉ <hidden> General Settings - ICheckBox ΓòÉΓòÉΓòÉ
Subpart name Sets the name of the subpart (a part placed on a composite part).
Default value: The name of the part
Text Sets the text for the part.
Default value: The name of the part
Selected Sets the selection state of the item to selected.
Default value: Not selected
ΓòÉΓòÉΓòÉ <hidden> Control Settings - ICheckBox ΓòÉΓòÉΓòÉ
Fly over short text Specifies the short text for the fly-over text control.
Default value: None
Fly over long text Specifies the long text for the fly-over text control.
Default value: None
Window id Sets the window identifier.
Default value: None
Help panel id Sets the help panel identifier for the part.
Default value: None
Enabled Enables the handler by default.
Default value: Selected
ΓòÉΓòÉΓòÉ <hidden> Styles Settings - ICheckBox ΓòÉΓòÉΓòÉ
defaultStyle() Resets the part to the original default style.
Default value: Selected
autoSelect Lets the user change the current selection by moving the cursor.
Default value: The default is on, and the Default radio button is selected.
noPointerFocus Allows the cursor stay on a control for which information is
required, rather than moving to the button. Buttons with this style do not
set the focus to themselves when the user clicks on them using the mouse.
This has no effect on keyboard interaction.
Default value: The Default radio button is selected.
group Identifies the control as being the first in a group. No other controls
in the group can have this style. Controls in the group must be siblings
that are constructed following the first control. The group can be cursored
and when the last control in the group is reached, the cursor returns the
first control in the group.
Default value: The default is off, and the Default radio button is selected.
tabStop Identifies the control as one to which the user can tab.
Default value: The default is off, and the Default radio button is selected.
clipChildren Excludes the area occupied by the children of the window when
drawing in the window. Child windows are always "clipped" to their parent
window. When a parent window is painted, the clipChildren style controls
whether the invalidated region of the parent window includes the area
occupied by its children, thus preventing a window from painting over its
child windows.
Default value: The Default radio button is selected.
clipSiblings Controls which sibling window is displayed on top when multiple
siblings are displayed. Sibling windows are windows that share the same
parent window. Assign the clipSiblings style to the sibling window that you
want displayed on top of the other siblings, in Z-order.
Default value: The Default radio button is selected.
clipToParent Allows a window to paint outside of its window boundary up to the
window boundary of its parent.
Default value: The Default radio button is selected.
saveBits Optimizes the painting of a window by saving the screen image of the
area under the window as a bitmap and then using the bitmap to redraw the
window, when necessary.
Default value: The Default radio button is selected.
synchPaint Synchronously repaints the window. Without this style, painting
only occurs if there are no other events waiting to be processed.
Default value: The Default radio button is selected.
visible Makes the window visible. In general, controls are constructed as
visible, and frame windows are constructed as invisible.
Default value: The default is on, and the Default radio button is selected.
ΓòÉΓòÉΓòÉ <hidden> Handlers Settings - ICheckBox ΓòÉΓòÉΓòÉ
Handler name Sets the name of the default handler.
Default value: None
Handler list Sets the name of the handler for the MLE control.
Default value: None
Add after Adds the new choice after the selected choice in the list. If no
choice is selected, the new choice is added after the first choice in the
list.
Default value: Highlighted
Add before Adds the new choice before the selected choice in the list. If no
choice is selected, the new choice is added before the first choice in the
list.
Default value: Not highlighted
Move Determines whether a part and its descendants can be moved to a new
location.
Default value: Not highlighted
Remove Removes one item from the part and returns the count of the number of
items that remain.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ <hidden> Color Settings - ICheckBox ΓòÉΓòÉΓòÉ
Color area Sets the color of the given area. Choices are as follows:
Foreground
Sets the color for foreground text
Background
Sets the color for background text
Disabled foreground
Sets the foreground color for disabled text
Highlighted foreground
Sets the foreground color for selected text
Border
Sets the color of the border that surrounds the part.
Default value: Foreground is selected
Color selection Enables color selection by either color values or RGB values.
Select Colors or RGB. If you select Colors, you can set the Color values. If
you select RGB, you can set the RGB values.
Default value: RGB selected
Color values Sets the color value of the window area, or sets the passed
default if no color for the area has been set.
Default value: None
RGB values Sets the color values for the window area.
Default value: Not set
ΓòÉΓòÉΓòÉ <hidden> Size/Position Settings - ICheckBox ΓòÉΓòÉΓòÉ
X field Sets the X coordinate of the part.
Default value: The x coordinate of the part currently positioned on the
free-form surface
Y field Sets the Y coordinate of the point.
Default value: The y coordinate of the part currently positioned on the
free-form surface
Width Sets the width of the text.
Default value: None
Height Sets the height of the text.
Default value: None
Minimum size Determines the minimum size of the part.
Select Calculate at execution time or Set value here. If you select
Calculate at execution time, the minimum size is determined dynamically. If
you select Set value here, you can set the Minimum size Width and Height
fields to define a fixed minimum size.
Default value: Calculate at execution time is selected
Width Sets the minimum-allowable width, which is set by the user's class.
Default value: None (calculated at execution time)
Height Sets the minimum-allowable height, which is set by the user's class.
Default value: None (calculated at execution time)
ΓòÉΓòÉΓòÉ <hidden> Font Settings - ICheckBox ΓòÉΓòÉΓòÉ
Name Sets the name of the font.
Default value: System proportional
Point size Sets the point size of the font.
Default value: 10
Style Sets the style for the part.
Default value: None
Emphasis Gives the part emphasis. If a part is specified, the emphasis is
drawn around the part.
Default value: None
Edit Opens an edit field on a part or setting.
Default value: Highlighted
Default font Sets the current default font style.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ 3.5. ICircularSlider ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Events
Settings Pages
General
Control
Styles
Handlers
Size/Position
Font
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - ICircularSlider ΓòÉΓòÉΓòÉ
Title: IBM circular slider control
Class name: ICircularSlider
Base part: ITextControl
Part type: Visual part
Part file: vbbase.vbb
An ICircularSlider part shows a range of selection values. A circular dial
represents the range of values. A slider arm marks the selected value.
The user moves the arm around the dial to change the selected value. The user
can move the arm in any of the following ways:
Drag it with the mouse.
Click or press a slider button to move the arm in the direction indicated
on the button. This moves the arm by rotation increments defined for the
slider.
Click on a tick mark representing a value in the slider range to move the
arm directly to the tick mark.
Use an ICircularSlider part to provide a range of seemingly nondiscrete
selection values, such as degrees of brightness or loudness.
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - ICircularSlider ΓòÉΓòÉΓòÉ
When building with an ICircularSlider part, you can do the following:
Define the value scale for the circular slider. Do this as follows:
- Define the value range for the circular slider. Do this by entering
Arm Range values in the Lower and Upper fields on the
ICircularSlider General settings page.
- Determine the rotation increment for arm movement. Do this by
entering an increment value in the Rotation increment field on the
ICircularSlider General settings page.
Define an initial value for the circular slider. Do this by entering a
value in the Current value field on the ICircularSlider General settings
page. The arm is initially positioned at this value.
Provide the selected value to an attribute in another part or to an
action parameter. Do this by connecting the ICircularSlider value
attribute to the target attribute or action connection parameter.
ΓòÉΓòÉΓòÉ <hidden> Attributes - ICircularSlider ΓòÉΓòÉΓòÉ
Attribute S E Data type
activeColor Γûá Γûá IColor
armRange Γûá IRange
asDebugInfo IString
asString IString
autoDeleteObject Γûá Boolean
autoDestroyWindow Γûá Boolean
backgroundColor Γûá Γûá IColor
bidiSupported Boolean
borderColor Γûá Γûá IColor
characterSize ISize
clipboardHasTextFormat Boolean
defaultPushButton IWindowHandle
disabledBackgroundColor Γûá Γûá IColor
disabledForegroundColor Γûá Γûá IColor
displaySize ISize
enabled Γûá Γûá Boolean
enabledForNotification Γûá Boolean
focus Γûá Boolean
font Γûá Γûá IFont
foregroundColor Γûá Γûá IColor
frameWindow Boolean
group Γûá Boolean
handle IWindowHandle
hiliteBackgroundColor Γûá Γûá IColor
hiliteForegroundColor Γûá Γûá IColor
id Γûá unsigned long
inactiveColor Γûá Γûá IColor
isDigits Γûá
itemProvider Γûá IDMItemProvider*
layoutAdjustment IRectangle
menu
messageQueue IMessageQueueHandle
minimumSize Γûá ISize
nativeRect IRectangle
owner Γûá IWindow*
parent Γûá IWindow*
parentSize ISize
pointerCaptured Boolean
position Γûá Γûá IPoint
presSpace IPresSpaceHandle
radius unsigned long
rect Γûá IRectangle
rotationIncrement Γûá unsigned long
shadowColor Γûá Γûá IColor
showing Boolean
size Γûá Γûá ISize
tabStop Γûá Boolean
text Γûá Γûá IString
textLength Γûá unsigned long
tickSpacing Γûá unsigned long
valid Boolean
value Γûá Γûá long
valueAsDouble Γûá Γûá
valueAsInt Γûá Γûá
valueAsUnsigned Γûá Γûá
visible Γûá Γûá Boolean
visibleRectangle IRectangle
ΓòÉΓòÉΓòÉ <hidden> Actions - ICircularSlider ΓòÉΓòÉΓòÉ
Action Parameters
applyBidiSettings BidiSettings&, Boolean, Boolean
capturePointer Boolean
convertToGUIStyle IBitFlag&, Boolean
disable None
disableGroup None
disableNotification None
disableTabStop None
disableUpdate None
dispatchRemainingHandlers IEvent&, Boolean
enable Boolean
enableUpdate Boolean
handleException IException&, IEvent&
hide None
hideSourceEmphasis None
isLayoutDistorted unsigned long
matchForMnemonic unsigned short
notifyObservers INotificationEvent&
positionBehindSibling IWindowHandle&
positionBehindSiblings None
positionOnSiblings None
postEvent unsigned long, IEventParameter1&,
IEventParameter2&
refresh IRectangle&
releasePointer None
releasePresSpace IPresSpaceHandle&
resetActiveColor None
resetBackgroundColor None
resetBorderColor None
resetDisabledBackgroundColor None
resetDisabledForegroundColor None
resetFont None
resetForegroundColor None
resetHiliteBackgroundColor None
resetHiliteForegroundColor None
resetInactiveColor None
resetMinimumSize None
resetShadowColor None
sendEvent unsigned long, IEventParameter1&,
IEventParameter2&
setDecrementBitmaps IBitmapHandle&, IBitmapHandle&
setFocus None
setIncrementBitmaps IResourceId&, IResourceId&
setLayoutDistorted unsigned long, unsigned long
show Boolean
showSourceEmphasis Boolean
ΓòÉΓòÉΓòÉ <hidden> Events - ICircularSlider ΓòÉΓòÉΓòÉ
Event Notification ID
commandEvent commandId
gotFocusEvent FOCUSTRUEID
inputDisabledEvent ENABLEFALSEID
inputEnabledEvent ENABLETRUEID
lostFocusEvent FOCUSFALSEID
systemCommandEvent systemCommandId
visibilityDisabledEvent VISIBLEFALSEID
visibilityEnabledEvent VISIBLETRUEID
ΓòÉΓòÉΓòÉ <hidden> General Settings - ICircularSlider ΓòÉΓòÉΓòÉ
Subpart name Sets the name of the subpart (a part placed on a composite part).
Default value: The name of the part
Lower Sets the lower range of the slider dial.
Default value: 0
Upper Sets the higher range of the slider dial.
Default value: 0
Rotation increment Sets the incremental value by which the user can rotate the
dial by turning it with the mouse.
Default value: 1
Current value Sets the current incremental value by which the user can rotate
the dial.
Default value: 15
ΓòÉΓòÉΓòÉ <hidden> Control Settings - ICircularSlider ΓòÉΓòÉΓòÉ
Fly over short text Specifies the short text for the fly-over text control.
Default value: None
Fly over long text Specifies the long text for the fly-over text control.
Default value: None
Window id Sets the window identifier.
Default value: None
Help panel id Sets the help panel identifier for the part.
Default value: None
Enabled Enables the handler by default.
Default value: Selected
ΓòÉΓòÉΓòÉ <hidden> Styles Settings - ICircularSlider ΓòÉΓòÉΓòÉ
defaultStyle() Resets the part to the original default style.
Default value: Selected
buttons Sets the the style for the circular slider buttons.
Default value: The Default radio button is selected.
displayValue Displays the currently selected value on the dial for the part.
Default value: The Default radio button is selected.
jumpToPointer Sets the value to the point you select on the dial by clicking
on it.
Default value: The Default radio button is selected.
full360 Sets the dial so the user can turn it up to 360 degrees.
Default value: The Default radio button is selected.
midpoint Displays a mark at the midpoint on the dial.
Default value: The Default radio button is selected.
proportionalTicks Sets the tick marks to be porportional to the values
possible on the dial.
Default value: The Default radio button is selected.
noTicks Does not display tick marks on the dial.
Default value: The Default radio button is selected.
circularArm Sets the indicator to appear as a dial.
Default value: The Default radio button is selected.
group Identifies the control as being the first in a group. No other controls
in the group can have this style. Controls in the group must be siblings
that are constructed following the first control. The group can be cursored
and when the last control in the group is reached, the cursor returns the
first control in the group.
Default value: The default is off, and the Default radio button is selected.
tabStop Identifies the control as one to which the user can tab.
Default value: The default is off, and the Default radio button is selected.
clipChildren Excludes the area occupied by the children of the window when
drawing in the window. Child windows are always "clipped" to their parent
window. When a parent window is painted, the clipChildren style controls
whether the invalidated region of the parent window includes the area
occupied by its children, thus preventing a window from painting over its
child windows.
Default value: The Default radio button is selected.
clipSiblings Controls which sibling window is displayed on top when multiple
siblings are displayed. Sibling windows are windows that share the same
parent window. Assign the clipSiblings style to the sibling window that you
want displayed on top of the other siblings, in Z-order.
Default value: The Default radio button is selected.
clipToParent Allows a window to paint outside of its window boundary up to the
window boundary of its parent.
Default value: The Default radio button is selected.
saveBits Optimizes the painting of a window by saving the screen image of the
area under the window as a bitmap and then using the bitmap to redraw the
window, when necessary.
Default value: The Default radio button is selected.
synchPaint Synchronously repaints the window. Without this style, painting
only occurs if there are no other events waiting to be processed.
Default value: The Default radio button is selected.
visible Makes the window visible. In general, controls are constructed as
visible, and frame windows are constructed as invisible.
Default value: The default is on, and the Default radio button is selected.
ΓòÉΓòÉΓòÉ <hidden> Handlers Settings - ICircularSlider ΓòÉΓòÉΓòÉ
Handler name Sets the name of the default handler.
Default value: None
Handler list Sets the name of the handler for the MLE control.
Default value: None
Add after Adds the new choice after the selected choice in the list. If no
choice is selected, the new choice is added after the first choice in the
list.
Default value: Highlighted
Add before Adds the new choice before the selected choice in the list. If no
choice is selected, the new choice is added before the first choice in the
list.
Default value: Not highlighted
Move Determines whether a part and its descendants can be moved to a new
location.
Default value: Not highlighted
Remove Removes one item from the part and returns the count of the number of
items that remain.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ <hidden> Size/Position Settings - ICircularSlider ΓòÉΓòÉΓòÉ
X field Sets the X coordinate of the part.
Default value: The x coordinate of the part currently positioned on the
free-form surface
Y field Sets the Y coordinate of the point.
Default value: The y coordinate of the part currently positioned on the
free-form surface
Width Sets the width of the text.
Default value: None
Height Sets the height of the text.
Default value: None
Minimum size Determines the minimum size of the part.
Select Calculate at execution time or Set value here. If you select
Calculate at execution time, the minimum size is determined dynamically. If
you select Set value here, you can set the Minimum size Width and Height
fields to define a fixed minimum size.
Default value: Calculate at execution time is selected
Width Sets the minimum-allowable width, which is set by the user's class.
Default value: None (calculated at execution time)
Height Sets the minimum-allowable height, which is set by the user's class.
Default value: None (calculated at execution time)
ΓòÉΓòÉΓòÉ <hidden> Font Settings - ICircularSlider ΓòÉΓòÉΓòÉ
Name Sets the name of the font.
Default value: System proportional
Point size Sets the point size of the font.
Default value: 10
Style Sets the style for the part.
Default value: None
Emphasis Gives the part emphasis. If a part is specified, the emphasis is
drawn around the part.
Default value: None
Edit Opens an edit field on a part or setting.
Default value: Highlighted
Default font Sets the current default font style.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ 3.6. ICollectionViewComboBox ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Events
Settings Pages
General
Control
Styles
Handlers
Color
Size/Position
Font
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - ICollectionViewComboBox ΓòÉΓòÉΓòÉ
Title: IBM collection combination-box control
Class name: ICollectionViewComboBox
Base part: IBaseComboBox
Part type: Visual part
Part file: vbbase.vbb
An ICollectionViewComboBox part is a selection list and entry field for
collection object choices.
With an ICollectionViewComboBox, the user can select an object from the list
box. Unless you prevent input in the entry field, the user can also do either
of the following:
Type the beginning of a selection that is in the list. The closest match
from the list is used.
Type a selection that is not in the list.
If you define the combination box as a drop-down or read-only drop-down type,
the user does not initially see the list box but can click a drop-down button
to open it.
Use one of the following ICollectionViewComboBox types to give the user object
selection choices:
Drop-down Allows the user to type a choice or to select a choice from a
drop-down list.
Read-only drop-down Allows the user only to select a choice from a drop-down
list.
Simple Allows the user to type a choice or to select a choice from a list that
is always displayed.
Alternatively, for object selection only from a list that is always displayed,
use an ICollectionViewListBox part. You can provide either single or multiple
selection with a list box part.
For selection of strings rather than objects in a collection, use an IComboBox
part or an IListBox part.
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - ICollectionViewComboBox ΓòÉΓòÉΓòÉ
When building with an ICollectionViewComboBox part, you can do the following:
Select a collection object combination box type. Do this by selecting one
of the following choices in the Combo box type field on the
ICollectionViewComboBox General settings page:
- Simple for a combination box with the list always open
- Drop-down for a drop-down combination box with an editable entry
field
- Read-only drop-down for a drop-down combination box with a read-only
entry field
Define the type of object supported by the combination box. Do this by
entering a pointer to the part type (part type and *) in the Item type
field on the ICollectionViewComboBox General settings page.
Define the type of collection containing the objects. The collection type
is defined by the Collection type field on the ICollectionViewComboBox
General settings page. The default collection type is IVSequence. If you
are providing support for another collection type that you want to use,
enter the type in this field. The vbcc.vbb data file contains examples of
other collection types you could use.
Identify a function or class that provides strings for list items. Do
this in either of the following ways:
- Provide an asString override function that produces the text you
want for the collection object class. The function could retrieve
and return a key text attribute for the object.
- Provide a string generator class that produces the text you want for
the collection object class. The string generator could retrieve and
return a key text attribute for the object. The generator class must
be derived from the collection object class and must be a template
class.
If you use a string generator, enter the name of the generator class
in the String generator field on the ICollectionViewComboBox General
settings page. If this field is left empty, the default string
generator calls asString for each collection object.
Define initial selection choices for the combination box. Do this by
connecting the this attribute of a collection part containing the choices
to the ICollectionViewComboBox items attribute. A collection part that
has one template argument, such as an IVSequence part, must be used.
Define a default selection for the combination box. Do this by specifying
the 1-based index of the selection in the Selection index field on the
ICollectionViewComboBox General settings page. The corresponding choice
in the collection part is the default selection.
Allow the user to reach the combination box by using a tab key. Do this
by setting the tabStop field to On on the ICollectionViewComboBox Styles
settings page.
Copy the text selection from the combination box to an entry field. Do
this by connecting the ICollectionViewComboBox text attribute to the text
attribute of the IEntryField.
Copy the index of the selection to a numeric field. Do this by connecting
the ICollectionViewComboBox selection attribute to the target numeric
field.
Add a new choice to the combination box list. Do this by adding the
choice to the collection part that contains the choices.
Remove the selected choice from combination box list. Do this by removing
the choice from the collection part that contains the choices.
ΓòÉΓòÉΓòÉ <hidden> Attributes - ICollectionViewComboBox ΓòÉΓòÉΓòÉ
Attribute S E Data type
activeColor Γûá Γûá IColor
asDebugInfo IString
asString IString
autoDeleteObject Γûá Boolean
autoDestroyWindow Γûá Boolean
autoScroll Γûá Boolean
autoTab Γûá Boolean
backgroundColor Γûá Γûá IColor
bidiSupported Boolean
borderColor Γûá Γûá IColor
changed Boolean
characterSize ISize
charType Γûá CharType
clipboardHasTextFormat Boolean
command Γûá Γûá Boolean
count unsigned long
cursorPosition Γûá unsigned long
defaultPushButton IWindowHandle
disabledBackgroundColor Γûá Γûá IColor
disabledForegroundColor Γûá Γûá IColor
displaySize ISize
empty Boolean
enabled Γûá Γûá Boolean
enabledForNotification Γûá Boolean
focus Γûá Boolean
font Γûá Γûá IFont
foregroundColor Γûá Γûá IColor
frameWindow Boolean
group Γûá Boolean
handle IWindowHandle
hasSelectedText Boolean
hiliteBackgroundColor Γûá Γûá IColor
hiliteForegroundColor Γûá Γûá IColor
horizontalScroll Boolean
id Γûá unsigned long
inactiveColor Γûá Γûá IColor
insertMode Γûá Γûá Boolean
isDigits Γûá
itemProvider Γûá IDMItemProvider*
items Γûá Γûá Collection*
layoutAdjustment IRectangle
leftIndex Γûá unsigned long
limit Γûá Γûá unsigned long
listShowing Boolean
margin Γûá Boolean
menu
messageQueue IMessageQueueHandle
minimumRows Γûá unsigned long
minimumSize Γûá ISize
nativeRect IRectangle
numberOfSelections unsigned long
owner Γûá IWindow*
parent Γûá IWindow*
parentSize ISize
pointerCaptured Boolean
position Γûá Γûá IPoint
presSpace IPresSpaceHandle
readOnly Boolean
rect Γûá IRectangle
selectedCollectionPosition unsigned long
selectedElement Element
selectedRange IRange
selectedText IString
selectedTextLength unsigned long
selection long
shadowColor Γûá Γûá IColor
showing Boolean
size Γûá Γûá ISize
stringGenerator Γûá IStringGenerator < Element >&
tabStop Γûá Boolean
text Γûá Γûá IString
textLength Γûá unsigned long
top Γûá unsigned long
type ControlType
valid Boolean
valueAsDouble Γûá Γûá
valueAsInt Γûá Γûá
valueAsUnsigned Γûá Γûá
visible Γûá Γûá Boolean
visibleRectangle IRectangle
writeable Γûá Γûá Boolean
ΓòÉΓòÉΓòÉ <hidden> Actions - ICollectionViewComboBox ΓòÉΓòÉΓòÉ
Action Parameters
applyBidiSettings BidiSettings&, Boolean, Boolean
capturePointer Boolean
clear unsigned long
collectionReplaced None
convertToGUIStyle IBitFlag&, Boolean
copy unsigned long
cut unsigned long
deselect unsigned long
deselectAll None
disable None
disableAutoScroll None
disableAutoTab None
disableCommand None
disableDataUpdate None
disableGroup None
disableInsertMode None
disableMargin None
disableNotification None
disableTabStop None
disableUpdate None
discard None
dispatchRemainingHandlers IEvent&, Boolean
elementAdded unsigned long, Element&
elementChanged unsigned long, Element&
elementDeleted unsigned long
elementsChanged None
enable Boolean
enableUpdate Boolean
handleException IException&, IEvent&
hide None
hideList None
hideSourceEmphasis None
isLayoutDistorted unsigned long
isSelected unsigned long
itemHandle unsigned long
itemText unsigned long
locateText char*, Boolean, SearchType, unsigned long
matchForMnemonic unsigned short
notifyObservers INotificationEvent&
paste None
positionBehindSibling IWindowHandle&
positionBehindSiblings None
positionOnSiblings None
postEvent unsigned long, IEventParameter1&,
IEventParameter2&
refresh IRectangle&
releasePointer None
releasePresSpace IPresSpaceHandle&
removeAll None
resetActiveColor None
resetBackgroundColor None
resetBorderColor None
resetDisabledBackgroundColor None
resetDisabledForegroundColor None
resetFont None
resetForegroundColor None
resetHiliteBackgroundColor None
resetHiliteForegroundColor None
resetInactiveColor None
resetMinimumSize None
resetShadowColor None
select unsigned long, Boolean
selectRange const IRange &range, unsigned long
sendEvent unsigned long, IEventParameter1&,
IEventParameter2&
setChangedFlag Boolean
setFocus None
setItemHandle unsigned long, unsigned long
setItemText unsigned long, char*, Boolean
setLayoutDistorted unsigned long, unsigned long
show Boolean
showList Boolean
showSourceEmphasis Boolean
ΓòÉΓòÉΓòÉ <hidden> Events - ICollectionViewComboBox ΓòÉΓòÉΓòÉ
Event Notification ID
characterTypeEvent characterTypeId
commandEvent commandId
enterEvent enterId
gotFocusEvent FOCUSTRUEID
inputDisabledEvent ENABLEFALSEID
inputEnabledEvent ENABLETRUEID
itemChangedEvent itemChangedId
lostFocusEvent FOCUSFALSEID
systemCommandEvent systemCommandId
visibilityDisabledEvent VISIBLEFALSEID
visibilityEnabledEvent VISIBLETRUEID
ΓòÉΓòÉΓòÉ <hidden> General Settings - ICollectionViewComboBox ΓòÉΓòÉΓòÉ
Subpart name Sets the name of the subpart (a part placed on a composite part).
Default value: The name of the part
Item type Specifies the part type of objects in the collection.
Default value: None
Collection type Specifies the part type of the collection.
Default value: IVSequence*
String generator Specifies the name of a string generator class that produces
text to represent objects in the collection.
Default value: None
Auto scroll Enables automatic scrolling for the part.
Default value: Not selected
Margin Draws a border around the entry field, with a margin between the border
and the entry field. For a canvas, the margin width and height are returned,
which is the space between the edge of the canvas and the outermost child
windows.
Default value: Not selected
Auto tab Generates a tab key when the part is filled by adding a character at
the text limit of the part text.
Default value: Not selected
Insert mode Sets insert mode to on.
Default value: Selected
Limit Sets the length (in bytes) of the longest text the part can hold.
Default value: 260
Combo box type Sets the behavior of the combination box, which can be one of
the following:
Simple
Specifies that the entry field and list box controls are visible.
When the selection changes in the list box control, the text of the
selected item in the list box control is placed in the entry field.
You can also select an item from the list box control by entering
part of the item into the entry field. The entry is completed with
the closest match from the list box.
Drop-down
Specifies the drop-down variation of the combination box. The list
box control is hidden until the user requests that it be displayed.
Read-only drop-down
Specifies the drop-down list variation of the combination box. The
drop-down list only displays one item in the entry field until the
user displays the list box control to make alternative selections
from the list box. The user cannot enter information into the entry
field portion of the drop-down list. The entry field control is
replaced by a static control that displays the current selection from
the list box.
Default value: Square
Character type Sets the type of a character at a given index.
Default value: Any
ΓòÉΓòÉΓòÉ <hidden> Control Settings - ICollectionViewComboBox ΓòÉΓòÉΓòÉ
Fly over short text Specifies the short text for the fly-over text control.
Default value: None
Fly over long text Specifies the long text for the fly-over text control.
Default value: None
Window id Sets the window identifier.
Default value: None
Help panel id Sets the help panel identifier for the part.
Default value: None
Enabled Enables the handler by default.
Default value: Selected
ΓòÉΓòÉΓòÉ <hidden> Styles Settings - ICollectionViewComboBox ΓòÉΓòÉΓòÉ
defaultStyle() Resets the part to the original default style.
Default value: Selected
horizontalScroll Provides a horizontal scroll bar for the part.
Default value: The default is on, and the Default radio button is selected.
group Identifies the control as being the first in a group. No other controls
in the group can have this style. Controls in the group must be siblings
that are constructed following the first control. The group can be cursored
and when the last control in the group is reached, the cursor returns the
first control in the group.
Default value: The default is off, and the Default radio button is selected.
tabStop Identifies the control as one to which the user can tab.
Default value: The default is off, and the Default radio button is selected.
clipChildren Excludes the area occupied by the children of the window when
drawing in the window. Child windows are always "clipped" to their parent
window. When a parent window is painted, the clipChildren style controls
whether the invalidated region of the parent window includes the area
occupied by its children, thus preventing a window from painting over its
child windows.
Default value: The Default radio button is selected.
clipSiblings Controls which sibling window is displayed on top when multiple
siblings are displayed. Sibling windows are windows that share the same
parent window. Assign the clipSiblings style to the sibling window that you
want displayed on top of the other siblings, in Z-order.
Default value: The Default radio button is selected.
clipToParent Allows a window to paint outside of its window boundary up to the
window boundary of its parent.
Default value: The Default radio button is selected.
saveBits Optimizes the painting of a window by saving the screen image of the
area under the window as a bitmap and then using the bitmap to redraw the
window, when necessary.
Default value: The Default radio button is selected.
synchPaint Synchronously repaints the window. Without this style, painting
only occurs if there are no other events waiting to be processed.
Default value: The Default radio button is selected.
visible Makes the window visible. In general, controls are constructed as
visible, and frame windows are constructed as invisible.
Default value: The default is on, and the Default radio button is selected.
ΓòÉΓòÉΓòÉ <hidden> Handlers Settings - ICollectionViewComboBox ΓòÉΓòÉΓòÉ
Handler name Sets the name of the default handler.
Default value: None
Handler list Sets the name of the handler for the MLE control.
Default value: None
Add after Adds the new choice after the selected choice in the list. If no
choice is selected, the new choice is added after the first choice in the
list.
Default value: Highlighted
Add before Adds the new choice before the selected choice in the list. If no
choice is selected, the new choice is added before the first choice in the
list.
Default value: Not highlighted
Move Determines whether a part and its descendants can be moved to a new
location.
Default value: Not highlighted
Remove Removes one item from the part and returns the count of the number of
items that remain.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ <hidden> Color Settings - ICollectionViewComboBox ΓòÉΓòÉΓòÉ
Color area Sets the color of the given area. Choices are as follows:
Foreground
Sets the color for foreground text
Background
Sets the color for background text
Disabled foreground
Sets the foreground color for disabled text
Highlighted foreground
Sets the foreground color for selected text
Border
Sets the color of the border that surrounds the part.
Default value: Foreground is selected
Color selection Enables color selection by either color values or RGB values.
Select Colors or RGB. If you select Colors, you can set the Color values. If
you select RGB, you can set the RGB values.
Default value: RGB selected
Color values Sets the color value of the window area, or sets the passed
default if no color for the area has been set.
Default value: None
RGB values Sets the color values for the window area.
Default value: Not set
ΓòÉΓòÉΓòÉ <hidden> Size/Position Settings - ICollectionViewComboBox ΓòÉΓòÉΓòÉ
X field Sets the X coordinate of the part.
Default value: The x coordinate of the part currently positioned on the
free-form surface
Y field Sets the Y coordinate of the point.
Default value: The y coordinate of the part currently positioned on the
free-form surface
Width Sets the width of the text.
Default value: None
Height Sets the height of the text.
Default value: None
Minimum size Determines the minimum size of the part.
Select Calculate at execution time or Set value here. If you select
Calculate at execution time, the minimum size is determined dynamically. If
you select Set value here, you can set the Minimum size Width and Height
fields to define a fixed minimum size.
Default value: Calculate at execution time is selected
Width Sets the minimum-allowable width, which is set by the user's class.
Default value: None (calculated at execution time)
Height Sets the minimum-allowable height, which is set by the user's class.
Default value: None (calculated at execution time)
ΓòÉΓòÉΓòÉ <hidden> Font Settings - ICollectionViewComboBox ΓòÉΓòÉΓòÉ
Name Sets the name of the font.
Default value: System proportional
Point size Sets the point size of the font.
Default value: 10
Style Sets the style for the part.
Default value: None
Emphasis Gives the part emphasis. If a part is specified, the emphasis is
drawn around the part.
Default value: None
Edit Opens an edit field on a part or setting.
Default value: Highlighted
Default font Sets the current default font style.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ 3.7. ICollectionViewListBox ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Events
Settings Pages
General
Control
Styles
Handlers
Color
Size/Position
Font
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - ICollectionViewListBox ΓòÉΓòÉΓòÉ
Title: ICollectionViewListBox
Class name: ICollectionViewListBox
Base part: IBaseListBox
Part type: Visual part
Part file: vbbase.vbb
An ICollectionViewListBox part is a selection list for collection object
choices.
By default, the user can select only one choice from the list. When the user
selects a choice, any previously selected choice is no longer selected. You
can change the behavior of the list box to allow multiple selection.
Use an ICollectionViewListBox part to provide a modifiable list of object
choices for the user. Your application can add or remove choices from the
list.
Alternatively, for object selection from an entry field or a drop-down list,
use one of the following ICollectionViewComboBox types:
Drop-down Allows the user to type a choice or to select a choice from a
drop-down list.
Read-only drop-down Allows the user only to select a choice from a drop-down
list.
Simple Allows the user to type a choice or to select a choice from a list that
is always displayed.
You can provide only single selection with a combination box part.
For selection of strings rather than objects in a collection, use an IComboBox
part or an IListBox part.
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - ICollectionViewListBox ΓòÉΓòÉΓòÉ
When building with an ICollectionViewListBox part, you can do the following:
Define the type of object supported by the list box. Do this by entering
a pointer to the part type (part type and *) in the Item type field on
the ICollectionViewListBox General settings page.
Define the type of collection containing the objects. The collection type
is defined by the Collection type field on the ICollectionViewListBox
General settings page. The default collection type is IVSequence. If you
are providing support for another collection type that you want to use,
enter the type in this field. The vbcc.vbb data file contains examples of
other collection types you could use.
Identify a function or class that provides strings for list items. Do
this in either of the following ways:
- Provide an asString override function that produces the text you
want for the collection object class. The function could retrieve
and return a key text attribute for the object.
- Provide a string generator class that produces the text you want for
the collection object class. The string generator could retrieve and
return a key text attribute for the object. The generator class must
be derived from the collection object class and must be a template
class.
If you use a string generator, enter the name of the generator class
in the String generator field on the ICollectionViewListBox General
settings page. If this field is left empty, the default string
generator calls asString for each collection object.
Define initial selection choices for the list box. Do this by connecting
the this attribute of a collection part containing the choices to the
ICollectionViewListBox items attribute. A collection part that has one
template argument, such as an IVSequence part, must be used.
Allow the user to select more than one choice from the list. Do this by
selecting the multipleSelection field on the ICollectionViewListBox
Styles settings page.
Allow the user to reach the list box by using a tab key. Do this by
setting the tabStop field to On on the ICollectionViewListBox Styles
settings page.
Copy the selected object from the list box to an IVBVariable. Do this by
connecting the ICollectionViewListBox selectedElement attribute to the
text attribute of the variable.
Copy the index of the selection to a numeric field. Do this by connecting
the ICollectionViewListBox selection attribute to the target numeric
field.
Add a new choice to the list box. Do this by adding the choice to the
collection part that contains the choices.
Remove the selected choice from the list box. Do this by removing the
choice from the collection part that contains the choices.
ΓòÉΓòÉΓòÉ <hidden> Attributes - ICollectionViewListBox ΓòÉΓòÉΓòÉ
Attribute S E Data type
activeColor Γûá Γûá IColor
asDebugInfo IString
asString IString
autoDeleteObject Γûá Boolean
autoDestroyWindow Γûá Boolean
backgroundColor Γûá Γûá IColor
bidiSupported Boolean
borderColor Γûá Γûá IColor
characterSize ISize
count unsigned long
defaultPushButton IWindowHandle
disabledBackgroundColor Γûá Γûá IColor
disabledForegroundColor Γûá Γûá IColor
drawItem Γûá Boolean
empty Boolean
enabled Γûá Γûá Boolean
enabledForNotification Γûá Boolean
extendedSelect Γûá Boolean
focus Γûá Boolean
font Γûá Γûá IFont
foregroundColor Γûá Γûá IColor
frameWindow Boolean
group Γûá Boolean
handle IWindowHandle
hiliteBackgroundColor Γûá Γûá IColor
hiliteForegroundColor Γûá Γûá IColor
horizontalScroll Boolean
id Γûá unsigned long
inactiveColor Γûá Γûá IColor
itemProvider Γûá IDMItemProvider*
items Γûá Γûá Collection*
layoutAdjustment IRectangle
menu
messageQueue IMessageQueueHandle
minimumCharacters Γûá unsigned long
minimumRows Γûá unsigned long
minimumSize Γûá ISize
multipleSelect Γûá Boolean
nativeRect IRectangle
noAdjustPosition Γûá Boolean
numberOfSelections unsigned long
owner Γûá IWindow*
parent Γûá IWindow*
parentSize ISize
pointerCaptured Boolean
position Γûá Γûá IPoint
presSpace IPresSpaceHandle
rect Γûá IRectangle
selectedCollectionPosition unsigned long
selectedElement Element
selection long
shadowColor Γûá Γûá IColor
showing Boolean
size Γûá Γûá ISize
stringGenerator Γûá IStringGenerator < Element >&
tabStop Γûá Boolean
top Γûá unsigned long
valid Boolean
visible Γûá Γûá Boolean
visibleRectangle IRectangle
ΓòÉΓòÉΓòÉ <hidden> Actions - ICollectionViewListBox ΓòÉΓòÉΓòÉ
Action Parameters
applyBidiSettings BidiSettings&, Boolean, Boolean
capturePointer Boolean
collectionReplaced None
convertToGUIStyle IBitFlag&, Boolean
deselect unsigned long
deselectAll None
disable None
disableDrawItem None
disableExtendedSelect None
disableGroup None
disableMultipleSelect None
disableNoAdjustPosition None
disableNotification None
disableTabStop None
disableUpdate None
dispatchRemainingHandlers IEvent&, Boolean
elementAdded unsigned long, Element&
elementChanged unsigned long, Element&
elementDeleted unsigned long
elementsChanged None
enable Boolean
enableUpdate Boolean
handleException IException&, IEvent&
hide None
hideSourceEmphasis None
isLayoutDistorted unsigned long
isSelected unsigned long
itemHandle unsigned long
itemText unsigned long
locateText char*, Boolean, SearchType, unsigned long
matchForMnemonic unsigned short
notifyObservers INotificationEvent&
positionBehindSibling IWindowHandle&
positionBehindSiblings None
positionOnSiblings None
postEvent unsigned long, IEventParameter1&,
IEventParameter2&
refresh IRectangle&
releasePointer None
releasePresSpace IPresSpaceHandle&
resetActiveColor None
resetBackgroundColor None
resetBorderColor None
resetDisabledBackgroundColor None
resetDisabledForegroundColor None
resetFont None
resetForegroundColor None
resetHiliteBackgroundColor None
resetHiliteForegroundColor None
resetInactiveColor None
resetMinimumSize None
resetShadowColor None
select unsigned long, Boolean
selectAll None
selectedElements Collection&
sendEvent unsigned long, IEventParameter1&,
IEventParameter2&
setFocus None
setItemHandle unsigned long, unsigned long
setItemHeight unsigned long
setItemText unsigned long, IResourceId&
setLayoutDistorted unsigned long, unsigned long
show Boolean
showSourceEmphasis Boolean
ΓòÉΓòÉΓòÉ <hidden> Events - ICollectionViewListBox ΓòÉΓòÉΓòÉ
Event Notification ID
commandEvent commandId
enterEvent enterId
extendedSelectChangedEvent extendedSelectChangedId
gotFocusEvent FOCUSTRUEID
inputDisabledEvent ENABLEFALSEID
inputEnabledEvent ENABLETRUEID
itemChangedEvent itemChangedId
lostFocusEvent FOCUSFALSEID
systemCommandEvent systemCommandId
visibilityDisabledEvent VISIBLEFALSEID
visibilityEnabledEvent VISIBLETRUEID
ΓòÉΓòÉΓòÉ <hidden> General Settings - ICollectionViewListBox ΓòÉΓòÉΓòÉ
Subpart name Sets the name of the subpart (a part placed on a composite part).
Default value: The name of the part
Item type Specifies the part type of objects in the collection.
Default value: None
Collection type Specifies the part type of the collection.
Default value: IVSequence*
String generator Specifies the name of a string generator class that produces
text to represent objects in the collection.
Default value: None
ΓòÉΓòÉΓòÉ <hidden> Control Settings - ICollectionViewListBox ΓòÉΓòÉΓòÉ
Fly over short text Specifies the short text for the fly-over text control.
Default value: None
Fly over long text Specifies the long text for the fly-over text control.
Default value: None
Window id Sets the window identifier.
Default value: None
Help panel id Sets the help panel identifier for the part.
Default value: None
Enabled Enables the handler by default.
Default value: Selected
ΓòÉΓòÉΓòÉ <hidden> Styles Settings - ICollectionViewListBox ΓòÉΓòÉΓòÉ
defaultStyle() Resets the part to the original default style.
Default value: Selected
Draw item Allows the menu item to be drawn.
Default value: Not selected
horizontalScroll Provides a horizontal scroll bar for the part.
Default value: The default is on, and the Default radio button is selected.
multipleSelect Sets the style of the part to multiple selection mode.
Default value: The default is off, and the Default radio button is selected.
noAdjustPosition Restricts adjustment of the frame position of the part. As a
result, certain aspects of enhanced performance by such alignment are lost.
Default value: The default is on, and the Default radio button is selected.
group Identifies the control as being the first in a group. No other controls
in the group can have this style. Controls in the group must be siblings
that are constructed following the first control. The group can be cursored
and when the last control in the group is reached, the cursor returns the
first control in the group.
Default value: The default is off, and the Default radio button is selected.
tabStop Identifies the control as one to which the user can tab.
Default value: The default is off, and the Default radio button is selected.
clipChildren Excludes the area occupied by the children of the window when
drawing in the window. Child windows are always "clipped" to their parent
window. When a parent window is painted, the clipChildren style controls
whether the invalidated region of the parent window includes the area
occupied by its children, thus preventing a window from painting over its
child windows.
Default value: The Default radio button is selected.
clipSiblings Controls which sibling window is displayed on top when multiple
siblings are displayed. Sibling windows are windows that share the same
parent window. Assign the clipSiblings style to the sibling window that you
want displayed on top of the other siblings, in Z-order.
Default value: The Default radio button is selected.
clipToParent Allows a window to paint outside of its window boundary up to the
window boundary of its parent.
Default value: The Default radio button is selected.
saveBits Optimizes the painting of a window by saving the screen image of the
area under the window as a bitmap and then using the bitmap to redraw the
window, when necessary.
Default value: The Default radio button is selected.
synchPaint Synchronously repaints the window. Without this style, painting
only occurs if there are no other events waiting to be processed.
Default value: The Default radio button is selected.
visible Makes the window visible. In general, controls are constructed as
visible, and frame windows are constructed as invisible.
Default value: The default is on, and the Default radio button is selected.
ΓòÉΓòÉΓòÉ <hidden> Handlers Settings - ICollectionViewListBox ΓòÉΓòÉΓòÉ
Handler name Sets the name of the default handler.
Default value: None
Handler list Sets the name of the handler for the MLE control.
Default value: None
Add after Adds the new choice after the selected choice in the list. If no
choice is selected, the new choice is added after the first choice in the
list.
Default value: Highlighted
Add before Adds the new choice before the selected choice in the list. If no
choice is selected, the new choice is added before the first choice in the
list.
Default value: Not highlighted
Move Determines whether a part and its descendants can be moved to a new
location.
Default value: Not highlighted
Remove Removes one item from the part and returns the count of the number of
items that remain.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ <hidden> Color Settings - ICollectionViewListBox ΓòÉΓòÉΓòÉ
Color area Sets the color of the given area. Choices are as follows:
Foreground
Sets the color for foreground text
Background
Sets the color for background text
Disabled foreground
Sets the foreground color for disabled text
Highlighted foreground
Sets the foreground color for selected text
Border
Sets the color of the border that surrounds the part.
Default value: Foreground is selected
Color selection Enables color selection by either color values or RGB values.
Select Colors or RGB. If you select Colors, you can set the Color values. If
you select RGB, you can set the RGB values.
Default value: RGB selected
Color values Sets the color value of the window area, or sets the passed
default if no color for the area has been set.
Default value: None
RGB values Sets the color values for the window area.
Default value: Not set
ΓòÉΓòÉΓòÉ <hidden> Size/Position Settings - ICollectionViewListBox ΓòÉΓòÉΓòÉ
X field Sets the X coordinate of the part.
Default value: The x coordinate of the part currently positioned on the
free-form surface
Y field Sets the Y coordinate of the point.
Default value: The y coordinate of the part currently positioned on the
free-form surface
Width Sets the width of the text.
Default value: None
Height Sets the height of the text.
Default value: None
Minimum size Determines the minimum size of the part.
Select Calculate at execution time or Set value here. If you select
Calculate at execution time, the minimum size is determined dynamically. If
you select Set value here, you can set the Minimum size Width and Height
fields to define a fixed minimum size.
Default value: Calculate at execution time is selected
Width Sets the minimum-allowable width, which is set by the user's class.
Default value: None (calculated at execution time)
Height Sets the minimum-allowable height, which is set by the user's class.
Default value: None (calculated at execution time)
ΓòÉΓòÉΓòÉ <hidden> Font Settings - ICollectionViewListBox ΓòÉΓòÉΓòÉ
Name Sets the name of the font.
Default value: System proportional
Point size Sets the point size of the font.
Default value: 10
Style Sets the style for the part.
Default value: None
Emphasis Gives the part emphasis. If a part is specified, the emphasis is
drawn around the part.
Default value: None
Edit Opens an edit field on a part or setting.
Default value: Highlighted
Default font Sets the current default font style.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ 3.8. IComboBox ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Events
Settings Pages
General
Control
Styles
Handlers
Color
Size/Position
Font
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IComboBox ΓòÉΓòÉΓòÉ
Title: IBM string combination-box control
Class name: IComboBox
Base part: IBaseComboBox
Part type: Visual part
Part file: vbbase.vbb
An IComboBox part is a selection list and entry field for string choices.
With an IComboBox, the user can select a string from the list box. Unless you
prevent input in the entry field, the user can also do either of the
following:
Type the beginning of a selection that is in the list. The closest match
from the list is used.
Type a selection that is not in the list.
If you define the combination box as a drop-down or read-only drop-down type,
the user does not initially see the list box, but can click a drop-down button
to open it.
Use one of the following IComboBox types to give the user string selection
choices:
Drop-down Allows the user to type a choice or to select a choice from a
drop-down list.
Read-only drop-down Allows the user only to select a choice from a drop-down
list.
Simple Allows the user to type a choice or to select a choice from a list that
is always displayed.
Alternatively, for string selection only from a list that is always displayed,
use an IListBox part. You can provide either single or multiple selection with
a list box part.
For selection of objects in a collection rather than strings, use an
ICollectionViewComboBox part or an ICollectionViewListBox part.
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - IComboBox ΓòÉΓòÉΓòÉ
When building with an IComboBox part, you can do the following:
Select a string combination box type. Do this by selecting one of the
following choices in the Combo box type field on the IComboBox General
settings page:
- Simple for a combination box with the list always open
- Drop-down for a drop-down combination box with an editable entry
field
- Read-only drop-down for a drop-down combination box with a read-only
entry field
Define initial selection choices for the combination box. Do this by
entering the choices in the Contents field on the IComboBox General
settings page.
Define a default selection for the combination box. Do this by specifying
the 0-based index of the selection in the Selection index field on the
IComboBox General settings page. The corresponding choice in the Contents
field is the default selection.
Allow the user to reach the combination box by using a tab key. Do this
by setting the tabStop field to On on the IComboBox Styles settings page.
Copy the text selection from the combination box to an entry field. Do
this by connecting the IComboBox text attribute to the text attribute of
the IEntryField.
Copy the index of the selection to a numeric field. Do this by connecting
the IComboBox selection attribute to the target numeric field.
Add a new choice to the combination box list from the entry field when a
push button is pressed. Add the choice to the end of the list. Do this as
follows:
1. Connect the IPushButton buttonClickEvent feature to the addAsLast
action of the IComboBox.
2. Connect the IComboBox text attribute to the text parameter of the
buttonClickEvent-to-addAsLast connection. This provides the entry
field text as the parameter for the addAsLast action.
Remove the selected choice from the combination box list when a push
button is pressed. Do this as follows:
1. Connect the IPushButton buttonClickEvent feature to the remove
action of the IComboBox.
2. Connect the IComboBox selection attribute to the index parameter of
the buttonClickEvent-to-remove connection. This provides the
selection index as the parameter for the remove action.
ΓòÉΓòÉΓòÉ <hidden> Attributes - IComboBox ΓòÉΓòÉΓòÉ
Attribute S E Data type
activeColor Γûá Γûá IColor
asDebugInfo IString
asString IString
autoDeleteObject Γûá Boolean
autoDestroyWindow Γûá Boolean
autoScroll Γûá Boolean
autoTab Γûá Boolean
backgroundColor Γûá Γûá IColor
bidiSupported Boolean
borderColor Γûá Γûá IColor
changed Boolean
characterSize ISize
charType Γûá CharType
clipboardHasTextFormat Boolean
command Γûá Γûá Boolean
count unsigned long
cursorPosition Γûá unsigned long
defaultPushButton IWindowHandle
disabledBackgroundColor Γûá Γûá IColor
disabledForegroundColor Γûá Γûá IColor
displaySize ISize
empty Boolean
enabled Γûá Γûá Boolean
enabledForNotification Γûá Boolean
focus Γûá Boolean
font Γûá Γûá IFont
foregroundColor Γûá Γûá IColor
frameWindow Boolean
group Γûá Boolean
handle IWindowHandle
hasSelectedText Boolean
hiliteBackgroundColor Γûá Γûá IColor
hiliteForegroundColor Γûá Γûá IColor
horizontalScroll Boolean
id Γûá unsigned long
inactiveColor Γûá Γûá IColor
insertMode Γûá Γûá Boolean
isDigits Γûá
itemProvider Γûá IDMItemProvider*
layoutAdjustment IRectangle
leftIndex Γûá unsigned long
limit Γûá Γûá unsigned long
listShowing Boolean
margin Γûá Boolean
menu
messageQueue IMessageQueueHandle
minimumRows Γûá unsigned long
minimumSize Γûá ISize
nativeRect IRectangle
numberOfSelections unsigned long
owner Γûá IWindow*
parent Γûá IWindow*
parentSize ISize
pointerCaptured Boolean
position Γûá Γûá IPoint
presSpace IPresSpaceHandle
readOnly Boolean
rect Γûá IRectangle
selectedRange IRange
selectedText IString
selectedTextLength unsigned long
selection long
shadowColor Γûá Γûá IColor
showing Boolean
size Γûá Γûá ISize
tabStop Γûá Boolean
text Γûá Γûá IString
textLength Γûá unsigned long
top Γûá unsigned long
type ControlType
valid Boolean
valueAsDouble Γûá Γûá
valueAsInt Γûá Γûá
valueAsUnsigned Γûá Γûá
visible Γûá Γûá Boolean
visibleRectangle IRectangle
writeable Γûá Γûá Boolean
ΓòÉΓòÉΓòÉ <hidden> Actions - IComboBox ΓòÉΓòÉΓòÉ
Action Parameters
add unsigned long, char * const*, unsigned long
addAscending char*
addAsFirst char*
addAsLast IResourceId&
addDescending char*
applyBidiSettings BidiSettings&, Boolean, Boolean
capturePointer Boolean
clear unsigned long
convertToGUIStyle IBitFlag&, Boolean
copy unsigned long
cut unsigned long
deselect unsigned long
deselectAll None
disable None
disableAutoScroll None
disableAutoTab None
disableCommand None
disableDataUpdate None
disableGroup None
disableInsertMode None
disableMargin None
disableNotification None
disableTabStop None
disableUpdate None
discard None
dispatchRemainingHandlers IEvent&, Boolean
enable Boolean
enableUpdate Boolean
handleException IException&, IEvent&
hide None
hideList None
hideSourceEmphasis None
isLayoutDistorted unsigned long
isSelected unsigned long
itemHandle unsigned long
itemText unsigned long
locateText char*, Boolean, SearchType, unsigned long
matchForMnemonic unsigned short
notifyObservers INotificationEvent&
paste None
positionBehindSibling IWindowHandle&
positionBehindSiblings None
positionOnSiblings None
postEvent unsigned long, IEventParameter1&,
IEventParameter2&
refresh IRectangle&
releasePointer None
releasePresSpace IPresSpaceHandle&
remove unsigned long
removeAll None
resetActiveColor None
resetBackgroundColor None
resetBorderColor None
resetDisabledBackgroundColor None
resetDisabledForegroundColor None
resetFont None
resetForegroundColor None
resetHiliteBackgroundColor None
resetHiliteForegroundColor None
resetInactiveColor None
resetMinimumSize None
resetShadowColor None
select unsigned long, Boolean
selectRange const IRange &range, unsigned long
sendEvent unsigned long, IEventParameter1&,
IEventParameter2&
setChangedFlag Boolean
setFocus None
setItemHandle unsigned long, unsigned long
setItemText unsigned long, char*, Boolean
setLayoutDistorted unsigned long, unsigned long
show Boolean
showList Boolean
showSourceEmphasis Boolean
ΓòÉΓòÉΓòÉ <hidden> Events - IComboBox ΓòÉΓòÉΓòÉ
Event Notification ID
characterTypeEvent characterTypeId
commandEvent commandId
enterEvent enterId
gotFocusEvent FOCUSTRUEID
inputDisabledEvent ENABLEFALSEID
inputEnabledEvent ENABLETRUEID
lostFocusEvent FOCUSFALSEID
systemCommandEvent systemCommandId
visibilityDisabledEvent VISIBLEFALSEID
visibilityEnabledEvent VISIBLETRUEID
ΓòÉΓòÉΓòÉ <hidden> General Settings - IComboBox ΓòÉΓòÉΓòÉ
Subpart name Sets the name of the subpart (a part placed on a composite part).
Default value: The name of the part
Text Sets the text for the part.
Default value: The name of the part
Selection index Sets the index of the specified choice.
Default value: -1
Auto scroll Enables automatic scrolling for the part.
Default value: Not selected
Margin Draws a border around the entry field, with a margin between the border
and the entry field. For a canvas, the margin width and height are returned,
which is the space between the edge of the canvas and the outermost child
windows.
Default value: Not selected
Auto tab Generates a tab key when the part is filled by adding a character at
the text limit of the part text.
Default value: Not selected
Insert mode Sets insert mode to on.
Default value: Selected
Limit Sets the length (in bytes) of the longest text the part can hold.
Default value: 260
Combo box type Sets the behavior of the combination box, which can be one of
the following:
Simple
Specifies that the entry field and list box controls are visible.
When the selection changes in the list box control, the text of the
selected item in the list box control is placed in the entry field.
You can also select an item from the list box control by entering
part of the item into the entry field. The entry is completed with
the closest match from the list box.
Drop-down
Specifies the drop-down variation of the combination box. The list
box control is hidden until the user requests that it be displayed.
Read-only drop-down
Specifies the drop-down list variation of the combination box. The
drop-down list only displays one item in the entry field until the
user displays the list box control to make alternative selections
from the list box. The user cannot enter information into the entry
field portion of the drop-down list. The entry field control is
replaced by a static control that displays the current selection from
the list box.
Default value: Square
Character type Sets the type of a character at a given index.
Default value: Any
Contents Sets initial items for the part.
Default value: None
ΓòÉΓòÉΓòÉ <hidden> Control Settings - IComboBox ΓòÉΓòÉΓòÉ
Fly over short text Specifies the short text for the fly-over text control.
Default value: None
Fly over long text Specifies the long text for the fly-over text control.
Default value: None
Window id Sets the window identifier.
Default value: None
Help panel id Sets the help panel identifier for the part.
Default value: None
Enabled Enables the handler by default.
Default value: Selected
ΓòÉΓòÉΓòÉ <hidden> Styles Settings - IComboBox ΓòÉΓòÉΓòÉ
defaultStyle() Resets the part to the original default style.
Default value: Selected
horizontalScroll Provides a horizontal scroll bar for the part.
Default value: The default is on, and the Default radio button is selected.
group Identifies the control as being the first in a group. No other controls
in the group can have this style. Controls in the group must be siblings
that are constructed following the first control. The group can be cursored
and when the last control in the group is reached, the cursor returns the
first control in the group.
Default value: The default is off, and the Default radio button is selected.
tabStop Identifies the control as one to which the user can tab.
Default value: The default is off, and the Default radio button is selected.
clipChildren Excludes the area occupied by the children of the window when
drawing in the window. Child windows are always "clipped" to their parent
window. When a parent window is painted, the clipChildren style controls
whether the invalidated region of the parent window includes the area
occupied by its children, thus preventing a window from painting over its
child windows.
Default value: The Default radio button is selected.
clipSiblings Controls which sibling window is displayed on top when multiple
siblings are displayed. Sibling windows are windows that share the same
parent window. Assign the clipSiblings style to the sibling window that you
want displayed on top of the other siblings, in Z-order.
Default value: The Default radio button is selected.
clipToParent Allows a window to paint outside of its window boundary up to the
window boundary of its parent.
Default value: The Default radio button is selected.
saveBits Optimizes the painting of a window by saving the screen image of the
area under the window as a bitmap and then using the bitmap to redraw the
window, when necessary.
Default value: The Default radio button is selected.
synchPaint Synchronously repaints the window. Without this style, painting
only occurs if there are no other events waiting to be processed.
Default value: The Default radio button is selected.
visible Makes the window visible. In general, controls are constructed as
visible, and frame windows are constructed as invisible.
Default value: The default is on, and the Default radio button is selected.
ΓòÉΓòÉΓòÉ <hidden> Handlers Settings - IComboBox ΓòÉΓòÉΓòÉ
Handler name Sets the name of the default handler.
Default value: None
Handler list Sets the name of the handler for the MLE control.
Default value: None
Add after Adds the new choice after the selected choice in the list. If no
choice is selected, the new choice is added after the first choice in the
list.
Default value: Highlighted
Add before Adds the new choice before the selected choice in the list. If no
choice is selected, the new choice is added before the first choice in the
list.
Default value: Not highlighted
Move Determines whether a part and its descendants can be moved to a new
location.
Default value: Not highlighted
Remove Removes one item from the part and returns the count of the number of
items that remain.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ <hidden> Color Settings - IComboBox ΓòÉΓòÉΓòÉ
Color area Sets the color of the given area. Choices are as follows:
Foreground
Sets the color for foreground text
Background
Sets the color for background text
Disabled foreground
Sets the foreground color for disabled text
Highlighted foreground
Sets the foreground color for selected text
Border
Sets the color of the border that surrounds the part.
Default value: Foreground is selected
Color selection Enables color selection by either color values or RGB values.
Select Colors or RGB. If you select Colors, you can set the Color values. If
you select RGB, you can set the RGB values.
Default value: RGB selected
Color values Sets the color value of the window area, or sets the passed
default if no color for the area has been set.
Default value: None
RGB values Sets the color values for the window area.
Default value: Not set
ΓòÉΓòÉΓòÉ <hidden> Size/Position Settings - IComboBox ΓòÉΓòÉΓòÉ
X field Sets the X coordinate of the part.
Default value: The x coordinate of the part currently positioned on the
free-form surface
Y field Sets the Y coordinate of the point.
Default value: The y coordinate of the part currently positioned on the
free-form surface
Width Sets the width of the text.
Default value: None
Height Sets the height of the text.
Default value: None
Minimum size Determines the minimum size of the part.
Select Calculate at execution time or Set value here. If you select
Calculate at execution time, the minimum size is determined dynamically. If
you select Set value here, you can set the Minimum size Width and Height
fields to define a fixed minimum size.
Default value: Calculate at execution time is selected
Width Sets the minimum-allowable width, which is set by the user's class.
Default value: None (calculated at execution time)
Height Sets the minimum-allowable height, which is set by the user's class.
Default value: None (calculated at execution time)
ΓòÉΓòÉΓòÉ <hidden> Font Settings - IComboBox ΓòÉΓòÉΓòÉ
Name Sets the name of the font.
Default value: System proportional
Point size Sets the point size of the font.
Default value: 10
Style Sets the style for the part.
Default value: None
Emphasis Gives the part emphasis. If a part is specified, the emphasis is
drawn around the part.
Default value: None
Edit Opens an edit field on a part or setting.
Default value: Highlighted
Default font Sets the current default font style.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ 3.9. IContainerColumn ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Settings Pages
General
Styles
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IContainerColumn ΓòÉΓòÉΓòÉ
Title: IBM column for container details view
Class name: IContainerColumn
Base part: IVBase
Part type: Class interface part
Part file: vbbase.vbb
An IContainerColumn part is a column for the details view of a container. The
column contains information on a particular attribute of each container
object.
The user can view the column data for container objects. With modifiable text
data, the user can edit the object attribute.
Use an IContainerColumn part to define the heading and contents of a container
details view column.
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - IContainerColumn ΓòÉΓòÉΓòÉ
When building with an IContainerColumn part, you can do the following:
Add the column to a container control. Do this by selecting the
IContainerColumn part from the parts palette and dropping the part on an
IVBContainerControl.
To gain access to the container column while building, select the
showDetailsView choice in the View type field on the IVBContainerControl
General settings page.
Define the column heading. Do this by entering the heading in the Heading
text field on the IContainerColumn General settings page.
Determine what data appears in the column. Do this in the Column
definition field on the IContainerColumn General settings page.
To show the text title of each container item, select the Use Text
attribute set in the Container setting. The text presentation is set on
the IVBContainerControl General settings page.
To show an icon for each container item, select the Use Icon attribute
set in the Container setting. The icon specification is set on the
IVBContainerControl General settings page.
To show an attribute of each container item, select the Use an attribute
from the part setting. Then, select a choice from the Attributes list
box. Only text-related attributes are available as choices.
ΓòÉΓòÉΓòÉ <hidden> Attributes - IContainerColumn ΓòÉΓòÉΓòÉ
Attribute S E Data type
asDebugInfo IString
asString IString
date Boolean
displayWidth Γûá unsigned long
headingIcon Γûá IPointerHandle
headingIconHandle Boolean
headingString Boolean
headingText Γûá IString
headingWriteable Γûá Boolean
helpId Γûá unsigned long
horizontalDataAlignment HorizontalAlignment
horizontalHeadingAlignment HorizontalAlignment
horizontalSeparator Boolean
iconHandle Boolean
number Boolean
string Boolean
time Boolean
verticalDataAlignment VerticalAlignment
verticalHeadingAlignment VerticalAlignment
verticalSeparator Boolean
visible Γûá Boolean
writeable Γûá Boolean
ΓòÉΓòÉΓòÉ <hidden> Actions - IContainerColumn ΓòÉΓòÉΓòÉ
Action Parameters
dataAsDate IContainerObject*
dataAsIcon IContainerObject*
dataAsNumber IContainerObject*
dataAsString IContainerObject*
dataAsTime IContainerObject*
disableDataUpdate None
disableHeadingUpdate None
hide None
hideSeparators DataStyle&
justifyData VerticalAlignment, HorizontalAlignment
justifyHeading VerticalAlignment, HorizontalAlignment
setDataOffset unsigned long
showSeparators DataStyle&
ΓòÉΓòÉΓòÉ <hidden> General Settings - IContainerColumn ΓòÉΓòÉΓòÉ
Subpart name Sets the name of the subpart (a part placed on a composite part).
Default value: The name of the part
Heading text Sets the text for the column heading.
Default value: None
Width Sets the container column width.
Default value: Determined by the size of column data.
Column definition Sets the data to appear in the column.
Default value: Foreground is selected
Use Text attribute set in the Container Sets the title text to show for the
container item.
Default value: None
Use Icon attribute set in the Container Sets the icon to show for the
container item.
Default value: None
Use an attribute from the part Sets the attribute to show for the container
item.
Default value: None
Attributes Lists the available text-related attributes that you can select
from to assign to the column.
Default value: No choice is selected.
Attribute type Displays the data type of the selected attribute.
Default value: None when no attribute choice is selected.
Column type Lists the available column data types for the selected attribute.
Default value: None when no attribute choice is selected.
ΓòÉΓòÉΓòÉ <hidden> Styles Settings - IContainerColumn ΓòÉΓòÉΓòÉ
defaultHeadingStyle() Resets the part to the original default heading style.
Default value: Selected
readOnlyHeading Prevents entering input into the heading field.
Default value: The default is off, and the Default radio button is selected.
icon The heading is an icon.
Default value: The default is off, and the Default radio button is selected.
defaultDataStyle() Resets the part to the original default data style.
Default value: Selected
date The data is displayed in date format and is enabled for National Language
Support.
Default value: The default is off, and the Default radio button is selected.
time The data is displayed in time format and is enabled for National Language
Support.
Default value: The default is off, and the Default radio button is selected.
number The data is displayed as an unsigned long number.
Default value: The default is off, and the Default radio button is selected.
horizontalSeparator Provides a horizontal separator beneath the column
heading.
Default value: The default is on, and the Default radio button is selected.
verticalSeparator Provides a vertical separator after the column.
Default value: The default is on, and the Default radio button is selected.
handleDrawItem Generates a draw item event to allow the application to draw
the part.
Default value: The Default radio button is selected.
readOnly Prevents entering input into the field.
Default value: The default is off, and the Default radio button is selected.
invisible The column is invisible.
Default value: The default is off, and the Default radio button is selected.
icon The data is an icon.
Default value: The default is off, and the Default radio button is selected.
ΓòÉΓòÉΓòÉ 3.10. ICustomButton ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Events
Settings Pages
General
Control
Styles
Handlers
Color
Size/Position
Font
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - ICustomButton ΓòÉΓòÉΓòÉ
Title: IBM custom button control
Class name: ICustomButton
Base part: IButton
Part type: Visual part
Part file: vbbase.vbb
An ICustomButton part is a selection button for an action. The choice is
identified by text on the custom button. Your application can customize a
custom button.
The user can click the custom button to perform the indicated function.
Use an ICustomButton part to give the user an action choice button with the
following capabilities:
The button can be customized.
The button can remain latched down when it is selected.
A multimedia play button is an example of a custom button.
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - ICustomButton ΓòÉΓòÉΓòÉ
When building with an ICustomButton part, you can do the following:
Assign text to the custom button. Do this by setting the Text field on
the ICustomButton General settings page.
Assign a customization handler for the custom button. Do this by
specifying an ICustomButtonDrawHandler on the ICustomButton Handlers
settings page.
Give the button the appearance of remaining latched down while it is
active. This simulates the behavior of such controls as a play button. Do
this by setting the latchable field on the ICustomButton Styles settings
page.
Allow the user to reach the button by using a tab key. Do this by setting
the tabStop field to On on the ICustomButton Styles settings page.
If the button is the first control in a group, allow the user to use
cursor keys to move between the button and follow controls in the group.
Do this by setting the group field to On on the ICustomButton Styles
settings page.
Start the action represented by the button. Do this by connecting the
ICustomButton buttonClickEvent feature to the action on the target part.
Enable or disable the custom button when an event occurs.
Enable the button as follows:
1. Connect the event to the ICustomButton enable action.
2. The button is enabled by default. If you have changed this default,
open settings for the connection, press the Set parameters push
button, and check the Enabled setting.
Disable the button by connecting the event to the ICustomButton disable
action.
ΓòÉΓòÉΓòÉ <hidden> Attributes - ICustomButton ΓòÉΓòÉΓòÉ
Attribute S E Data type
activeColor Γûá Γûá IColor
allowsMouseClickFocus Γûá Boolean
asDebugInfo IString
asString IString
autoDeleteObject Γûá Boolean
autoDestroyWindow Γûá Boolean
autoLatchEnabled Γûá Boolean
backgroundColor Γûá Γûá IColor
bidiSupported Boolean
borderColor Γûá Γûá IColor
characterSize ISize
clipboardHasTextFormat Boolean
defaultPushButton IWindowHandle
disabledBackgroundColor Γûá Γûá IColor
disabledForegroundColor Γûá Γûá IColor
displaySize ISize
enabled Γûá Γûá Boolean
enabledForNotification Γûá Boolean
focus Γûá Boolean
font Γûá Γûá IFont
foregroundColor Γûá Γûá IColor
frameWindow Boolean
group Γûá Boolean
handle IWindowHandle
highlighted Boolean
hiliteBackgroundColor Γûá Γûá IColor
hiliteForegroundColor Γûá Γûá IColor
id Γûá unsigned long
inactiveColor Γûá Γûá IColor
isDigits Γûá
itemProvider Γûá IDMItemProvider*
latched Γûá Γûá Boolean
latchedBackgroundColor Γûá IColor
latchedBackgroundColorHalftone Boolean
latchedForegroundColor Γûá IColor
latchingEnabled Γûá Boolean
layoutAdjustment IRectangle
menu
messageQueue IMessageQueueHandle
minimumSize Γûá ISize
nativeRect IRectangle
owner Γûá IWindow*
parent Γûá IWindow*
parentSize ISize
pointerCaptured Boolean
position Γûá Γûá IPoint
presSpace IPresSpaceHandle
rect Γûá IRectangle
shadowColor Γûá Γûá IColor
showing Boolean
size Γûá Γûá ISize
tabStop Γûá Boolean
text Γûá Γûá IString
textLength Γûá unsigned long
userData Γûá unsigned long
valid Boolean
valueAsDouble Γûá Γûá
valueAsInt Γûá Γûá
valueAsUnsigned Γûá Γûá
visible Γûá Γûá Boolean
visibleRectangle IRectangle
ΓòÉΓòÉΓòÉ <hidden> Actions - ICustomButton ΓòÉΓòÉΓòÉ
Action Parameters
applyBidiSettings BidiSettings&, Boolean, Boolean
capturePointer Boolean
click None
convertToGUIStyle IBitFlag&, Boolean
disable None
disableAutoLatch None
disableGroup None
disableLatching None
disableMouseClickFocus None
disableNotification None
disableTabStop None
disableUpdate None
dispatchRemainingHandlers IEvent&, Boolean
enable Boolean
enableUpdate Boolean
handleException IException&, IEvent&
hide None
hideSourceEmphasis None
highlight Boolean
isLayoutDistorted unsigned long
matchForMnemonic unsigned short
notifyObservers INotificationEvent&
positionBehindSibling IWindowHandle&
positionBehindSiblings None
positionOnSiblings None
postEvent unsigned long, IEventParameter1&,
IEventParameter2&
refresh IRectangle&
releasePointer None
releasePresSpace IPresSpaceHandle&
resetActiveColor None
resetBackgroundColor None
resetBorderColor None
resetDisabledBackgroundColor None
resetDisabledForegroundColor None
resetFont None
resetForegroundColor None
resetHiliteBackgroundColor None
resetHiliteForegroundColor None
resetInactiveColor None
resetLatchedBackgroundColor None
resetLatchedForegroundColor None
resetMinimumSize None
resetShadowColor None
sendEvent unsigned long, IEventParameter1&,
IEventParameter2&
setFocus None
setLayoutDistorted unsigned long, unsigned long
show Boolean
showSourceEmphasis Boolean
unhighlight None
unlatch None
ΓòÉΓòÉΓòÉ <hidden> Events - ICustomButton ΓòÉΓòÉΓòÉ
Event Notification ID
buttonClickEvent buttonClickId
commandEvent commandId
gotFocusEvent FOCUSTRUEID
inputDisabledEvent ENABLEFALSEID
inputEnabledEvent ENABLETRUEID
lostFocusEvent FOCUSFALSEID
systemCommandEvent systemCommandId
visibilityDisabledEvent VISIBLEFALSEID
visibilityEnabledEvent VISIBLETRUEID
ΓòÉΓòÉΓòÉ <hidden> General Settings - ICustomButton ΓòÉΓòÉΓòÉ
Subpart name Sets the name of the subpart (a part placed on a composite part).
Default value: The name of the part
Text Sets the text for the part.
Default value: The name of the part
Latched Sets the part to the latched state.
Default value: Not selected
ΓòÉΓòÉΓòÉ <hidden> Control Settings - ICustomButton ΓòÉΓòÉΓòÉ
Fly over short text Specifies the short text for the fly-over text control.
Default value: None
Fly over long text Specifies the long text for the fly-over text control.
Default value: None
Window id Sets the window identifier.
Default value: None
Help panel id Sets the help panel identifier for the part.
Default value: None
Enabled Enables the handler by default.
Default value: Selected
ΓòÉΓòÉΓòÉ <hidden> Styles Settings - ICustomButton ΓòÉΓòÉΓòÉ
defaultStyle() Resets the part to the original default style.
Default value: Selected
latchable Sets the default style to the latchable state.
Default value: The Default radio button is selected.
autoLatch Sets the default style for the part the automatic latch state.
Default value: The Default radio button is selected.
noPointerFocus Allows the cursor stay on a control for which information is
required, rather than moving to the button. Buttons with this style do not
set the focus to themselves when the user clicks on them using the mouse.
This has no effect on keyboard interaction.
Default value: The Default radio button is selected.
group Identifies the control as being the first in a group. No other controls
in the group can have this style. Controls in the group must be siblings
that are constructed following the first control. The group can be cursored
and when the last control in the group is reached, the cursor returns the
first control in the group.
Default value: The default is off, and the Default radio button is selected.
tabStop Identifies the control as one to which the user can tab.
Default value: The default is off, and the Default radio button is selected.
clipChildren Excludes the area occupied by the children of the window when
drawing in the window. Child windows are always "clipped" to their parent
window. When a parent window is painted, the clipChildren style controls
whether the invalidated region of the parent window includes the area
occupied by its children, thus preventing a window from painting over its
child windows.
Default value: The Default radio button is selected.
clipSiblings Controls which sibling window is displayed on top when multiple
siblings are displayed. Sibling windows are windows that share the same
parent window. Assign the clipSiblings style to the sibling window that you
want displayed on top of the other siblings, in Z-order.
Default value: The Default radio button is selected.
clipToParent Allows a window to paint outside of its window boundary up to the
window boundary of its parent.
Default value: The Default radio button is selected.
saveBits Optimizes the painting of a window by saving the screen image of the
area under the window as a bitmap and then using the bitmap to redraw the
window, when necessary.
Default value: The Default radio button is selected.
synchPaint Synchronously repaints the window. Without this style, painting
only occurs if there are no other events waiting to be processed.
Default value: The Default radio button is selected.
visible Makes the window visible. In general, controls are constructed as
visible, and frame windows are constructed as invisible.
Default value: The default is on, and the Default radio button is selected.
ΓòÉΓòÉΓòÉ <hidden> Handlers Settings - ICustomButton ΓòÉΓòÉΓòÉ
Handler name Sets the name of the default handler.
Default value: None
Handler list Sets the name of the handler for the MLE control.
Default value: None
Add after Adds the new choice after the selected choice in the list. If no
choice is selected, the new choice is added after the first choice in the
list.
Default value: Highlighted
Add before Adds the new choice before the selected choice in the list. If no
choice is selected, the new choice is added before the first choice in the
list.
Default value: Not highlighted
Move Determines whether a part and its descendants can be moved to a new
location.
Default value: Not highlighted
Remove Removes one item from the part and returns the count of the number of
items that remain.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ <hidden> Color Settings - ICustomButton ΓòÉΓòÉΓòÉ
Color area Sets the color of the given area. Choices are as follows:
Foreground
Sets the color for foreground text
Background
Sets the color for background text
Latched foreground
Sets the foreground color for latched text
Latched background
Sets the background color for latched text
Default value: Foreground is selected
Color selection Enables color selection by either color values or RGB values.
Select Colors or RGB. If you select Colors, you can set the Color values. If
you select RGB, you can set the RGB values.
Default value: RGB selected
Color values Sets the color value of the window area, or sets the passed
default if no color for the area has been set.
Default value: None
RGB values Sets the color values for the window area.
Default value: Not set
ΓòÉΓòÉΓòÉ <hidden> Size/Position Settings - ICustomButton ΓòÉΓòÉΓòÉ
X field Sets the X coordinate of the part.
Default value: The x coordinate of the part currently positioned on the
free-form surface
Y field Sets the Y coordinate of the point.
Default value: The y coordinate of the part currently positioned on the
free-form surface
Width Sets the width of the text.
Default value: None
Height Sets the height of the text.
Default value: None
Minimum size Determines the minimum size of the part.
Select Calculate at execution time or Set value here. If you select
Calculate at execution time, the minimum size is determined dynamically. If
you select Set value here, you can set the Minimum size Width and Height
fields to define a fixed minimum size.
Default value: Calculate at execution time is selected
Width Sets the minimum-allowable width, which is set by the user's class.
Default value: None (calculated at execution time)
Height Sets the minimum-allowable height, which is set by the user's class.
Default value: None (calculated at execution time)
ΓòÉΓòÉΓòÉ <hidden> Font Settings - ICustomButton ΓòÉΓòÉΓòÉ
Name Sets the name of the font.
Default value: System proportional
Point size Sets the point size of the font.
Default value: 10
Style Sets the style for the part.
Default value: None
Emphasis Gives the part emphasis. If a part is specified, the emphasis is
drawn around the part.
Default value: None
Edit Opens an edit field on a part or setting.
Default value: Highlighted
Default font Sets the current default font style.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ 3.11. IEntryField ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Events
Settings Pages
General
Control
Styles
Handlers
Color
Size/Position
Font
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IEntryField ΓòÉΓòÉΓòÉ
Title: IBM entry field control
Class name: IEntryField
Base part: ITextControl
Part type: Visual part
Part file: vbbase.vbb
An IEntryField part is a single-line entry field.
The user can type or place text into the entry field.
Use an IEntryField part to let the user define or view a data item.
Alternatively, use an IMultiLineEdit part for multiple-line data.
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - IEntryField ΓòÉΓòÉΓòÉ
When building with an IEntryField part, you can do the following:
Prime the entry field with constant initial data. Do this by specifying
the initial value in the Text field on the IEntryField General settings
page.
Prime the entry field with variable initial data. Do this by connecting
your data source to the text attribute. Your application should make this
connection before it shows the frame window.
Make the entry field read-only to prevent the user from entering or
modifying text. Do this by selecting the Read only field on the
IEntryField Styles settings page.
Allow the user to reach the entry field by using a tab key. Do this by
setting the tabStop field to On on the IEntryField Styles settings page.
Assign information to the entry field when an event occurs, such as a
push button being pressed. Do this with an IEntryField part and an
IPushButton as follows:
1. Connect the IPushButton buttonClickEvent feature to the IEntryField
text attribute.
2. Connect the data source to the text parameter of the
buttonClickEvent-to-text connection.
Copy or save the contents of the entry field when an event occurs, such
as a push button being pressed. Do this with an IEntryField part and an
IPushButton as follows:
1. Connect the IPushButton buttonClickEvent feature to the data
destination.
2. Connect the IEntryField text attribute to the text parameter of the
buttonClickEvent-to-destination connection.
ΓòÉΓòÉΓòÉ <hidden> Attributes - IEntryField ΓòÉΓòÉΓòÉ
Attribute S E Data type
activeColor Γûá Γûá IColor
alignment Γûá Alignment
asDebugInfo IString
asString IString
autoDeleteObject Γûá Boolean
autoDestroyWindow Γûá Boolean
autoScroll Γûá Boolean
autoTab Γûá Boolean
backgroundColor Γûá Γûá IColor
bidiSupported Boolean
borderColor Γûá Γûá IColor
changed Boolean
characterSize ISize
charType Γûá CharType
clipboardHasTextFormat Boolean
command Γûá Γûá Boolean
cursorPosition Γûá unsigned long
defaultPushButton IWindowHandle
disabledBackgroundColor Γûá Γûá IColor
disabledForegroundColor Γûá Γûá IColor
displaySize ISize
empty Boolean
enabled Γûá Γûá Boolean
enabledForNotification Γûá Boolean
focus Γûá Boolean
font Γûá Γûá IFont
foregroundColor Γûá Γûá IColor
frameWindow Boolean
group Γûá Boolean
handle IWindowHandle
hasSelectedText Boolean
hiliteBackgroundColor Γûá Γûá IColor
hiliteForegroundColor Γûá Γûá IColor
id Γûá unsigned long
inactiveColor Γûá Γûá IColor
insertMode Γûá Γûá Boolean
isDigits Γûá
itemProvider Γûá IDMItemProvider*
layoutAdjustment IRectangle
leftIndex Γûá unsigned long
limit Γûá Γûá unsigned long
margin Γûá Boolean
menu
messageQueue IMessageQueueHandle
minimumSize Γûá ISize
nativeRect IRectangle
owner Γûá IWindow*
parent Γûá IWindow*
parentSize ISize
pointerCaptured Boolean
position Γûá Γûá IPoint
presSpace IPresSpaceHandle
readOnly Boolean
rect Γûá IRectangle
selectedRange IRange
selectedText IString
selectedTextLength unsigned long
shadowColor Γûá Γûá IColor
showing Boolean
size Γûá Γûá ISize
tabStop Γûá Boolean
text Γûá Γûá IString
textLength Γûá unsigned long
valid Boolean
valueAsDouble Γûá Γûá
valueAsInt Γûá Γûá
valueAsUnsigned Γûá Γûá
visible Γûá Γûá Boolean
visibleRectangle IRectangle
writeable Γûá Γûá Boolean
ΓòÉΓòÉΓòÉ <hidden> Actions - IEntryField ΓòÉΓòÉΓòÉ
Action Parameters
applyBidiSettings BidiSettings&, Boolean, Boolean
capturePointer Boolean
clear unsigned long
convertToGUIStyle IBitFlag&, Boolean
copy unsigned long
cut unsigned long
disable None
disableAutoScroll None
disableAutoTab None
disableCommand None
disableDataUpdate None
disableGroup None
disableInsertMode None
disableMargin None
disableNotification None
disableTabStop None
disableUpdate None
discard None
dispatchRemainingHandlers IEvent&, Boolean
enable Boolean
enableUpdate Boolean
handleException IException&, IEvent&
hide None
hideSourceEmphasis None
isLayoutDistorted unsigned long
matchForMnemonic unsigned short
notifyObservers INotificationEvent&
paste None
positionBehindSibling IWindowHandle&
positionBehindSiblings None
positionOnSiblings None
postEvent unsigned long, IEventParameter1&,
IEventParameter2&
refresh IRectangle&
releasePointer None
releasePresSpace IPresSpaceHandle&
removeAll None
resetActiveColor None
resetBackgroundColor None
resetBorderColor None
resetDisabledBackgroundColor None
resetDisabledForegroundColor None
resetFont None
resetForegroundColor None
resetHiliteBackgroundColor None
resetHiliteForegroundColor None
resetInactiveColor None
resetMinimumSize None
resetShadowColor None
selectRange const IRange &range, unsigned long
sendEvent unsigned long, IEventParameter1&,
IEventParameter2&
setChangedFlag Boolean
setFocus None
setLayoutDistorted unsigned long, unsigned long
show Boolean
showSourceEmphasis Boolean
ΓòÉΓòÉΓòÉ <hidden> Events - IEntryField ΓòÉΓòÉΓòÉ
Event Notification ID
characterTypeEvent characterTypeId
commandEvent commandId
gotFocusEvent FOCUSTRUEID
inputDisabledEvent ENABLEFALSEID
inputEnabledEvent ENABLETRUEID
lostFocusEvent FOCUSFALSEID
systemCommandEvent systemCommandId
visibilityDisabledEvent VISIBLEFALSEID
visibilityEnabledEvent VISIBLETRUEID
ΓòÉΓòÉΓòÉ <hidden> General Settings - IEntryField ΓòÉΓòÉΓòÉ
Subpart name Sets the name of the subpart (a part placed on a composite part).
Default value: The name of the part
Text Sets the text for the part.
Default value: The name of the part
Limit Sets the length (in bytes) of the longest text the part can hold.
Default value: 32
Insert mode Sets insert mode to on.
Default value: Selected
Alignment Changes the text alignment of the part. Left aligns the text to the
left, Center centers the text, and Right aligns the text at the right.
Default value: Left
Character type Sets the type of a character at a given index.
Default value: Any
ΓòÉΓòÉΓòÉ <hidden> Control Settings - IEntryField ΓòÉΓòÉΓòÉ
Fly over short text Specifies the short text for the fly-over text control.
Default value: None
Fly over long text Specifies the long text for the fly-over text control.
Default value: None
Window id Sets the window identifier.
Default value: None
Help panel id Sets the help panel identifier for the part.
Default value: None
Enabled Enables the handler by default.
Default value: Selected
ΓòÉΓòÉΓòÉ <hidden> Styles Settings - IEntryField ΓòÉΓòÉΓòÉ
defaultStyle() Resets the part to the original default style.
Default value: Selected
unreadable Substitutes each character in the text with an asterisk.
Default value: The Default radio button is selected.
autoScroll Enables automatic scrolling for the part. The entry field
automatically makes more space at the end of the line as the user enters
more text.
Default value: The default is on, and the Default radio button is selected.
autoTab Generates a tab key when the part is filled by adding a character at
the text limit of the part text.
Default value: The default is off, and the Default radio button is selected.
command Generates a command event when the user selects the part.
Default value: The Default radio button is selected.
margin Sets the style so that a border is drawn around the entry field.
Default value: The default is on, and the Default radio button is selected.
readOnly Prevents entering input into the field.
Default value: The default is off, and the Default radio button is selected.
group Identifies the control as being the first in a group. No other controls
in the group can have this style. Controls in the group must be siblings
that are constructed following the first control. The group can be cursored
and when the last control in the group is reached, the cursor returns the
first control in the group.
Default value: The default is off, and the Default radio button is selected.
tabStop Identifies the control as one to which the user can tab.
Default value: The default is off, and the Default radio button is selected.
clipChildren Excludes the area occupied by the children of the window when
drawing in the window. Child windows are always "clipped" to their parent
window. When a parent window is painted, the clipChildren style controls
whether the invalidated region of the parent window includes the area
occupied by its children, thus preventing a window from painting over its
child windows.
Default value: The Default radio button is selected.
clipSiblings Controls which sibling window is displayed on top when multiple
siblings are displayed. Sibling windows are windows that share the same
parent window. Assign the clipSiblings style to the sibling window that you
want displayed on top of the other siblings, in Z-order.
Default value: The Default radio button is selected.
clipToParent Allows a window to paint outside of its window boundary up to the
window boundary of its parent.
Default value: The Default radio button is selected.
saveBits Optimizes the painting of a window by saving the screen image of the
area under the window as a bitmap and then using the bitmap to redraw the
window, when necessary.
Default value: The Default radio button is selected.
synchPaint Synchronously repaints the window. Without this style, painting
only occurs if there are no other events waiting to be processed.
Default value: The Default radio button is selected.
visible Makes the window visible. In general, controls are constructed as
visible, and frame windows are constructed as invisible.
Default value: The default is on, and the Default radio button is selected.
ΓòÉΓòÉΓòÉ <hidden> Handlers Settings - IEntryField ΓòÉΓòÉΓòÉ
Handler name Sets the name of the default handler.
Default value: None
Handler list Sets the name of the handler for the MLE control.
Default value: None
Add after Adds the new choice after the selected choice in the list. If no
choice is selected, the new choice is added after the first choice in the
list.
Default value: Highlighted
Add before Adds the new choice before the selected choice in the list. If no
choice is selected, the new choice is added before the first choice in the
list.
Default value: Not highlighted
Move Determines whether a part and its descendants can be moved to a new
location.
Default value: Not highlighted
Remove Removes one item from the part and returns the count of the number of
items that remain.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ <hidden> Color Settings - IEntryField ΓòÉΓòÉΓòÉ
Color area Sets the color of the given area. Choices are as follows:
Foreground
Sets the color for foreground text
Background
Sets the color for background text
Disabled foreground
Sets the foreground color for disabled text
Highlighted foreground
Sets the foreground color for selected text
Border
Sets the color of the border that surrounds the part.
Default value: Foreground is selected
Color selection Enables color selection by either color values or RGB values.
Select Colors or RGB. If you select Colors, you can set the Color values. If
you select RGB, you can set the RGB values.
Default value: RGB selected
Color values Sets the color value of the window area, or sets the passed
default if no color for the area has been set.
Default value: None
RGB values Sets the color values for the window area.
Default value: Not set
ΓòÉΓòÉΓòÉ <hidden> Size/Position Settings - IEntryField ΓòÉΓòÉΓòÉ
X field Sets the X coordinate of the part.
Default value: The x coordinate of the part currently positioned on the
free-form surface
Y field Sets the Y coordinate of the point.
Default value: The y coordinate of the part currently positioned on the
free-form surface
Width Sets the width of the text.
Default value: None
Height Sets the height of the text.
Default value: None
Minimum size Determines the minimum size of the part.
Select Calculate at execution time or Set value here. If you select
Calculate at execution time, the minimum size is determined dynamically. If
you select Set value here, you can set the Minimum size Width and Height
fields to define a fixed minimum size.
Default value: Calculate at execution time is selected
Width Sets the minimum-allowable width, which is set by the user's class.
Default value: None (calculated at execution time)
Height Sets the minimum-allowable height, which is set by the user's class.
Default value: None (calculated at execution time)
ΓòÉΓòÉΓòÉ <hidden> Font Settings - IEntryField ΓòÉΓòÉΓòÉ
Name Sets the name of the font.
Default value: System proportional
Point size Sets the point size of the font.
Default value: 10
Style Sets the style for the part.
Default value: None
Emphasis Gives the part emphasis. If a part is specified, the emphasis is
drawn around the part.
Default value: None
Edit Opens an edit field on a part or setting.
Default value: Highlighted
Default font Sets the current default font style.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ 3.12. IFrameWindow ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Events
Settings Pages
General
Control
Styles
Handlers
Color
Size/Position
Font
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IFrameWindow ΓòÉΓòÉΓòÉ
Title: IBM window with title bar and extensions
Class name: IFrameWindow
Base part: IWindow
Part type: Visual part
Part file: vbbase.vbb
An IFrameWindow part is an application window that is a framework for
user-interface controls.
The user interacts with your application through the frame window.
Use an IFrameWindow part as a primary or secondary window for your
application. A primary window is the base window for your application. A
secondary window is opened from the primary window or from another secondary
window.
A frame window can contain the following frame controls:
System menu
Title bar
Sizing buttons
Border
Menu bar
The portion of the frame window not occupied by frame controls is called the
client area. Your application program uses the client area for the
presentation and gathering of application data.
The client area is occupied and managed by a client control. Your application
typically uses one of the following client controls:
Canvas
Container
Multiple-line edit
Notebook
View port
Your application uses these controls, or other controls within them, for most
user interaction.
You can also add extensions to the frame window. These frame extensions are
generally application-specific. A frame extension can occupy one of the
following areas:
The left- or right-hand side of the title bar area
The top or bottom of the client area
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - IFrameWindow ΓòÉΓòÉΓòÉ
When building with an IFrameWindow part, you can do the following:
Define a title for the frame window. Do this by setting the Title text
field on the IFrameWindow General settings page.
Alternatively, use an ITitle part for the frame window title. If you use
an ITitle part, you can change the frame window title after the window is
created. The IFrameWindow Title text field has no effect if you use the
ITitle part.
Attach a menu bar to the frame window. Do this as follows:
1. Select an IMenu part from the parts palette and drop it on the
free-form surface.
2. Connect the IMenu this attribute to the IFrameWindow menu attribute.
Attach a tool bar frame extension to the frame window. Do this by
selecting an IToolBar part from the parts palette and dropping it on the
frame window. The tool bar is added at the top of the client area.
Attach an information area frame extension to the frame window. Do this
by selecting an IInfoArea part from the parts palette and dropping it on
the frame window. The information area is added at the bottom of the
client area.
Change the client for the frame window. For example, you might want an
IMultiCellCanvas client instead of the ICanvas client that is initially
provided. Do this by clicking mouse button 2 on the canvas and then
selecting the Delete option. Then, select the multicell canvas from the
parts palette and drop it on the client area of the frame window.
If you have controls on a client area canvas that you want to retain for
the new client, move them to the free-form surface before you delete the
old client. Then, place them on the new client after it is added.
Give the primary frame window ownership of each modal secondary window.
For a static secondary window, do this by connecting the primary
IFrameWindow this attribute to the secondary IFrameWindow owner
attribute. For a secondary window created dynamically with an IVBFactory
part, do this by connecting the primary IFrameWindow this attribute to
the IVBFactory owner attribute.
Load data from your primary view into a secondary view. Do this by
connecting objects in the primary view composite part to corresponding
attributes of the secondary view composite part. The secondary view
attributes are IVBVariables you have promoted to the interface of the
composite part for the secondary view. These variables are connected to
data fields within your secondary view composite part.
Open a secondary window from a menu item or push button in the primary
window.
If you are opening a static secondary window, do this as follows:
1. Connect the menu item commandEvent feature or the push button
buttonClickEvent feature to the secondary IFrameWindow setFocus
action.
2. Connect the commandEvent feature or the buttonClickEvent feature to
the secondary IFrameWindow show action or showModally action.
If you are dynamically creating a composite part for a secondary view
with an IVBFactory part, do this as follows:
1. Connect the menu item commandEvent feature or the push button
buttonClickEvent feature to the IVBFactory new action.
2. Add an IVBVariable for the secondary view composite part to your
primary view composite part.
3. Connect the IVBFactory newEvent feature to the variable this
attribute.
4. Connect the newEvent feature to the variable show action or
showModally action.
5. Connect the newEvent feature to the variable setFocus action.
Remove a window when the user presses a push button, such as OK or
Cancel, to return from the window.
For a static window that must be available to show again, do this by
connecting the IPushButton buttonClickEvent feature to the IFrameWindow
hide action.
For a static window that is not to be opened again, do this by setting
the Auto delete field on the IFrameWindow General settings page.
For a dynamically created window, do this by setting the Auto delete
field on the IVBFactory General settings page. This represents the
General of the secondary IFrameWindow part.
ΓòÉΓòÉΓòÉ <hidden> Attributes - IFrameWindow ΓòÉΓòÉΓòÉ
Attribute S E Data type
activeColor Γûá Γûá IColor
asDebugInfo IString
asString IString
autoDeleteObject Γûá Boolean
autoDestroyWindow Γûá Boolean
backgroundColor Γûá Γûá IColor
bidiSupported Boolean
borderColor Γûá Γûá IColor
borderHeight Γûá unsigned long
borderSize Γûá ISize
borderWidth Γûá unsigned long
characterSize ISize
client Γûá IWindow*
clientHandle IWindowHandle
defaultOrdering Γûá IWindow::SiblingOrder
defaultPushButton IWindowHandle
disabledBackgroundColor Γûá Γûá IColor
disabledForegroundColor Γûá Γûá IColor
enabled Γûá Γûá Boolean
enabledForNotification Γûá Boolean
flashing Boolean
focus Γûá Boolean
font Γûá Γûá IFont
foregroundColor Γûá Γûá IColor
frameWindow Boolean
group Boolean
handle IWindowHandle
hiliteBackgroundColor Γûá Γûá IColor
hiliteForegroundColor Γûá Γûá IColor
icon Γûá IPointerHandle
id Γûá unsigned long
inactiveColor Γûá Γûá IColor
itemProvider Γûá IDMItemProvider*
layoutAdjustment IRectangle
maximized Boolean
maximizeRect IRectangle
menu
messageQueue IMessageQueueHandle
minimized Boolean
minimizeRect IRectangle
minimumSize Γûá ISize
modal Boolean
mousePointer Γûá IPointerHandle
nativeRect IRectangle
nextShellRect IRectangle
owner Γûá IWindow*
parent Γûá IWindow*
parentSize ISize
pointerCaptured Boolean
position Γûá Γûá IPoint
presSpace IPresSpaceHandle
rect Γûá IRectangle
restoreRect Γûá IRectangle
result Γûá Γûá unsigned long
shadowColor Γûá Γûá IColor
showing Boolean
size Γûá Γûá ISize
tabStop Boolean
toolBarList Γûá IToolBarList*
usesDialogBackground Boolean
valid Boolean
visible Γûá Γûá Boolean
visibleRectangle IRectangle
willDestroyOnClose Boolean
ΓòÉΓòÉΓòÉ <hidden> Actions - IFrameWindow ΓòÉΓòÉΓòÉ
Action Parameters
addExtension IWindow*, Location, SeparatorType
addToWindowList None
applyBidiSettings BidiSettings&, Boolean, Boolean
beginFlashing None
capturePointer Boolean
clientRectFor IRectangle&
close None
convertToGUIStyle IBitFlag&, Boolean
disable None
disableNotification None
disableUpdate None
dismiss unsigned long
dispatchRemainingHandlers IEvent&, Boolean
enable Boolean
enableUpdate Boolean
endFlashing None
frameRectFor IRectangle&
handleException IException&, IEvent&
handleFor Style&
hide None
hideSourceEmphasis None
isAnExtension IWindow*
isLayoutDistorted unsigned long
matchForMnemonic unsigned short
maximize None
minimize None
moveSizeToClient IRectangle&
notifyObservers INotificationEvent&
notifyOwner unsigned long, ICommandEvent::Source, Boolean
positionBehindSibling IWindowHandle&
positionBehindSiblings None
positionOnSiblings None
postEvent unsigned long, IEventParameter1&,
IEventParameter2&
refresh IRectangle&
releasePointer None
releasePresSpace IPresSpaceHandle&
removeExtension IWindow*, Boolean
removeFromWindowList None
resetActiveColor None
resetBackgroundColor None
resetBorderColor None
resetDisabledBackgroundColor None
resetDisabledForegroundColor None
resetFont None
resetForegroundColor None
resetHiliteBackgroundColor None
resetHiliteForegroundColor None
resetInactiveColor None
resetMinimumSize None
resetShadowColor None
restore None
sendEvent unsigned long, IEventParameter1&,
IEventParameter2&
setDestroyOnClose Boolean
setExtensionSize IWindow*, double
setFocus None
setLayoutDistorted unsigned long, unsigned long
shareParentDBCSStatus None
show Boolean
showModally None
showSourceEmphasis Boolean
start IWindowHandle&
update None
useExtensionMinimumSize IWindow*
ΓòÉΓòÉΓòÉ <hidden> Events - IFrameWindow ΓòÉΓòÉΓòÉ
Event Notification ID
activateEvent activateId
closeEvent closeId
commandEvent commandId
deactivateEvent deactivateId
gotFocusEvent FOCUSTRUEID
inputDisabledEvent ENABLEFALSEID
inputEnabledEvent ENABLETRUEID
lostFocusEvent FOCUSFALSEID
systemCommandEvent systemCommandId
visibilityDisabledEvent VISIBLEFALSEID
visibilityEnabledEvent VISIBLETRUEID
ΓòÉΓòÉΓòÉ <hidden> General Settings - IFrameWindow ΓòÉΓòÉΓòÉ
Subpart name Sets the name of the subpart (a part placed on a composite part).
Default value: The name of the part
Title text Sets the title text for the part.
Default value: The name of the part
Border width Sets the screen coordinates for the width of the border of the
frame window.
Default value: 4
Border height Sets the screen coordinates for the height of the border of the
frame window.
Default value: 5
Auto delete Removes the specified item from the menu.
Default value: Not selected
ΓòÉΓòÉΓòÉ <hidden> Control Settings - IFrameWindow ΓòÉΓòÉΓòÉ
Fly over short text Specifies the short text for the fly-over text control.
Default value: None
Fly over long text Specifies the long text for the fly-over text control.
Default value: None
Window id Sets the window identifier.
Default value: None
Help panel id Sets the help panel identifier for the part.
Default value: None
Enabled Enables the handler by default.
Default value: Selected
ΓòÉΓòÉΓòÉ <hidden> Styles Settings - IFrameWindow ΓòÉΓòÉΓòÉ
defaultStyle() Resets the part to the original default style.
Default value: Selected
accelerator Saves the current accelerator and changes to the new accelerator.
Default value: The Default radio button is selected.
animated Shows the frame window with animation when the user opens, closes, or
restores it.
Default value: The Default radio button is selected.
appDBCSStatus Includes a DBCS status area in the frame of the frame window
when displayed in a DBCS environment.
Default value: The Default radio button is selected.
border Draws a border around the frame window, or sets the color of the border
that surrounds the button window.
Default value: The Default radio button is selected.
dialogBackground Gives a frame the background color for the system dialog.
Default value: The Default radio button is selected.
dialogBorder Puts a dialog border around the frame window.
Default value: The Default radio button is selected.
hideButton Adds a hide button to the frame window.
Default value: The Default radio button is selected.
horizontalScroll Provides a horizontal scroll bar for the part.
Default value: The default is on, and the Default radio button is selected.
maximizeButton Adds a maximize button to the frame window.
Default value: The Default radio button is selected.
menuBar Provides the frame window with a menu bar.
Default value: The Default radio button is selected.
minimizeButton Adds a minimize button to the frame window.
Default value: The Default radio button is selected.
noMoveWithOwner Disables the default behavior of automatically moving frame
windows with their owner.
Default value: The Default radio button is selected.
shellPosition Sets the initial position of the window to a location and size
dictated by the system shell.
Default value: The Default radio button is selected.
sizingBorder Puts a sizing border around the frame window.
Default value: The Default radio button is selected.
systemMenu Provides a system menu in the frame window.
Default value: The Default radio button is selected.
systemModal Makes the part system-modal.
Default value: The Default radio button is selected.
titleBar Provides a title bar for the frame window.
Default value: The Default radio button is selected.
verticalScroll Provides a vertical scroll bar for the part.
Default value: The Default radio button is selected.
windowList Adds an entry for this frame window to the sytem window list.
Default value: The Default radio button is selected.
maximized Creates the frame window in the maximized state.
Default value: The Default radio button is selected.
minimized Creates the frame window in the minimized state.
Default value: The Default radio button is selected.
clipChildren Excludes the area occupied by the children of the window when
drawing in the window. Child windows are always "clipped" to their parent
window. When a parent window is painted, the clipChildren style controls
whether the invalidated region of the parent window includes the area
occupied by its children, thus preventing a window from painting over its
child windows.
Default value: The Default radio button is selected.
clipSiblings Controls which sibling window is displayed on top when multiple
siblings are displayed. Sibling windows are windows that share the same
parent window. Assign the clipSiblings style to the sibling window that you
want displayed on top of the other siblings, in Z-order.
Default value: The Default radio button is selected.
clipToParent Allows a window to paint outside of its window boundary up to the
window boundary of its parent.
Default value: The Default radio button is selected.
saveBits Optimizes the painting of a window by saving the screen image of the
area under the window as a bitmap and then using the bitmap to redraw the
window, when necessary.
Default value: The Default radio button is selected.
synchPaint Synchronously repaints the window. Without this style, painting
only occurs if there are no other events waiting to be processed.
Default value: The Default radio button is selected.
visible Makes the window visible. In general, controls are constructed as
visible, and frame windows are constructed as invisible.
Default value: The default is on, and the Default radio button is selected.
ΓòÉΓòÉΓòÉ <hidden> Handlers Settings - IFrameWindow ΓòÉΓòÉΓòÉ
Handler name Sets the name of the default handler.
Default value: None
Handler list Sets the name of the handler for the MLE control.
Default value: None
Add after Adds the new choice after the selected choice in the list. If no
choice is selected, the new choice is added after the first choice in the
list.
Default value: Highlighted
Add before Adds the new choice before the selected choice in the list. If no
choice is selected, the new choice is added before the first choice in the
list.
Default value: Not highlighted
Move Determines whether a part and its descendants can be moved to a new
location.
Default value: Not highlighted
Remove Removes one item from the part and returns the count of the number of
items that remain.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ <hidden> Color Settings - IFrameWindow ΓòÉΓòÉΓòÉ
Color area Sets the color of the given area. Choices are as follows:
Foreground
Sets the color for foreground text
Background
Sets the color for background text
Shadow
Sets the color of the frame window's shadow
Disabled background
Sets the background color for disabled text
Active
Sets the color to be used for the frame window's border when the
frame window is active.
Inactive
Sets the color to be used for the frame window's border when the
frame window is inactive.
Border
Sets the color of the border drawn around the children of the
frame window.
Default value: Foreground is selected
Color selection Enables color selection by either color values or RGB values.
Select Colors or RGB. If you select Colors, you can set the Color values. If
you select RGB, you can set the RGB values.
Default value: RGB selected
Color values Sets the color value of the window area, or sets the passed
default if no color for the area has been set.
Default value: None
RGB values Sets the color values for the window area.
Default value: Not set
ΓòÉΓòÉΓòÉ <hidden> Size/Position Settings - IFrameWindow ΓòÉΓòÉΓòÉ
X field Sets the X coordinate of the part.
Default value: The x coordinate of the part currently positioned on the
free-form surface
Y field Sets the Y coordinate of the point.
Default value: The y coordinate of the part currently positioned on the
free-form surface
Width Sets the width of the text.
Default value: None
Height Sets the height of the text.
Default value: None
Minimum size Determines the minimum size of the part.
Select Calculate at execution time or Set value here. If you select
Calculate at execution time, the minimum size is determined dynamically. If
you select Set value here, you can set the Minimum size Width and Height
fields to define a fixed minimum size.
Default value: Calculate at execution time is selected
Width Sets the minimum-allowable width, which is set by the user's class.
Default value: None (calculated at execution time)
Height Sets the minimum-allowable height, which is set by the user's class.
Default value: None (calculated at execution time)
ΓòÉΓòÉΓòÉ <hidden> Font Settings - IFrameWindow ΓòÉΓòÉΓòÉ
Name Sets the name of the font.
Default value: System proportional
Point size Sets the point size of the font.
Default value: 10
Style Sets the style for the part.
Default value: None
Emphasis Gives the part emphasis. If a part is specified, the emphasis is
drawn around the part.
Default value: None
Edit Opens an edit field on a part or setting.
Default value: Highlighted
Default font Sets the current default font style.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ 3.13. IGraphicPushButton ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Events
Settings Pages
General
Control
Styles
Handlers
Color
Size/Position
Font
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IGraphicPushButton ΓòÉΓòÉΓòÉ
Title: IBM push-button control with graphic
Class name: IGraphicPushButton
Base part: IPushButton
Part type: Visual part
Part file: vbbase.vbb
An IGraphicPushButton part is a selection button for an action or routing
choice. The choice is identified by a graphic image on the push button.
The user can click the push button to perform the indicated function.
Use an IGraphicPushButton part to let the user request a function that can be
represented graphically.
Alternatively, to identify the choice with text, use an IPushButton.
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - IGraphicPushButton ΓòÉΓòÉΓòÉ
When building with an IGraphicPushButton part, you can do the following:
Assign a bitmap to the graphic button. Do this by setting the DLL name
and the Resource ID fields on the IGraphicPushButton General settings
page.
Allow the user to reach the button by using a tab key. Do this by setting
the tabStop field to On on the IGraphicPushButton Styles settings page.
If the button is the first control in a group, allow the user to use
cursor keys to move between the button and follow controls in the group.
Do this by setting the group field to On on the IGraphicPushButton Styles
settings page.
Start the action represented by the button. Do this by connecting the
IGraphicPushButton buttonClickEvent feature to the action on the target
part.
Enable or disable the animated button when an event occurs.
Enable the button as follows:
1. Connect the event to the IGraphicPushButton enable action.
2. Open settings for the connection, press the Set parameters push
button, and check the enabled setting.
Disable the button by connecting the event to the IGraphicPushButton
disable action.
ΓòÉΓòÉΓòÉ <hidden> Attributes - IGraphicPushButton ΓòÉΓòÉΓòÉ
Attribute S E Data type
activeColor Γûá Γûá IColor
allowsMouseClickFocus Γûá Boolean
asDebugInfo IString
asString IString
autoDeleteObject Γûá Boolean
autoDestroyWindow Γûá Boolean
backgroundColor Γûá Γûá IColor
bidiSupported Boolean
bitmap Γûá IBitmapHandle
border Γûá Boolean
borderColor Γûá Γûá IColor
characterSize ISize
clipboardHasTextFormat Boolean
currentGraphicType GraphicType
default Γûá Boolean
defaultPushButton IWindowHandle
disabledBackgroundColor Γûá Γûá IColor
disabledForegroundColor Γûá Γûá IColor
displaySize ISize
enabled Γûá Γûá Boolean
enabledForNotification Γûá Boolean
focus Γûá Boolean
font Γûá Γûá IFont
foregroundColor Γûá Γûá IColor
frameWindow Boolean
graphicWindow IIconControl&
group Γûá Boolean
handle IWindowHandle
help Γûá Boolean
highlighted Boolean
hiliteBackgroundColor Γûá Γûá IColor
hiliteForegroundColor Γûá Γûá IColor
icon Γûá IPointerHandle
id Γûá unsigned long
inactiveColor Γûá Γûá IColor
isDigits Γûá
itemProvider Γûá IDMItemProvider*
layoutAdjustment IRectangle
marginSize Γûá ISize
menu
messageQueue IMessageQueueHandle
minimumSize Γûá ISize
nativeRect IRectangle
owner Γûá IWindow*
parent Γûá IWindow*
parentSize ISize
pointerCaptured Boolean
position Γûá Γûá IPoint
presSpace IPresSpaceHandle
rect Γûá IRectangle
shadowColor Γûá Γûá IColor
showing Boolean
size Γûá Γûá ISize
sizeToGraphic Γûá Boolean
systemCommand Γûá Γûá Boolean
tabStop Γûá Boolean
text Γûá Γûá IString
textLength Γûá unsigned long
valid Boolean
valueAsDouble Γûá Γûá
valueAsInt Γûá Γûá
valueAsUnsigned Γûá Γûá
visible Γûá Γûá Boolean
visibleRectangle IRectangle
ΓòÉΓòÉΓòÉ <hidden> Actions - IGraphicPushButton ΓòÉΓòÉΓòÉ
Action Parameters
applyBidiSettings BidiSettings&, Boolean, Boolean
capturePointer Boolean
click None
convertToGUIStyle IBitFlag&, Boolean
disable None
disableDefault None
disableGroup None
disableHelp None
disableMouseClickFocus None
disableNotification None
disableSizeToGraphic None
disableSystemCommand None
disableTabStop None
disableUpdate None
dispatchRemainingHandlers IEvent&, Boolean
enable Boolean
enableUpdate Boolean
handleException IException&, IEvent&
hide None
hideSourceEmphasis None
highlight Boolean
isLayoutDistorted unsigned long
matchForMnemonic unsigned short
notifyObservers INotificationEvent&
positionBehindSibling IWindowHandle&
positionBehindSiblings None
positionOnSiblings None
postEvent unsigned long, IEventParameter1&,
IEventParameter2&
refresh IRectangle&
releasePointer None
releasePresSpace IPresSpaceHandle&
removeBorder None
resetActiveColor None
resetBackgroundColor None
resetBorderColor None
resetDisabledBackgroundColor None
resetDisabledForegroundColor None
resetFont None
resetForegroundColor None
resetHiliteBackgroundColor None
resetHiliteForegroundColor None
resetInactiveColor None
resetMinimumSize None
resetShadowColor None
sendEvent unsigned long, IEventParameter1&,
IEventParameter2&
setFocus None
setLayoutDistorted unsigned long, unsigned long
show Boolean
showSourceEmphasis Boolean
unhighlight None
ΓòÉΓòÉΓòÉ <hidden> Events - IGraphicPushButton ΓòÉΓòÉΓòÉ
Event Notification ID
buttonClickEvent buttonClickId
commandEvent commandId
gotFocusEvent FOCUSTRUEID
inputDisabledEvent ENABLEFALSEID
inputEnabledEvent ENABLETRUEID
lostFocusEvent FOCUSFALSEID
systemCommandEvent systemCommandId
visibilityDisabledEvent VISIBLEFALSEID
visibilityEnabledEvent VISIBLETRUEID
ΓòÉΓòÉΓòÉ <hidden> General Settings - IGraphicPushButton ΓòÉΓòÉΓòÉ
Subpart name Sets the name of the subpart (a part placed on a composite part).
Default value: The name of the part
DLL name Sets the name of the DLL file to be loaded.
Default value: None
Resource ID Sets the name of the DLL and resource identifier for the part.
Default value: 0
ΓòÉΓòÉΓòÉ <hidden> Control Settings - IGraphicPushButton ΓòÉΓòÉΓòÉ
Fly over short text Specifies the short text for the fly-over text control.
Default value: None
Fly over long text Specifies the long text for the fly-over text control.
Default value: None
Window id Sets the window identifier.
Default value: None
Help panel id Sets the help panel identifier for the part.
Default value: None
Enabled Enables the handler by default.
Default value: Selected
ΓòÉΓòÉΓòÉ <hidden> Styles Settings - IGraphicPushButton ΓòÉΓòÉΓòÉ
defaultStyle() Resets the part to the original default style.
Default value: Selected
sizeToGraphic Sizes the window to the size of the currently set graphic.
Default value: The default is off, and the Default radio button is selected.
noBorder Suppresses the drawing of a border.
Default value: The Default radio button is selected.
defaultButton Specifies this push button as the default push button.
Default value: The default is on, and the Default radio button is selected.
Help Enables help for the part.
Default value: Not selected
systemCommand Generates a system command event when the user selects the part.
Default value: The default is off, and the Default radio button is selected.
noPointerFocus Allows the cursor stay on a control for which information is
required, rather than moving to the button. Buttons with this style do not
set the focus to themselves when the user clicks on them using the mouse.
This has no effect on keyboard interaction.
Default value: The Default radio button is selected.
group Identifies the control as being the first in a group. No other controls
in the group can have this style. Controls in the group must be siblings
that are constructed following the first control. The group can be cursored
and when the last control in the group is reached, the cursor returns the
first control in the group.
Default value: The default is off, and the Default radio button is selected.
tabStop Identifies the control as one to which the user can tab.
Default value: The default is off, and the Default radio button is selected.
clipChildren Excludes the area occupied by the children of the window when
drawing in the window. Child windows are always "clipped" to their parent
window. When a parent window is painted, the clipChildren style controls
whether the invalidated region of the parent window includes the area
occupied by its children, thus preventing a window from painting over its
child windows.
Default value: The Default radio button is selected.
clipSiblings Controls which sibling window is displayed on top when multiple
siblings are displayed. Sibling windows are windows that share the same
parent window. Assign the clipSiblings style to the sibling window that you
want displayed on top of the other siblings, in Z-order.
Default value: The Default radio button is selected.
clipToParent Allows a window to paint outside of its window boundary up to the
window boundary of its parent.
Default value: The Default radio button is selected.
saveBits Optimizes the painting of a window by saving the screen image of the
area under the window as a bitmap and then using the bitmap to redraw the
window, when necessary.
Default value: The Default radio button is selected.
synchPaint Synchronously repaints the window. Without this style, painting
only occurs if there are no other events waiting to be processed.
Default value: The Default radio button is selected.
visible Makes the window visible. In general, controls are constructed as
visible, and frame windows are constructed as invisible.
Default value: The default is on, and the Default radio button is selected.
ΓòÉΓòÉΓòÉ <hidden> Handlers Settings - IGraphicPushButton ΓòÉΓòÉΓòÉ
Handler name Sets the name of the default handler.
Default value: None
Handler list Sets the name of the handler for the MLE control.
Default value: None
Add after Adds the new choice after the selected choice in the list. If no
choice is selected, the new choice is added after the first choice in the
list.
Default value: Highlighted
Add before Adds the new choice before the selected choice in the list. If no
choice is selected, the new choice is added before the first choice in the
list.
Default value: Not highlighted
Move Determines whether a part and its descendants can be moved to a new
location.
Default value: Not highlighted
Remove Removes one item from the part and returns the count of the number of
items that remain.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ <hidden> Color Settings - IGraphicPushButton ΓòÉΓòÉΓòÉ
Color area Sets the color of the given area. Choices are as follows:
Foreground
Sets the color for foreground text
Background
Sets the color for background text
Disabled foreground
Sets the foreground color for disabled text
Highlighted foreground
Sets the foreground color for selected text
Border
Sets the color of the border that surrounds the part.
Default value: Foreground is selected
Color selection Enables color selection by either color values or RGB values.
Select Colors or RGB. If you select Colors, you can set the Color values. If
you select RGB, you can set the RGB values.
Default value: RGB selected
Color values Sets the color value of the window area, or sets the passed
default if no color for the area has been set.
Default value: None
RGB values Sets the color values for the window area.
Default value: Not set
ΓòÉΓòÉΓòÉ <hidden> Size/Position Settings - IGraphicPushButton ΓòÉΓòÉΓòÉ
X field Sets the X coordinate of the part.
Default value: The x coordinate of the part currently positioned on the
free-form surface
Y field Sets the Y coordinate of the point.
Default value: The y coordinate of the part currently positioned on the
free-form surface
Width Sets the width of the text.
Default value: None
Height Sets the height of the text.
Default value: None
Minimum size Determines the minimum size of the part.
Select Calculate at execution time or Set value here. If you select
Calculate at execution time, the minimum size is determined dynamically. If
you select Set value here, you can set the Minimum size Width and Height
fields to define a fixed minimum size.
Default value: Calculate at execution time is selected
Width Sets the minimum-allowable width, which is set by the user's class.
Default value: None (calculated at execution time)
Height Sets the minimum-allowable height, which is set by the user's class.
Default value: None (calculated at execution time)
ΓòÉΓòÉΓòÉ <hidden> Font Settings - IGraphicPushButton ΓòÉΓòÉΓòÉ
Name Sets the name of the font.
Default value: System proportional
Point size Sets the point size of the font.
Default value: 10
Style Sets the style for the part.
Default value: None
Emphasis Gives the part emphasis. If a part is specified, the emphasis is
drawn around the part.
Default value: None
Edit Opens an edit field on a part or setting.
Default value: Highlighted
Default font Sets the current default font style.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ 3.14. IGroupBox ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Events
Settings Pages
General
Control
Styles
Handlers
Color
Size/Position
Font
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IGroupBox ΓòÉΓòÉΓòÉ
Title: IBM group-box control
Class name: IGroupBox
Base part: ITextControl
Part type: Visual part
Part file: vbbase.vbb
An IGroupBox part is a labeled rectangular box that can contain a group of
related user-interface controls.
The user can move through the controls in a group using the keyboard cursor
keys. When the user moves the cursor forward from the last control in the
group, the cursor returns to the first control in the group.
Use an IGroupBox part to visually group a set of controls and label the group.
Alternatively, use an IOutlineBox part if you do not want to label the group.
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - IGroupBox ΓòÉΓòÉΓòÉ
When building with an IGroupBox part, you can do the following:
Define a set of related controls in a group box. Do this as follows:
1. Select an IGroupBox part from the parts palette and drop it on a
canvas.
2. Resize the group box to the size you think you need by selecting it
on the canvas and dragging a corner handle.
3. Add the controls you want in the group box. If you add the group box
after adding the controls you are enclosing, you must change the tabbing
and depth order of controls on the canvas to position the group box ahead
of the controls within it. Do this by clicking mouse button 2 on the
canvas and selecting the Tabbing And Depth Order choice. Then, press
mouse button 2 on the group box in the Tabbing And Depth Order panel and
drag it to a new position just before the first control it contains.
Define the text label for a group box. Do this by entering the label in
the Text field on the IGroupBox General settings page.
Make the controls in the group box a cursoring group that the user can
reach with a tab key. The user can cycle through controls in a cursoring
group using the keyboard cursor keys.
Do this by setting the group and tabStop fields to On on the Styles
settings page of the first control in the group box. Leave these fields
set to Off for the rest of the controls in the group box.
Also make sure that the first control following the group box on your
canvas has the group field set to On. This makes the last control in the
group box the end of the cursoring group. You can view and modify the
group and tabStop settings of controls in the Tabbing And Depth Order
panel.
ΓòÉΓòÉΓòÉ <hidden> Attributes - IGroupBox ΓòÉΓòÉΓòÉ
Attribute S E Data type
activeColor Γûá Γûá IColor
asDebugInfo IString
asString IString
autoDeleteObject Γûá Boolean
autoDestroyWindow Γûá Boolean
backgroundColor Γûá Γûá IColor
bidiSupported Boolean
borderColor Γûá Γûá IColor
characterSize ISize
clipboardHasTextFormat Boolean
defaultPushButton IWindowHandle
disabledBackgroundColor Γûá Γûá IColor
disabledForegroundColor Γûá Γûá IColor
displaySize ISize
enabled Γûá Γûá Boolean
enabledForNotification Γûá Boolean
focus Γûá Boolean
font Γûá Γûá IFont
foregroundColor Γûá Γûá IColor
frameWindow Boolean
group Γûá Boolean
handle IWindowHandle
hiliteBackgroundColor Γûá Γûá IColor
hiliteForegroundColor Γûá Γûá IColor
id Γûá unsigned long
inactiveColor Γûá Γûá IColor
isDigits Γûá
itemProvider Γûá IDMItemProvider*
layoutAdjustment IRectangle
menu
messageQueue IMessageQueueHandle
minimumSize Γûá ISize
nativeRect IRectangle
owner Γûá IWindow*
parent Γûá IWindow*
parentSize ISize
pointerCaptured Boolean
position Γûá Γûá IPoint
presSpace IPresSpaceHandle
rect Γûá IRectangle
shadowColor Γûá Γûá IColor
showing Boolean
size Γûá Γûá ISize
tabStop Γûá Boolean
text Γûá Γûá IString
textLength Γûá unsigned long
valid Boolean
valueAsDouble Γûá Γûá
valueAsInt Γûá Γûá
valueAsUnsigned Γûá Γûá
visible Γûá Γûá Boolean
visibleRectangle IRectangle
ΓòÉΓòÉΓòÉ <hidden> Actions - IGroupBox ΓòÉΓòÉΓòÉ
Action Parameters
applyBidiSettings BidiSettings&, Boolean, Boolean
capturePointer Boolean
convertToGUIStyle IBitFlag&, Boolean
disable None
disableGroup None
disableNotification None
disableTabStop None
disableUpdate None
dispatchRemainingHandlers IEvent&, Boolean
enable Boolean
enableUpdate Boolean
handleException IException&, IEvent&
hide None
hideSourceEmphasis None
isLayoutDistorted unsigned long
matchForMnemonic unsigned short
notifyObservers INotificationEvent&
positionBehindSibling IWindowHandle&
positionBehindSiblings None
positionOnSiblings None
postEvent unsigned long, IEventParameter1&,
IEventParameter2&
refresh IRectangle&
releasePointer None
releasePresSpace IPresSpaceHandle&
resetActiveColor None
resetBackgroundColor None
resetBorderColor None
resetDisabledBackgroundColor None
resetDisabledForegroundColor None
resetFont None
resetForegroundColor None
resetHiliteBackgroundColor None
resetHiliteForegroundColor None
resetInactiveColor None
resetMinimumSize None
resetShadowColor None
sendEvent unsigned long, IEventParameter1&,
IEventParameter2&
setFocus None
setLayoutDistorted unsigned long, unsigned long
show Boolean
showSourceEmphasis Boolean
ΓòÉΓòÉΓòÉ <hidden> Events - IGroupBox ΓòÉΓòÉΓòÉ
Event Notification ID
commandEvent commandId
gotFocusEvent FOCUSTRUEID
inputDisabledEvent ENABLEFALSEID
inputEnabledEvent ENABLETRUEID
lostFocusEvent FOCUSFALSEID
systemCommandEvent systemCommandId
visibilityDisabledEvent VISIBLEFALSEID
visibilityEnabledEvent VISIBLETRUEID
ΓòÉΓòÉΓòÉ <hidden> General Settings - IGroupBox ΓòÉΓòÉΓòÉ
Subpart name Sets the name of the subpart (a part placed on a composite part).
Default value: The name of the part
Text Sets the text for the part.
Default value: The name of the part
ΓòÉΓòÉΓòÉ <hidden> Control Settings - IGroupBox ΓòÉΓòÉΓòÉ
Fly over short text Specifies the short text for the fly-over text control.
Default value: None
Fly over long text Specifies the long text for the fly-over text control.
Default value: None
Window id Sets the window identifier.
Default value: None
Help panel id Sets the help panel identifier for the part.
Default value: None
Enabled Enables the handler by default.
Default value: Selected
ΓòÉΓòÉΓòÉ <hidden> Styles Settings - IGroupBox ΓòÉΓòÉΓòÉ
defaultStyle() Resets the part to the original default style.
Default value: Selected
clipChildren Excludes the area occupied by the children of the window when
drawing in the window. Child windows are always "clipped" to their parent
window. When a parent window is painted, the clipChildren style controls
whether the invalidated region of the parent window includes the area
occupied by its children, thus preventing a window from painting over its
child windows.
Default value: The Default radio button is selected.
clipSiblings Controls which sibling window is displayed on top when multiple
siblings are displayed. Sibling windows are windows that share the same
parent window. Assign the clipSiblings style to the sibling window that you
want displayed on top of the other siblings, in Z-order.
Default value: The Default radio button is selected.
clipToParent Allows a window to paint outside of its window boundary up to the
window boundary of its parent.
Default value: The Default radio button is selected.
saveBits Optimizes the painting of a window by saving the screen image of the
area under the window as a bitmap and then using the bitmap to redraw the
window, when necessary.
Default value: The Default radio button is selected.
synchPaint Synchronously repaints the window. Without this style, painting
only occurs if there are no other events waiting to be processed.
Default value: The Default radio button is selected.
visible Makes the window visible. In general, controls are constructed as
visible, and frame windows are constructed as invisible.
Default value: The default is on, and the Default radio button is selected.
ΓòÉΓòÉΓòÉ <hidden> Handlers Settings - IGroupBox ΓòÉΓòÉΓòÉ
Handler name Sets the name of the default handler.
Default value: None
Handler list Sets the name of the handler for the MLE control.
Default value: None
Add after Adds the new choice after the selected choice in the list. If no
choice is selected, the new choice is added after the first choice in the
list.
Default value: Highlighted
Add before Adds the new choice before the selected choice in the list. If no
choice is selected, the new choice is added before the first choice in the
list.
Default value: Not highlighted
Move Determines whether a part and its descendants can be moved to a new
location.
Default value: Not highlighted
Remove Removes one item from the part and returns the count of the number of
items that remain.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ <hidden> Color Settings - IGroupBox ΓòÉΓòÉΓòÉ
Color area Sets the color of the given area. Choices are as follows:
Foreground
Sets the color for foreground text
Border
Sets the color of the border that surrounds the part.
Default value: Foreground is selected
Color selection Enables color selection by either color values or RGB values.
Select Colors or RGB. If you select Colors, you can set the Color values. If
you select RGB, you can set the RGB values.
Default value: RGB selected
Color values Sets the color value of the window area, or sets the passed
default if no color for the area has been set.
Default value: None
RGB values Sets the color values for the static text.
Default value: Red=0, Green=0, Blue=170
ΓòÉΓòÉΓòÉ <hidden> Size/Position Settings - IGroupBox ΓòÉΓòÉΓòÉ
X field Sets the X coordinate of the part.
Default value: The x coordinate of the part currently positioned on the
free-form surface
Y field Sets the Y coordinate of the point.
Default value: The y coordinate of the part currently positioned on the
free-form surface
Width Sets the width of the text.
Default value: None
Height Sets the height of the text.
Default value: None
Minimum size Determines the minimum size of the part.
Select Calculate at execution time or Set value here. If you select
Calculate at execution time, the minimum size is determined dynamically. If
you select Set value here, you can set the Minimum size Width and Height
fields to define a fixed minimum size.
Default value: Calculate at execution time is selected
Width Sets the minimum-allowable width, which is set by the user's class.
Default value: None (calculated at execution time)
Height Sets the minimum-allowable height, which is set by the user's class.
Default value: None (calculated at execution time)
ΓòÉΓòÉΓòÉ <hidden> Font Settings - IGroupBox ΓòÉΓòÉΓòÉ
Name Sets the name of the font.
Default value: System proportional
Point size Sets the point size of the font.
Default value: 10
Style Sets the style for the part.
Default value: None
Emphasis Gives the part emphasis. If a part is specified, the emphasis is
drawn around the part.
Default value: None
Edit Opens an edit field on a part or setting.
Default value: Highlighted
Default font Sets the current default font style.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ 3.15. IHelpWindow ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Events
Settings Pages
General
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IHelpWindow ΓòÉΓòÉΓòÉ
Title: IBM window for online help
Class name: IHelpWindow
Base part: IWindow
Part type: Nonvisual part
Part file: vbbase.vbb
An IHelpWindow part is a window for presenting help information about your
application.
The user can open a help menu from a help menu, a help push button, or the F1
function key.
Use an IHelpWindow part to display help information for your application. The
help window represents your set of help panels. You can use the help window
for general and contextual help.
If you have one or more help files that you want presented in a single help
window for your application, add an IHelpWindow part in the composite part
providing the primary view. If you have separate help for each application
view, add an IHelpWindow part in each view.
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - IHelpWindow ΓòÉΓòÉΓòÉ
When building with an IHelpWindow part, you can do the following:
Define a help window for an application view. Do this as follows:
1. Drop an IHelpWindow part on the free-form surface of the composite
part for the view.
2. Type the names of your .hlp files, separated by spaces, in the Help
libraries field on the IHelpWindow General settings page.
3. Type the title for your help window in the Title field on the
IHelpWindow General settings page.
Identify the frame window that the help window is currently related to.
If you have only one frame window in your view, the help window is
automatically related to that frame window.
If you are using a single help window for multiple frame windows,
associate each secondary frame window with the help window. Do this by
connecting an event opening the secondary window to the
setAssociatedWindow action of the IHelpWindow, passing the frame window
as a parameter.
For example, if you open a secondary window when a push button is
pressed, connect the IPushButton buttonClickEvent feature to the
IHelpWindow setAssociatedWindow action. Then, connect the secondary
IFrameWindow this attribute to the
buttonClickEvent-to-setAssociatedWindow connection to provide the frame
window parameter.
Alternatively, if you create the secondary window dynamically with an
IVBFactory part, simply connect the IVBFactory newEvent feature to the
IHelpWindow setAssociatedWindow action. The newEvent feature provides the
frame window object as a parameter.
For each frame window and control, type the panel ID for its help in the
Help panel id field on its Control settings page. The panel ID is the
resource number specified with the res attribute of the help heading for
the frame window or control.
ΓòÉΓòÉΓòÉ <hidden> Attributes - IHelpWindow ΓòÉΓòÉΓòÉ
Attribute S E Data type
activeColor Γûá Γûá IColor
asDebugInfo IString
asString IString
autoDeleteObject Γûá Boolean
autoDestroyWindow Γûá Boolean
backgroundColor Γûá Γûá IColor
bidiSupported Boolean
borderColor Γûá Γûá IColor
characterSize ISize
communicationWindow IWindowHandle
contentsWindow IWindowHandle
coverPageWindow IWindowHandle
defaultPushButton IWindowHandle
disabledBackgroundColor Γûá Γûá IColor
disabledForegroundColor Γûá Γûá IColor
enabled Γûá Γûá Boolean
enabledForNotification Γûá Boolean
focus Γûá Boolean
font Γûá Γûá IFont
foregroundColor Γûá Γûá IColor
frameWindow Boolean
group Boolean
handle IWindowHandle
hiliteBackgroundColor Γûá Γûá IColor
hiliteForegroundColor Γûá Γûá IColor
id Γûá unsigned long
inactiveColor Γûá Γûá IColor
indexWindow IWindowHandle
itemProvider Γûá IDMItemProvider*
layoutAdjustment IRectangle
menu
messageQueue IMessageQueueHandle
minimumSize Γûá ISize
nativeRect IRectangle
owner Γûá IWindow*
parent Γûá IWindow*
parentSize ISize
pointerCaptured Boolean
position Γûá Γûá IPoint
presSpace IPresSpaceHandle
rect Γûá IRectangle
searchListWindow IWindowHandle
shadowColor Γûá Γûá IColor
showing Boolean
size Γûá Γûá ISize
tabStop Boolean
valid Boolean
viewedPagesWindow IWindowHandle
visible Γûá Γûá Boolean
visibleRectangle IRectangle
ΓòÉΓòÉΓòÉ <hidden> Actions - IHelpWindow ΓòÉΓòÉΓòÉ
Action Parameters
addLibraries char*
applyBidiSettings BidiSettings&, Boolean, Boolean
capturePointer Boolean
convertToGUIStyle IBitFlag&, Boolean
disable None
disableNotification None
disableUpdate None
dispatchRemainingHandlers IEvent&, Boolean
enable Boolean
enableUpdate Boolean
handleException IException&, IEvent&
helpWindow IWindow*
hide None
hidePanelIds None
hideSourceEmphasis None
isLayoutDistorted unsigned long
matchForMnemonic unsigned short
notifyObservers INotificationEvent&
positionBehindSibling IWindowHandle&
positionBehindSiblings None
positionOnSiblings None
postEvent unsigned long, IEventParameter1&,
IEventParameter2&
refresh IRectangle&
releasePointer None
releasePresSpace IPresSpaceHandle&
resetActiveColor None
resetBackgroundColor None
resetBorderColor None
resetDisabledBackgroundColor None
resetDisabledForegroundColor None
resetFont None
resetForegroundColor None
resetHiliteBackgroundColor None
resetHiliteForegroundColor None
resetInactiveColor None
resetMinimumSize None
resetShadowColor None
sendEvent unsigned long, IEventParameter1&,
IEventParameter2&
setActiveWindow IFrameWindow*, IFrameWindow*
setAssociatedWindow IFrameWindow*
setFocus None
setHelpTable IResourceId&
setLayoutDistorted unsigned long, unsigned long
setTitle char*
setUsingHelp unsigned long
show Boolean
showPanelIds Boolean
showSourceEmphasis Boolean
ΓòÉΓòÉΓòÉ <hidden> Events - IHelpWindow ΓòÉΓòÉΓòÉ
Event Notification ID
commandEvent commandId
gotFocusEvent FOCUSTRUEID
inputDisabledEvent ENABLEFALSEID
inputEnabledEvent ENABLETRUEID
lostFocusEvent FOCUSFALSEID
systemCommandEvent systemCommandId
visibilityDisabledEvent VISIBLEFALSEID
visibilityEnabledEvent VISIBLETRUEID
ΓòÉΓòÉΓòÉ <hidden> General Settings - IHelpWindow ΓòÉΓòÉΓòÉ
Subpart name Sets the name of the subpart (a part placed on a composite part).
Default value: The name of the part
Title Sets the title to appear on the title bar for the part.
Default value: None
Help libraries Sets the name of one or more compiled help (.hlp) files that
make up the help library.
Default value: None
Help table ID Sets the name of the help table.
Default value: None
ΓòÉΓòÉΓòÉ 3.16. IIconControl ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Events
Settings Pages
General
Control
Styles
Handlers
Color
Size/Position
Font
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IIconControl ΓòÉΓòÉΓòÉ
Title: IBM icon control
Class name: IIconControl
Base part: IBitmapControl
Part type: Visual part
Part file: vbbase.vbb
An IIconControl part draws an object image with a label.
The user can access the represented object by clicking on the icon with mouse
button1 or by pressing the Enter key when the cursor is on the icon.
Use an IIconControl part to display an icon representing a choice or an
object. Be aware that an icon is not resized on either a set canvas or a
multicell canvas when the canvas is resized.
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - IIconControl ΓòÉΓòÉΓòÉ
When building with an IIconControl part, you can do the following:
Assign an icon to the control. Do this by setting the DLL name and
Resource ID fields on the IIconControl General settings page.
Associate the icon control with an action. Do this by connecting the
IIconControl commandEvent feature to the target action.
ΓòÉΓòÉΓòÉ <hidden> Attributes - IIconControl ΓòÉΓòÉΓòÉ
Attribute S E Data type
activeColor Γûá Γûá IColor
alignment Γûá Alignment
asDebugInfo IString
asString IString
autoDeleteObject Γûá Boolean
autoDestroyWindow Γûá Boolean
backgroundColor Γûá Γûá IColor
bidiSupported Boolean
bitmap Γûá IBitmapHandle
borderColor Γûá Γûá IColor
characterSize ISize
clipboardHasTextFormat Boolean
defaultPushButton IWindowHandle
disabledBackgroundColor Γûá Γûá IColor
disabledForegroundColor Γûá Γûá IColor
displaySize ISize
enabled Γûá Γûá Boolean
enabledForNotification Γûá Boolean
fillBackground Γûá Γûá Boolean
fillColor Γûá Γûá IColor
focus Γûá Boolean
font Γûá Γûá IFont
foregroundColor Γûá Γûá IColor
frameWindow Boolean
group Γûá Boolean
halftone Γûá Γûá Boolean
handle IWindowHandle
hiliteBackgroundColor Γûá Γûá IColor
hiliteForegroundColor Γûá Γûá IColor
icon Γûá IPointerHandle
id Γûá unsigned long
inactiveColor Γûá Γûá IColor
isDigits Γûá
itemProvider Γûá IDMItemProvider*
layoutAdjustment IRectangle
limit Γûá Γûá unsigned long
menu
messageQueue IMessageQueueHandle
minimumSize Γûá ISize
nativeRect IRectangle
owner Γûá IWindow*
parent Γûá IWindow*
parentSize ISize
pointerCaptured Boolean
position Γûá Γûá IPoint
presSpace IPresSpaceHandle
rect Γûá IRectangle
shadowColor Γûá Γûá IColor
showing Boolean
size Γûá Γûá ISize
strikeout Γûá Γûá Boolean
tabStop Γûá Boolean
text Γûá Γûá IString
textLength Γûá unsigned long
underscore Γûá Γûá Boolean
valid Boolean
valueAsDouble Γûá Γûá
valueAsInt Γûá Γûá
valueAsUnsigned Γûá Γûá
visible Γûá Γûá Boolean
visibleRectangle IRectangle
ΓòÉΓòÉΓòÉ <hidden> Actions - IIconControl ΓòÉΓòÉΓòÉ
Action Parameters
applyBidiSettings BidiSettings&, Boolean, Boolean
capturePointer Boolean
convertToGUIStyle IBitFlag&, Boolean
disable None
disableFillBackground None
disableGroup None
disableHalftone None
disableNotification None
disableStrikeout None
disableTabStop None
disableUnderscore None
disableUpdate None
dispatchRemainingHandlers IEvent&, Boolean
enable Boolean
enableUpdate Boolean
handleException IException&, IEvent&
hide None
hideSourceEmphasis None
isLayoutDistorted unsigned long
matchForMnemonic unsigned short
notifyObservers INotificationEvent&
positionBehindSibling IWindowHandle&
positionBehindSiblings None
positionOnSiblings None
postEvent unsigned long, IEventParameter1&,
IEventParameter2&
refresh IRectangle&
releasePointer None
releasePresSpace IPresSpaceHandle&
resetActiveColor None
resetBackgroundColor None
resetBorderColor None
resetDisabledBackgroundColor None
resetDisabledForegroundColor None
resetFillColor None
resetFont None
resetForegroundColor None
resetHiliteBackgroundColor None
resetHiliteForegroundColor None
resetInactiveColor None
resetMinimumSize None
resetShadowColor None
sendEvent unsigned long, IEventParameter1&,
IEventParameter2&
setFocus None
setLayoutDistorted unsigned long, unsigned long
show Boolean
showSourceEmphasis Boolean
ΓòÉΓòÉΓòÉ <hidden> Events - IIconControl ΓòÉΓòÉΓòÉ
Event Notification ID
commandEvent commandId
gotFocusEvent FOCUSTRUEID
inputDisabledEvent ENABLEFALSEID
inputEnabledEvent ENABLETRUEID
lostFocusEvent FOCUSFALSEID
systemCommandEvent systemCommandId
visibilityDisabledEvent VISIBLEFALSEID
visibilityEnabledEvent VISIBLETRUEID
ΓòÉΓòÉΓòÉ <hidden> General Settings - IIconControl ΓòÉΓòÉΓòÉ
DLL name Sets the name of the DLL file to be loaded.
Default value: None
Resource Id Sets the resource identifier for the part.
Default value: 0
Subpart name Sets the name of the subpart (a part placed on a composite part).
Default value: The name of the part
Text Sets the text for the part.
Default value: The name of the part
Limit Sets the length (in bytes) of the longest text the part can hold.
Default value: 0
Alignment Changes the alignment of the part.
Default value: Upper left
Word wrap Enables word wrap of text around at the end of a line.
Default value: Not selected
ΓòÉΓòÉΓòÉ <hidden> Control Settings - IIconControl ΓòÉΓòÉΓòÉ
Fly over short text Specifies the short text for the fly-over text control.
Default value: None
Fly over long text Specifies the long text for the fly-over text control.
Default value: None
Window id Sets the window identifier.
Default value: None
Help panel id Sets the help panel identifier for the part.
Default value: None
Enabled Enables the handler by default.
Default value: Selected
ΓòÉΓòÉΓòÉ <hidden> Styles Settings - IIconControl ΓòÉΓòÉΓòÉ
defaultStyle() Resets the part to the original default style.
Default value: Selected
mnemonic Draws the next character with mnemonic emphasis if a mnemonic prefix
character is found.
Default value: The Default radio button is selected.
fillBackground Erases the background, using the currently set fill color
before drawing the text.
Default value: The default is on, and the Default radio button is selected.
halftone Draws the text in halftone color.
Default value: The default is off, and the Default radio button is selected.
strikeout Draws the text with overstriking.
Default value: The default is off, and the Default radio button is selected.
underscore Draws the text with underscoring.
Default value: The default is off, and the Default radio button is selected.
group Identifies the control as being the first in a group. No other controls
in the group can have this style. Controls in the group must be siblings
that are constructed following the first control. The group can be cursored
and when the last control in the group is reached, the cursor returns the
first control in the group.
Default value: The default is off, and the Default radio button is selected.
tabStop Identifies the control as one to which the user can tab.
Default value: The default is off, and the Default radio button is selected.
clipChildren Excludes the area occupied by the children of the window when
drawing in the window. Child windows are always "clipped" to their parent
window. When a parent window is painted, the clipChildren style controls
whether the invalidated region of the parent window includes the area
occupied by its children, thus preventing a window from painting over its
child windows.
Default value: The Default radio button is selected.
clipSiblings Controls which sibling window is displayed on top when multiple
siblings are displayed. Sibling windows are windows that share the same
parent window. Assign the clipSiblings style to the sibling window that you
want displayed on top of the other siblings, in Z-order.
Default value: The Default radio button is selected.
clipToParent Allows a window to paint outside of its window boundary up to the
window boundary of its parent.
Default value: The Default radio button is selected.
saveBits Optimizes the painting of a window by saving the screen image of the
area under the window as a bitmap and then using the bitmap to redraw the
window, when necessary.
Default value: The Default radio button is selected.
synchPaint Synchronously repaints the window. Without this style, painting
only occurs if there are no other events waiting to be processed.
Default value: The Default radio button is selected.
visible Makes the window visible. In general, controls are constructed as
visible, and frame windows are constructed as invisible.
Default value: The default is on, and the Default radio button is selected.
ΓòÉΓòÉΓòÉ <hidden> Handlers Settings - IIconControl ΓòÉΓòÉΓòÉ
Handler name Sets the name of the default handler.
Default value: None
Handler list Sets the name of the handler for the MLE control.
Default value: None
Add after Adds the new choice after the selected choice in the list. If no
choice is selected, the new choice is added after the first choice in the
list.
Default value: Highlighted
Add before Adds the new choice before the selected choice in the list. If no
choice is selected, the new choice is added before the first choice in the
list.
Default value: Not highlighted
Move Determines whether a part and its descendants can be moved to a new
location.
Default value: Not highlighted
Remove Removes one item from the part and returns the count of the number of
items that remain.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ <hidden> Color Settings - IIconControl ΓòÉΓòÉΓòÉ
Color area Sets the color of the given area. Choices are as follows:
Foreground
Sets the color for foreground text
Background
Sets the color for background text that surrounds the part
Fill
Sets the color for the area of the part that is not occupied by
text
Default value: Foreground is selected
Color selection Enables color selection by either color values or RGB values.
Select Colors or RGB. If you select Colors, you can set the Color values. If
you select RGB, you can set the RGB values.
Default value: RGB selected
Color values Sets the color value of the window area, or sets the passed
default if no color for the area has been set.
Default value: None
RGB values Sets the color values for the static text.
Default value: Red=0, Green=0, Blue=170
ΓòÉΓòÉΓòÉ <hidden> Size/Position Settings - IIconControl ΓòÉΓòÉΓòÉ
X field Sets the X coordinate of the part.
Default value: The x coordinate of the part currently positioned on the
free-form surface
Y field Sets the Y coordinate of the point.
Default value: The y coordinate of the part currently positioned on the
free-form surface
Width Sets the width of the text.
Default value: None
Height Sets the height of the text.
Default value: None
Minimum size Determines the minimum size of the part.
Select Calculate at execution time or Set value here. If you select
Calculate at execution time, the minimum size is determined dynamically. If
you select Set value here, you can set the Minimum size Width and Height
fields to define a fixed minimum size.
Default value: Calculate at execution time is selected
Width Sets the minimum-allowable width, which is set by the user's class.
Default value: None (calculated at execution time)
Height Sets the minimum-allowable height, which is set by the user's class.
Default value: None (calculated at execution time)
ΓòÉΓòÉΓòÉ <hidden> Font Settings - IIconControl ΓòÉΓòÉΓòÉ
Name Sets the name of the font.
Default value: System proportional
Point size Sets the point size of the font.
Default value: 10
Style Sets the style for the part.
Default value: None
Emphasis Gives the part emphasis. If a part is specified, the emphasis is
drawn around the part.
Default value: None
Edit Opens an edit field on a part or setting.
Default value: Highlighted
Default font Sets the current default font style.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ 3.17. IInfoArea ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Events
Settings Pages
General
Color
Handlers
Font
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IInfoArea ΓòÉΓòÉΓòÉ
Title: IBM frame extention to show user prompts
Class name: IInfoArea
Base part: IStaticText
Part type: Visual part
Part file: vbbase.vbb
An IInfoArea part is a window area at the bottom of a frame window for
displaying brief information about a selected menu choice.
The user can read help information in the information area without opening
another window for help.
Use an IInfoArea part to briefly describe menu choices or to report the
successful completion of a selected action.
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - IInfoArea ΓòÉΓòÉΓòÉ
When building with an IInfoArea part, you can do the following:
Attach an information area to a frame window. Do this by selecting an
IInfoArea from the parts palette and dropping it on the frame window. The
information area is attached as a frame extension at the bottom of the
frame window, beneath the client area.
Define text to appear in the information area for a menu item. Do this by
entering text for the information area in the settings view for the
IMenuItem part.
Define text to appear in the information area when the user has not
selected a menu choice. Do this by entering text in the Inactive text
field on the IInfoArea General settings page.
Define text to appear in the information area when the user selects a
disabled menu choice. Do this by entering text in the Disabled text field
on the IInfoArea General settings page.
Define text to appear in the information area when the user selects a
menu choice that has no information area text defined. Do this by
entering text in the Missing text field on the IInfoArea General settings
page.
ΓòÉΓòÉΓòÉ <hidden> Attributes - IInfoArea ΓòÉΓòÉΓòÉ
Attribute S E Data type
activeColor Γûá Γûá IColor
alignment Γûá Alignment
asDebugInfo IString
asString IString
autoDeleteObject Γûá Boolean
autoDestroyWindow Γûá Boolean
backgroundColor Γûá Γûá IColor
bidiSupported Boolean
borderColor Γûá Γûá IColor
characterSize ISize
clipboardHasTextFormat Boolean
defaultPushButton IWindowHandle
disabledBackgroundColor Γûá Γûá IColor
disabledForegroundColor Γûá Γûá IColor
disabledText Γûá Γûá IString
displaySize ISize
enabled Γûá Γûá Boolean
enabledForNotification Γûá Boolean
fillBackground Γûá Γûá Boolean
fillColor Γûá Γûá IColor
focus Γûá Boolean
font Γûá Γûá IFont
foregroundColor Γûá Γûá IColor
frameWindow Boolean
group Γûá Boolean
halftone Γûá Γûá Boolean
handle IWindowHandle
hiliteBackgroundColor Γûá Γûá IColor
hiliteForegroundColor Γûá Γûá IColor
id Γûá unsigned long
inactiveColor Γûá Γûá IColor
inactiveText Γûá Γûá IString
isDigits Γûá
itemProvider Γûá IDMItemProvider*
layoutAdjustment IRectangle
limit Γûá Γûá unsigned long
lineCount Γûá unsigned long
menu
messageQueue IMessageQueueHandle
minimumSize Γûá ISize
missingText Γûá Γûá IString
nativeRect IRectangle
owner Γûá IWindow*
parent Γûá IWindow*
parentSize ISize
pointerCaptured Boolean
position Γûá Γûá IPoint
presSpace IPresSpaceHandle
rect Γûá IRectangle
resourceLibrary Γûá Γûá IResourceLibrary&
shadowColor Γûá Γûá IColor
showing Boolean
size Γûá Γûá ISize
strikeout Γûá Γûá Boolean
stringTableOffset Γûá long
tabStop Γûá Boolean
text Γûá Γûá IString
textLength Γûá unsigned long
underscore Γûá Γûá Boolean
valid Boolean
valueAsDouble Γûá Γûá
valueAsInt Γûá Γûá
valueAsUnsigned Γûá Γûá
visible Γûá Γûá Boolean
visibleRectangle IRectangle
ΓòÉΓòÉΓòÉ <hidden> Actions - IInfoArea ΓòÉΓòÉΓòÉ
Action Parameters
applyBidiSettings BidiSettings&, Boolean, Boolean
capturePointer Boolean
convertToGUIStyle IBitFlag&, Boolean
disable None
disableFillBackground None
disableGroup None
disableHalftone None
disableNotification None
disableStrikeout None
disableTabStop None
disableUnderscore None
disableUpdate None
dispatchRemainingHandlers IEvent&, Boolean
enable Boolean
enableUpdate Boolean
handleException IException&, IEvent&
hide None
hideSourceEmphasis None
isLayoutDistorted unsigned long
matchForMnemonic unsigned short
notifyObservers INotificationEvent&
positionBehindSibling IWindowHandle&
positionBehindSiblings None
positionOnSiblings None
postEvent unsigned long, IEventParameter1&,
IEventParameter2&
refresh IRectangle&
releasePointer None
releasePresSpace IPresSpaceHandle&
resetActiveColor None
resetBackgroundColor None
resetBorderColor None
resetDisabledBackgroundColor None
resetDisabledForegroundColor None
resetFillColor None
resetFont None
resetForegroundColor None
resetHiliteBackgroundColor None
resetHiliteForegroundColor None
resetInactiveColor None
resetMinimumSize None
resetShadowColor None
sendEvent unsigned long, IEventParameter1&,
IEventParameter2&
setFocus None
setLayoutDistorted unsigned long, unsigned long
show Boolean
showSourceEmphasis Boolean
start IFrameWindow*
stop IFrameWindow*
ΓòÉΓòÉΓòÉ <hidden> Events - IInfoArea ΓòÉΓòÉΓòÉ
Event Notification ID
commandEvent commandId
gotFocusEvent FOCUSTRUEID
inputDisabledEvent ENABLEFALSEID
inputEnabledEvent ENABLETRUEID
lostFocusEvent FOCUSFALSEID
systemCommandEvent systemCommandId
visibilityDisabledEvent VISIBLEFALSEID
visibilityEnabledEvent VISIBLETRUEID
ΓòÉΓòÉΓòÉ <hidden> General Settings - IInfoArea ΓòÉΓòÉΓòÉ
Subpart name Sets the name of the subpart (a part placed on a composite part).
Default value: The name of the part
Inactive text Sets the text to appear in the information area when the user
has not selected a menu choice.
Default value: None
Disabled text Sets the text to appear in the information area when the user
selects a disabled a menu choice.
Default value: None
Missing text Sets the text to appear in the information area when the user
selects a menu choice where no information area text has been defined.
Default value: None
ΓòÉΓòÉΓòÉ <hidden> Color Settings - IInfoArea ΓòÉΓòÉΓòÉ
Color area Sets the color of the given area. Choices are as follows:
Foreground
Sets the color for foreground text
Background
Sets the color for background text that surrounds the part
Fill
Sets the color for the area of the part that is not occupied by
text
Default value: Foreground is selected
Color selection Enables color selection by either color values or RGB values.
Select Colors or RGB. If you select Colors, you can set the Color values. If
you select RGB, you can set the RGB values.
Default value: RGB selected
Color values Sets the color value of the window area, or sets the passed
default if no color for the area has been set.
Default value: None
RGB values Sets the color values for the static text.
Default value: Red=0, Green=0, Blue=170
ΓòÉΓòÉΓòÉ <hidden> Handlers Settings - IInfoArea ΓòÉΓòÉΓòÉ
Handler name Sets the name of the default handler.
Default value: None
Handler list Sets the name of the handler for the MLE control.
Default value: None
Add after Adds the new choice after the selected choice in the list. If no
choice is selected, the new choice is added after the first choice in the
list.
Default value: Highlighted
Add before Adds the new choice before the selected choice in the list. If no
choice is selected, the new choice is added before the first choice in the
list.
Default value: Not highlighted
Move Determines whether a part and its descendants can be moved to a new
location.
Default value: Not highlighted
Remove Removes one item from the part and returns the count of the number of
items that remain.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ <hidden> Font Settings - IInfoArea ΓòÉΓòÉΓòÉ
Name Sets the name of the font.
Default value: System proportional
Point size Sets the point size of the font.
Default value: 10
Style Sets the style for the part.
Default value: None
Emphasis Gives the part emphasis. If a part is specified, the emphasis is
drawn around the part.
Default value: None
Edit Opens an edit field on a part or setting.
Default value: Highlighted
Default font Sets the current default font style.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ 3.18. IListBox ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Events
Settings Pages
General
Control
Styles
Handlers
Color
Size/Position
Font
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IListBox ΓòÉΓòÉΓòÉ
Title: IBM list-box control
Class name: IListBox
Base part: IBaseListBox
Part type: Visual part
Part file: vbbase.vbb
An IListBox part is a selection list for string choices.
By default, the user can select only one choice from the list. When the user
selects a choice, any previously selected choice is no longer selected. You
can change the behavior of the list box to allow multiple selection.
Use an IListBox part to provide a modifiable list of string choices for the
user. Your application can add or remove choices from the list.
Alternatively, for string selection from an entry field or a drop-down list,
use one of the following IComboBox types:
Drop-down Allows the user to type a choice or to select a choice from a
drop-down list.
Read-only drop-down Allows the user only to select a choice from a drop-down
list.
Simple Allows the user to type a choice or to select a choice from a list that
is always displayed.
You can provide only single selection with a combination box part.
For selection of objects in a collection rather than strings, use an
ICollectionViewComboBox part or an ICollectionViewListBox part.
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - IListBox ΓòÉΓòÉΓòÉ
When building with an IListBox part, you can do the following:
Define initial selection choices for the list box. Do this by entering
the choices in the Contents field on the IListBox General settings page.
Allow the user to select more than one choice from the list. Do this by
selecting the multipleSelection field on the IListBox Styles settings
page.
Allow the user to reach the list box by using a tab key. Do this by
setting the tabStop field to On on the IListBox Styles settings page.
Copy the index of the selection to a numeric connection parameter or
attribute. Do this by connecting the IListBox selection attribute to the
numeric target.
Add a new choice to the list box from an entry field when a push button
is pressed. Add the choice to the end of the list. Do this as follows:
1. Connect the IPushButton buttonClickEvent feature to the addAsLast
action of the IListBox.
2. Connect the IEntryField text attribute to the text parameter of the
buttonClickEvent-to-addAsLast connection. This provides the entry
field text as the parameter for the addAsLast action.
Remove the selected choice from the list box when a push button is
pressed. Do this as follows:
1. Connect the IPushButton buttonClickEvent feature to the remove
action of the IListBox.
2. Connect the IListBox selection attribute to the index parameter of
the buttonClickEvent-to-remove connection. This provides the
selection index as the parameter for the remove action.
ΓòÉΓòÉΓòÉ <hidden> Attributes - IListBox ΓòÉΓòÉΓòÉ
Attribute S E Data type
activeColor Γûá Γûá IColor
asDebugInfo IString
asString IString
autoDeleteObject Γûá Boolean
autoDestroyWindow Γûá Boolean
backgroundColor Γûá Γûá IColor
bidiSupported Boolean
borderColor Γûá Γûá IColor
characterSize ISize
count unsigned long
defaultPushButton IWindowHandle
disabledBackgroundColor Γûá Γûá IColor
disabledForegroundColor Γûá Γûá IColor
drawItem Γûá Boolean
empty Boolean
enabled Γûá Γûá Boolean
enabledForNotification Γûá Boolean
extendedSelect Γûá Boolean
focus Γûá Boolean
font Γûá Γûá IFont
foregroundColor Γûá Γûá IColor
frameWindow Boolean
group Γûá Boolean
handle IWindowHandle
hiliteBackgroundColor Γûá Γûá IColor
hiliteForegroundColor Γûá Γûá IColor
horizontalScroll Boolean
id Γûá unsigned long
inactiveColor Γûá Γûá IColor
itemProvider Γûá IDMItemProvider*
layoutAdjustment IRectangle
menu
messageQueue IMessageQueueHandle
minimumCharacters Γûá unsigned long
minimumRows Γûá unsigned long
minimumSize Γûá ISize
multipleSelect Γûá Boolean
nativeRect IRectangle
noAdjustPosition Γûá Boolean
numberOfSelections unsigned long
owner Γûá IWindow*
parent Γûá IWindow*
parentSize ISize
pointerCaptured Boolean
position Γûá Γûá IPoint
presSpace IPresSpaceHandle
rect Γûá IRectangle
selection long
shadowColor Γûá Γûá IColor
showing Boolean
size Γûá Γûá ISize
tabStop Γûá Boolean
top Γûá unsigned long
valid Boolean
visible Γûá Γûá Boolean
visibleRectangle IRectangle
ΓòÉΓòÉΓòÉ <hidden> Actions - IListBox ΓòÉΓòÉΓòÉ
Action Parameters
add unsigned long, char * const*, unsigned long
addAscending char*
addAsFirst char*
addAsLast IResourceId&
addDescending char*
applyBidiSettings BidiSettings&, Boolean, Boolean
capturePointer Boolean
convertToGUIStyle IBitFlag&, Boolean
deselect unsigned long
deselectAll None
disable None
disableDrawItem None
disableExtendedSelect None
disableGroup None
disableMultipleSelect None
disableNoAdjustPosition None
disableNotification None
disableTabStop None
disableUpdate None
dispatchRemainingHandlers IEvent&, Boolean
enable Boolean
enableUpdate Boolean
handleException IException&, IEvent&
hide None
hideSourceEmphasis None
isLayoutDistorted unsigned long
isSelected unsigned long
itemHandle unsigned long
itemText unsigned long
locateText char*, Boolean, SearchType, unsigned long
matchForMnemonic unsigned short
notifyObservers INotificationEvent&
positionBehindSibling IWindowHandle&
positionBehindSiblings None
positionOnSiblings None
postEvent unsigned long, IEventParameter1&,
IEventParameter2&
refresh IRectangle&
releasePointer None
releasePresSpace IPresSpaceHandle&
remove unsigned long
removeAll None
resetActiveColor None
resetBackgroundColor None
resetBorderColor None
resetDisabledBackgroundColor None
resetDisabledForegroundColor None
resetFont None
resetForegroundColor None
resetHiliteBackgroundColor None
resetHiliteForegroundColor None
resetInactiveColor None
resetMinimumSize None
resetShadowColor None
select unsigned long, Boolean
selectAll None
sendEvent unsigned long, IEventParameter1&,
IEventParameter2&
setFocus None
setItemHandle unsigned long, unsigned long
setItemHeight unsigned long
setItemText unsigned long, IResourceId&
setLayoutDistorted unsigned long, unsigned long
show Boolean
showSourceEmphasis Boolean
ΓòÉΓòÉΓòÉ <hidden> Events - IListBox ΓòÉΓòÉΓòÉ
Event Notification ID
commandEvent commandId
enterEvent enterId
gotFocusEvent FOCUSTRUEID
inputDisabledEvent ENABLEFALSEID
inputEnabledEvent ENABLETRUEID
lostFocusEvent FOCUSFALSEID
systemCommandEvent systemCommandId
visibilityDisabledEvent VISIBLEFALSEID
visibilityEnabledEvent VISIBLETRUEID
ΓòÉΓòÉΓòÉ <hidden> General Settings - IListBox ΓòÉΓòÉΓòÉ
Subpart name Sets the name of the subpart (a part placed on a composite part).
Default value: The name of the part
Contents Sets initial items for the part.
Default value: None
ΓòÉΓòÉΓòÉ <hidden> Control Settings - IListBox ΓòÉΓòÉΓòÉ
Fly over short text Specifies the short text for the fly-over text control.
Default value: None
Fly over long text Specifies the long text for the fly-over text control.
Default value: None
Window id Sets the window identifier.
Default value: None
Help panel id Sets the help panel identifier for the part.
Default value: None
Enabled Enables the handler by default.
Default value: Selected
ΓòÉΓòÉΓòÉ <hidden> Styles Settings - IListBox ΓòÉΓòÉΓòÉ
defaultStyle() Resets the part to the original default style.
Default value: Selected
Draw item Allows the menu item to be drawn.
Default value: Not selected
horizontalScroll Provides a horizontal scroll bar for the part.
Default value: The default is on, and the Default radio button is selected.
multipleSelect Sets the style of the part to multiple selection mode.
Default value: The default is off, and the Default radio button is selected.
noAdjustPosition Restricts adjustment of the frame position of the part. As a
result, certain aspects of enhanced performance by such alignment are lost.
Default value: The default is on, and the Default radio button is selected.
group Identifies the control as being the first in a group. No other controls
in the group can have this style. Controls in the group must be siblings
that are constructed following the first control. The group can be cursored
and when the last control in the group is reached, the cursor returns the
first control in the group.
Default value: The default is off, and the Default radio button is selected.
tabStop Identifies the control as one to which the user can tab.
Default value: The default is off, and the Default radio button is selected.
clipChildren Excludes the area occupied by the children of the window when
drawing in the window. Child windows are always "clipped" to their parent
window. When a parent window is painted, the clipChildren style controls
whether the invalidated region of the parent window includes the area
occupied by its children, thus preventing a window from painting over its
child windows.
Default value: The Default radio button is selected.
clipSiblings Controls which sibling window is displayed on top when multiple
siblings are displayed. Sibling windows are windows that share the same
parent window. Assign the clipSiblings style to the sibling window that you
want displayed on top of the other siblings, in Z-order.
Default value: The Default radio button is selected.
clipToParent Allows a window to paint outside of its window boundary up to the
window boundary of its parent.
Default value: The Default radio button is selected.
saveBits Optimizes the painting of a window by saving the screen image of the
area under the window as a bitmap and then using the bitmap to redraw the
window, when necessary.
Default value: The Default radio button is selected.
synchPaint Synchronously repaints the window. Without this style, painting
only occurs if there are no other events waiting to be processed.
Default value: The Default radio button is selected.
visible Makes the window visible. In general, controls are constructed as
visible, and frame windows are constructed as invisible.
Default value: The default is on, and the Default radio button is selected.
ΓòÉΓòÉΓòÉ <hidden> Handlers Settings - IListBox ΓòÉΓòÉΓòÉ
Handler name Sets the name of the default handler.
Default value: None
Handler list Sets the name of the handler for the MLE control.
Default value: None
Add after Adds the new choice after the selected choice in the list. If no
choice is selected, the new choice is added after the first choice in the
list.
Default value: Highlighted
Add before Adds the new choice before the selected choice in the list. If no
choice is selected, the new choice is added before the first choice in the
list.
Default value: Not highlighted
Move Determines whether a part and its descendants can be moved to a new
location.
Default value: Not highlighted
Remove Removes one item from the part and returns the count of the number of
items that remain.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ <hidden> Color Settings - IListBox ΓòÉΓòÉΓòÉ
Color area Sets the color of the given area. Choices are as follows:
Foreground
Sets the color for foreground text
Background
Sets the color for background text
Disabled foreground
Sets the foreground color for disabled text
Highlighted foreground
Sets the foreground color for selected text
Border
Sets the color of the border that surrounds the part.
Default value: Foreground is selected
Color selection Enables color selection by either color values or RGB values.
Select Colors or RGB. If you select Colors, you can set the Color values. If
you select RGB, you can set the RGB values.
Default value: RGB selected
Color values Sets the color value of the window area, or sets the passed
default if no color for the area has been set.
Default value: None
RGB values Sets the color values for the window area.
Default value: Not set
ΓòÉΓòÉΓòÉ <hidden> Size/Position Settings - IListBox ΓòÉΓòÉΓòÉ
X field Sets the X coordinate of the part.
Default value: The x coordinate of the part currently positioned on the
free-form surface
Y field Sets the Y coordinate of the point.
Default value: The y coordinate of the part currently positioned on the
free-form surface
Width Sets the width of the text.
Default value: None
Height Sets the height of the text.
Default value: None
Minimum size Determines the minimum size of the part.
Select Calculate at execution time or Set value here. If you select
Calculate at execution time, the minimum size is determined dynamically. If
you select Set value here, you can set the Minimum size Width and Height
fields to define a fixed minimum size.
Default value: Calculate at execution time is selected
Width Sets the minimum-allowable width, which is set by the user's class.
Default value: None (calculated at execution time)
Height Sets the minimum-allowable height, which is set by the user's class.
Default value: None (calculated at execution time)
ΓòÉΓòÉΓòÉ <hidden> Font Settings - IListBox ΓòÉΓòÉΓòÉ
Name Sets the name of the font.
Default value: System proportional
Point size Sets the point size of the font.
Default value: 10
Style Sets the style for the part.
Default value: None
Emphasis Gives the part emphasis. If a part is specified, the emphasis is
drawn around the part.
Default value: None
Edit Opens an edit field on a part or setting.
Default value: Highlighted
Default font Sets the current default font style.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ 3.19. IMenu ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Events
Settings Pages
General
Styles
Color
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IMenu ΓòÉΓòÉΓòÉ
Title: IBM menu control
Class name: IMenu
Base part: IWindow
Part type: Nonvisual part
Part file: vbbase.vbb
An IMenu part is a list of action, routing, and settings choices related to an
object. Depending on your use of the menu, it is implemented by one of the
following parts:
IMenuBar
IPopUpMenu
ISubmenu
An IMenuBar part is a menu of routing choices for objects in a window. The
choices appear in a horizontal bar beneath the title bar. Each choice opens a
pull-down menu.
An IPopUpMenu part is a menu of context-sensitive choices for one or more
objects. The choices appear in a pop-up window near the objects.
An ISubmenu part is a list of action, routing, and settings choices in a menu
opened from another menu. The menu is either a pull-down menu opened from a
menu bar or a cascade menu opened from another menu.
The user can select a choice, or menu item, to apply the choice to the object.
Use an IMenu part to provide a list of choices related to an object.
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - IMenu ΓòÉΓòÉΓòÉ
When building with an IMenu part, you can do the following:
Attach the menu to one of the following:
Target Resulting menu
Frame window Menu bar (IMenuBar)
Menu bar cascade choice Pull-down menu (ISubmenu)
Cascade menu choice Cascade menu (ISubmenu)
Any object with menu support Pop-up menu (IPopUpMenu)
Do this by connecting the IMenu this attribute to the menu attribute of
the target.
As a shortcut for adding a pull-down menu or a cascade menu, drop an
IMenu part on the target menu instead of on the free-form surface. In
this case, the following happens automatically:
- The new menu is placed on the free-form surface.
- A cascade menu item is added to the target menu.
- The this-to-menu connection is automatically made between the new
menu and the cascade menu item.
ΓòÉΓòÉΓòÉ <hidden> Attributes - IMenu ΓòÉΓòÉΓòÉ
Attribute S E Data type
activeColor Γûá Γûá IColor
asDebugInfo IString
asString IString
autoDeleteObject Γûá Boolean
autoDestroyWindow Γûá Boolean
backgroundColor Γûá Γûá IColor
bidiSupported Boolean
borderColor Γûá Γûá IColor
characterSize ISize
defaultPushButton IWindowHandle
disabledBackgroundColor Γûá Γûá IColor
disabledForegroundColor Γûá Γûá IColor
enabled Γûá Γûá Boolean
enabledForNotification Γûá Boolean
focus Γûá Boolean
font Γûá Γûá IFont
foregroundColor Γûá Γûá IColor
frameWindow Boolean
group Boolean
handle IWindowHandle
hiliteBackgroundColor Γûá Γûá IColor
hiliteForegroundColor Γûá Γûá IColor
id Γûá unsigned long
inactiveColor Γûá Γûá IColor
itemProvider Γûá IDMItemProvider*
layoutAdjustment IRectangle
menu
menuHandle IMenuHandle
messageQueue IMessageQueueHandle
minimumSize Γûá ISize
nativeRect IRectangle
numberOfItems unsigned long
owner Γûá IWindow*
parent Γûá IWindow*
parentSize ISize
pointerCaptured Boolean
position Γûá Γûá IPoint
presSpace IPresSpaceHandle
rect Γûá IRectangle
shadowColor Γûá Γûá IColor
showing Boolean
size Γûá Γûá ISize
tabStop Boolean
valid Boolean
visible Γûá Γûá Boolean
visibleRectangle IRectangle
ΓòÉΓòÉΓòÉ <hidden> Actions - IMenu ΓòÉΓòÉΓòÉ
Action Parameters
addBitmap unsigned long, unsigned long, unsigned long
addItem IMenuItem&, unsigned long
addSeparator unsigned long
addSubmenu unsigned long
addText unsigned long, IResourceId&, unsigned long
applyBidiSettings BidiSettings&, Boolean, Boolean
capturePointer Boolean
checkItem unsigned long, Boolean
convertToGUIStyle IBitFlag&, Boolean
cursor unsigned long, unsigned long
deleteItem unsigned long
disable None
disableItem unsigned long
disableNotification None
disableUpdate None
dispatchRemainingHandlers IEvent&, Boolean
enable Boolean
enableItem unsigned long, Boolean
enableUpdate Boolean
handleException IException&, IEvent&
hide None
hideSourceEmphasis None
isItemChecked unsigned long
isItemEnabled unsigned long
isLayoutDistorted unsigned long
itemRect unsigned long
matchForMnemonic unsigned short
menuItem unsigned long
notifyObservers INotificationEvent&
positionBehindSibling IWindowHandle&
positionBehindSiblings None
positionOnSiblings None
postEvent unsigned long, IEventParameter1&,
IEventParameter2&
refresh IRectangle&
releasePointer None
releasePresSpace IPresSpaceHandle&
removeConditionalCascade unsigned long
removeSubmenu unsigned long
resetActiveColor None
resetBackgroundColor None
resetBorderColor None
resetDisabledBackgroundColor None
resetDisabledForegroundColor None
resetFont None
resetForegroundColor None
resetHiliteBackgroundColor None
resetHiliteForegroundColor None
resetInactiveColor None
resetMinimumSize None
resetShadowColor None
selectItem unsigned long
sendEvent unsigned long, IEventParameter1&,
IEventParameter2&
setBitmap unsigned long, unsigned long
setConditionalCascade unsigned long, unsigned long
setFocus None
setItem IMenuItem&
setLayoutDistorted unsigned long, unsigned long
setSubmenu unsigned long, IResourceId&
setText unsigned long, IResourceId&
show Boolean
showSourceEmphasis Boolean
uncheckItem unsigned long
ΓòÉΓòÉΓòÉ <hidden> Events - IMenu ΓòÉΓòÉΓòÉ
Event Notification ID
commandEvent commandId
gotFocusEvent FOCUSTRUEID
inputDisabledEvent ENABLEFALSEID
inputEnabledEvent ENABLETRUEID
lostFocusEvent FOCUSFALSEID
systemCommandEvent systemCommandId
visibilityDisabledEvent VISIBLEFALSEID
visibilityEnabledEvent VISIBLETRUEID
ΓòÉΓòÉΓòÉ <hidden> General Settings - IMenu ΓòÉΓòÉΓòÉ
Subpart name Sets the name of the subpart (a part placed on a composite part).
Default value: The name of the part
ΓòÉΓòÉΓòÉ <hidden> Styles Settings - IMenu ΓòÉΓòÉΓòÉ
defaultStyle() Resets the part to the original default style.
Default value: Selected
clipChildren Excludes the area occupied by the children of the window when
drawing in the window. Child windows are always "clipped" to their parent
window. When a parent window is painted, the clipChildren style controls
whether the invalidated region of the parent window includes the area
occupied by its children, thus preventing a window from painting over its
child windows.
Default value: The Default radio button is selected.
clipSiblings Controls which sibling window is displayed on top when multiple
siblings are displayed. Sibling windows are windows that share the same
parent window. Assign the clipSiblings style to the sibling window that you
want displayed on top of the other siblings, in Z-order.
Default value: The Default radio button is selected.
clipToParent Allows a window to paint outside of its window boundary up to the
window boundary of its parent.
Default value: The Default radio button is selected.
saveBits Optimizes the painting of a window by saving the screen image of the
area under the window as a bitmap and then using the bitmap to redraw the
window, when necessary.
Default value: The Default radio button is selected.
synchPaint Synchronously repaints the window. Without this style, painting
only occurs if there are no other events waiting to be processed.
Default value: The Default radio button is selected.
visible Makes the window visible. In general, controls are constructed as
visible, and frame windows are constructed as invisible.
Default value: The default is on, and the Default radio button is selected.
ΓòÉΓòÉΓòÉ <hidden> Color Settings - IMenu ΓòÉΓòÉΓòÉ
Color area Sets the color of the given area. Choices are as follows:
Foreground
Sets the color for foreground text
Disabled foreground
Sets the foreground color for disabled text
Highlighted foreground
Sets the foreground color for selected text
Border
Sets the color of the border that surrounds the part.
Disabled background
Sets the background color for disabled text
Highlighted background
Sets the background color for selected text
Default value: Foreground is selected
Color selection Enables color selection by either color values or RGB values.
Select Colors or RGB. If you select Colors, you can set the Color values. If
you select RGB, you can set the RGB values.
Default value: Colors selected
Color values Sets the color value of the window area, or sets the passed
default if no color for the area has been set.
Default value: None
RGB values Sets the color values for the window area.
Default value: Not set
ΓòÉΓòÉΓòÉ 3.20. IMenuCascade ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Events
Settings Pages
General
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IMenuCascade ΓòÉΓòÉΓòÉ
Title: IMenuCascade
Class name: IMenuCascade
Base part: IMenuItem
Part type: Visual part
Part file: vbbase.vbb
An IMenuCascade part is a menu selection choice that represents a submenu. You
can present the choice to the user as text or as a bitmap.
The user can select a menu cascade to open a submenu.
Use an IMenuCascade part to represent a set of closely related menu choices as
a high-level menu choice. The closely related menu choices can then be
presented in a submenu. This keeps menus shorter and defers detailed choices
from the higher-level menu.
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - IMenuCascade ΓòÉΓòÉΓòÉ
You can set up cascade menu items and attach submenus easily by building with
IMenu parts. Alternatively, you can work directly with IMenuCascade parts for
cascade menu items.
When building with an IMenuCascade part, you can do the following:
Add a cascade menu item to a menu. Do this by dropping an IMenuCascade
part on the IMenu part.
Assign text to the cascade menu item. Do this in the Menu item type field
on the IMenuCascade General settings page. Select the Text setting and
then enter the text in the Text field. If you want to establish a
mnemonic for the cascade menu item, type a ~ before the mnemonic
character.
Assign a bitmap to the cascade menu item. Do this in the Menu item type
field on the IMenuCascade General settings page. Select the Graphic
setting and then set the DLL name and Resource ID fields.
Associate the cascade menu item with a target submenu. Do this by
connecting the submenu this attribute to the IMenuCascade menu attribute.
This causes the target action to be performed when the user selects the
menu item.
If the cascade menu item is a choice on a menu bar, define brief help
text to appear in the frame window information area when the user selects
the menu choice. Do this by entering text in the Info area text field on
the IMenuCascade General settings page.
Move the cascade menu item within your menu. Do this by clicking mouse
button2 on the item and dragging it to a new location in the menu.
ΓòÉΓòÉΓòÉ <hidden> Attributes - IMenuCascade ΓòÉΓòÉΓòÉ
Attribute S E Data type
asDebugInfo IString
asString IString
bitmap Γûá IBitmapHandle
checked Γûá Boolean
commandType Γûá CommandType
disabled Γûá Boolean
drawItem Γûá Boolean
framed Γûá Boolean
highlighted Γûá Boolean
id unsigned long
index Γûá unsigned long
isBitmap Boolean
isText Boolean
layoutType Γûá LayoutType
menu
noDismiss Γûá Boolean
selectable Γûá Boolean
separator Boolean
submenu Boolean
submenuHandle Γûá IWindowHandle
text Γûá IString
ΓòÉΓòÉΓòÉ <hidden> Actions - IMenuCascade ΓòÉΓòÉΓòÉ
Action Parameters
convertToGUIStyle IBitFlag&, Boolean
setSeparator None
ΓòÉΓòÉΓòÉ <hidden> Events - IMenuCascade ΓòÉΓòÉΓòÉ
Event Notification ID
commandEvent commandId
ΓòÉΓòÉΓòÉ <hidden> General Settings - IMenuCascade ΓòÉΓòÉΓòÉ
Subpart name Sets the name of the subpart (a part placed on a composite part).
Default value: The name of the part
Info area text Specifies the text to appear in the information area for this
part.
Default value: None
Menu item type Sets the type of the menu item.
Default value: Text
Text Sets the text of the menu item.
Default value: Name of the menu item.
DLL name Sets the name of the DLL for the menu item.
Default value: None
Resource ID Sets the resource identifier for the menu item.
Default value: 0
Conditional cascade Enables the conditional cascade menu behavior.
Default value: Not selected
Checked Places a check mark to the left of the menu item.
Default value: Not selected
Disabled Makes the menu item unselectable.
Default value: Not selected
Framed Places a frame around the menu item.
Default value: Not selected
Highlighted Highlights the menu item.
Default value: Not selected
No dismiss upon selection Keeps the menu item visible after selection.
Default value: Not selected
Selectable Makes the menu item selectable.
Default value: Not selected
Draw item Allows the menu item to be drawn.
Default value: Not selected
ΓòÉΓòÉΓòÉ 3.21. IMenuItem ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Events
Settings Pages
General
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IMenuItem ΓòÉΓòÉΓòÉ
Title: IBM menu item
Class name: IMenuItem
Base part: IBase
Part type: Visual part
Part file: vbbase.vbb
An IMenuItem part is a selection choice for a menu. You can present the choice
to the user as text or as a bitmap.
The user can select a choice, or menu item, to apply the choice to an object.
Use an IMenuItem part to present a menu choice related to an object.
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - IMenuItem ΓòÉΓòÉΓòÉ
When building with an IMenuItem part, you can do the following:
Add a menu item to a menu. Do this by dropping an IMenuItem part on the
menu.
Assign text to the menu item. Do this in the Menu item type field on the
IMenuItem General settings page. Select the Text setting and then enter
the text in the Text field. If you want to establish a mnemonic for the
menu item, type a ~ before the mnemonic character.
Assign a bitmap to the menu item. Do this in the Menu item type field on
the IMenuItem General settings page. Select the Graphic setting and then
set the DLL name and Resource ID fields.
Associate the menu item with an action. Do this by connecting the
IMenuItem commandEvent feature to the target action.
If the menu item is a choice on a menu bar, define brief help text to
appear in the frame window information area when the user selects the
menu choice. Do this by entering text in the Info area text field on the
IMenuItem General settings page.
Preselect the menu item. Do this by setting the Checked field on the
IMenuItem General settings page.
Make the menu item initially unavailable. Do this by setting the Disabled
field on the IMenuItem General settings page.
Enable or disable the menu item when an event occurs, such as selection
of another item.
Disable the menu item as follows:
1. Connect the event to the IMenuItem disabled attribute.
2. Open settings for the connection, press the Set parameters push
button, and check the Disabled setting.
Enable the menu item by connecting the event to the IMenuItem disabled
attribute with the Disabled setting not checked.
Move the menu item within your menu. Do this by clicking mouse button 2
on the item and dragging it to a new location in the menu.
ΓòÉΓòÉΓòÉ <hidden> Attributes - IMenuItem ΓòÉΓòÉΓòÉ
Attribute S E Data type
asDebugInfo IString
asString IString
bitmap Γûá IBitmapHandle
checked Γûá Boolean
commandType Γûá CommandType
disabled Γûá Boolean
drawItem Γûá Boolean
framed Γûá Boolean
highlighted Γûá Boolean
id unsigned long
index Γûá unsigned long
isBitmap Boolean
isText Boolean
layoutType Γûá LayoutType
noDismiss Γûá Boolean
selectable Γûá Boolean
separator Boolean
submenu Boolean
submenuHandle Γûá IWindowHandle
text Γûá IString
ΓòÉΓòÉΓòÉ <hidden> Actions - IMenuItem ΓòÉΓòÉΓòÉ
Action Parameters
convertToGUIStyle IBitFlag&, Boolean
setSeparator None
ΓòÉΓòÉΓòÉ <hidden> Events - IMenuItem ΓòÉΓòÉΓòÉ
Event Notification ID
commandEvent commandId
ΓòÉΓòÉΓòÉ <hidden> General Settings - IMenuItem ΓòÉΓòÉΓòÉ
Subpart name Sets the name of the subpart (a part placed on a composite part).
Default value: The name of the part
Info area text Specifies the text to appear in the information area for this
part.
Default value: None
Help panel id Sets the help panel identifier for the part.
Default value: None
Menu item type Sets the type of the menu item.
Default value: Text
Text Sets the text of the menu item.
Default value: Name of the menu item.
DLL name Sets the name of the DLL for the menu item.
Default value: None
Resource ID Sets the resource identifier for the menu item.
Default value: 0
Alt Sets the accelerator for the Alt key.
Default value: Not selected
Ctrl Sets the accelerator for the Ctrl key.
Default value: Not selected
Shift Sets the accelerator for the Shift key.
Default value: Not selected
Key Allows selection of an accelerator key.
Default value: None
Show text on menu Shows the text for the accelerator key with the menu item.
Default value: Not selected
Command type Generates a command event when the user selects the part.
Default value: None
Checked Places a check mark to the left of the menu item.
Default value: Not selected
Disabled Makes the menu item unselectable.
Default value: Not selected
Framed Places a frame around the menu item.
Default value: Not selected
Highlighted Highlights the menu item.
Default value: Not selected
No dismiss upon selection Keeps the menu item visible after selection.
Default value: Not selected
Selectable Makes the menu item selectable.
Default value: Not selected
Draw item Allows the menu item to be drawn.
Default value: Not selected
ΓòÉΓòÉΓòÉ 3.22. IMenuSeparator ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Events
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IMenuSeparator ΓòÉΓòÉΓòÉ
Title: IMenuSeparator
Class name: IMenuSeparator
Base part: IMenuItem
Part type: Nonvisual part
Part file: vbbase.vbb
An IMenuSeparator part is a visual separator between groups of menu choices.
The user can recognize groups of related menu choices by noting the separators
between the groups.
Use an IMenuSeparator part to mark the beginning or end of a group of related
menu choices.
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - IMenuSeparator ΓòÉΓòÉΓòÉ
When building with an IMenuSeparator part, you can do the following:
Add a menu separator to a menu. Do this by dropping an IMenuSeparator
part on the menu.
Move the menu separator within your menu. Do this by pressing mouse
button2 on the separator and dragging it to a new location in the menu.
ΓòÉΓòÉΓòÉ <hidden> Attributes - IMenuSeparator ΓòÉΓòÉΓòÉ
Attribute S E Data type
asDebugInfo IString
asString IString
bitmap Γûá IBitmapHandle
checked Γûá Boolean
commandType Γûá CommandType
disabled Γûá Boolean
drawItem Γûá Boolean
framed Γûá Boolean
highlighted Γûá Boolean
id unsigned long
index Γûá unsigned long
isBitmap Boolean
isText Boolean
layoutType Γûá LayoutType
noDismiss Γûá Boolean
selectable Γûá Boolean
separator Boolean
submenu Boolean
submenuHandle Γûá IWindowHandle
ΓòÉΓòÉΓòÉ <hidden> Actions - IMenuSeparator ΓòÉΓòÉΓòÉ
Action Parameters
convertToGUIStyle IBitFlag&, Boolean
setSeparator None
ΓòÉΓòÉΓòÉ <hidden> Events - IMenuSeparator ΓòÉΓòÉΓòÉ
Event Notification ID
commandEvent commandId
ΓòÉΓòÉΓòÉ 3.23. IMessageBox ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Settings Pages
General
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IMessageBox ΓòÉΓòÉΓòÉ
Title: IBM message dialog window
Class name: IMessageBox
Base part: IVBase
Part type: Class interface part
Part file: vbbase.vbb
An IMessageBox part is a window for displaying application messages to the
user.
The user can note the information or error presented in a message. If given a
choice, the user can select an action in response to the message.
Use an IMessageBox part to display information about activity or problems. For
example, your application can do the following:
Inform the user about what a task is doing
Display an error message to the user
You can add push buttons to the message box to give the user choices for
responding to a message.
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - IMessageBox ΓòÉΓòÉΓòÉ
When building with an IMessageBox part, you can do the following:
Provide a message box for a view. Do this by selecting an IMessageBox
part from the parts palette and dropping it on the free-form surface.
Type the title for your message box in the Title field on the IMessageBox
General settings page.
Identify the frame window that the message box is related to. If you have
only one frame window in your view, the message box is automatically
related to that frame window.
If you want the message box for a second frame window in your view, do
this by referencing the frame window Subpart name, which appears on its
General settings page. Enter the frame window subpart name, prefixed with
"i," in the Owner field on the IMessageBox General settings page.
Use the message box to report exceptions. Do this by connecting
exceptionOccurred on any connection that could yield an exception to the
IMessageBox showException action.
Use the message box to report other messages. Do this as follows:
1. Connect an event related to the message to the IMessageBox show
action.
2. Open settings for the connection and press the Set parameters push
button. Then, enter the message text and a message severity. The
message text must be entered as a C++ string enclosed in quotation
marks. The severity must be one of the following enumeration values:
- information
- warning
- action
- critical
- catastrophic The IMessageBox class description in the IBM Open
Class Library Reference provides information about these Severity
enumeration values.
ΓòÉΓòÉΓòÉ <hidden> Attributes - IMessageBox ΓòÉΓòÉΓòÉ
Attribute S E Data type
asDebugInfo IString
asString IString
ΓòÉΓòÉΓòÉ <hidden> Actions - IMessageBox ΓòÉΓòÉΓòÉ
Action Parameters
setTitle IResourceId&
show IResourceId&, Style&, unsigned long
showErrorInfo IResourceId&, Style&, unsigned long
showException IResourceId&, Style&, unsigned long
ΓòÉΓòÉΓòÉ <hidden> General Settings - IMessageBox ΓòÉΓòÉΓòÉ
Part name Sets the name of the part.
Default value: The name of the part
Title Sets the title to appear on the title bar for the part.
Default value: None
Owner Sets the window's owner.
Default value: None
ΓòÉΓòÉΓòÉ 3.24. IMMAmpMixer ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Events
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IMMAmpMixer ΓòÉΓòÉΓòÉ
Title: IBM amplifier/mixer
Class name: IMMAmpMixer
Base part: IMMDevice
Part type: Nonvisual part
Part file: vbmm.vbb
An IMMAmpMixer part is a sound amplification and mixing control. The
amplifier-mixer enables audio signals to be transferred to speakers or other
sound devices.
The user can operate the amplifier-mixer through visual controls you provide.
Circular sliders are well suited for visual control of an amplifier-mixer.
Use an IMMAmpMixer part to provide standard audio control functions, such as
volume and balance.
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - IMMAmpMixer ΓòÉΓòÉΓòÉ
When building with an IMMAmpMixer part, you can do the following:
Define initial values for amplification and mixing settings. Do this on
the IMMAmpMixer part settings page. The control fields are:
- balance
- bass
- gain
- pitch
- treble
- volume The field values range from 0 to 100. Generally, 0 is the
minimum setting of the control and 100 is the maximum setting. For
balance, 0 is the maximum left speaker setting, and 100 is the maximum
right speaker setting.
Provide visual access to amplification and mixing settings. Do this using
circular sliders as dials that the user can turn to control settings. For
example, provide a volume dial as follows:
- Use the Add part choice on the Composition Editor Options menu to
get an ICircularSlider part; then, drop it on a canvas.
- Define the circular slider as a volume control with values from 0 to
100.
- Connect the ICircularSlider value attribute to the IMMAmpMixer
volume attribute.
Define the speed format for the amplifier-mixer if you do not want to use
the system-provided format. Do this by selecting a choice for the
speedFormat field on the IMMAmpMixer part settings page.
Define the time format for the amplifier-mixer if you do not want to use
the system-provided format. Do this by selecting a choice for the
timeFormat field on the IMMAmpMixer part settings page.
ΓòÉΓòÉΓòÉ <hidden> Attributes - IMMAmpMixer ΓòÉΓòÉΓòÉ
Attribute S E Data type
acquired Boolean
aliasName IString
asDebugInfo IString
asString IString
audioEnabled Γûá Boolean
balance Γûá unsigned long
bass Γûá unsigned long
closeOnDestroy Γûá Boolean
description IString
deviceId unsigned long
deviceName IString
deviceType unsigned long
enabledForNotification Γûá Boolean
gain Γûá unsigned long
isOpen Boolean
mode Mode
monitoringEnabled Γûá Boolean
pitch Γûá unsigned long
prerollTime IMMTime
prerollType PrerollType
requiresFiles Boolean
speedFormat Γûá IMMSpeed::Format
supportsAudio Boolean
supportsDigitalTransfer Boolean
supportsDisableEject Boolean
supportsEject Boolean
supportsPlay Boolean
supportsRecord Boolean
supportsRecordInsertion Boolean
supportsSave Boolean
supportsStreaming Boolean
supportsVideo Boolean
supportsVolumeAdjustment Boolean
timeFormat Γûá IMMTime::Format
treble Γûá unsigned long
volume Γûá unsigned long
ΓòÉΓòÉΓòÉ <hidden> Actions - IMMAmpMixer ΓòÉΓòÉΓòÉ
Action Parameters
acquire ShareMode, Boolean, CallType
close CallType
connectedDeviceId ConnectorType, CallType
deletePendingEvents EventType
disableAudio AudioChannel, IMMMillisecondTime&, CallType
disableConnector ConnectorType, CallType
disableMonitoring CallType
disableNotification None
enableConnector ConnectorType, Boolean, CallType
isConnectionSupported ConnectorType, CallType
isConnectorEnabled ConnectorType, CallType
notifyObservers INotificationId&
open IString&, Boolean, CallType
openOnThread IString&, Boolean, CallType
operator = IStandardNotifier&
release CallType
supportsCommand IMMNotifyEvent::Command, CallType
ΓòÉΓòÉΓòÉ <hidden> Events - IMMAmpMixer ΓòÉΓòÉΓòÉ
Event Notification ID
commandNotifyEvent commandNotifyId
cuePointEvent cuePointId
deviceEvent deviceEventId
passDeviceEvent passDeviceId
positionChangeEvent positionChangeId
ΓòÉΓòÉΓòÉ 3.25. IMMAudioCD ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Events
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IMMAudioCD ΓòÉΓòÉΓòÉ
Title: IBM audio compact disc device
Class name: IMMAudioCD
Base part: IMMRemovableMedia
Part type: Nonvisual part
Part file: vbmm.vbb
An IMMAudioCD part is an audio compact disc (CD) player control.
The user can operate the CD player through visual controls. You can easily
provide button controls with the IMMPlayerPanel part. You can provide volume
control for all audio devices with the IMMMasterAudio part.
Use an IMMAudioCD part to provide standard audio CD player functions.
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - IMMAudioCD ΓòÉΓòÉΓòÉ
When building with an IMMAudioCD part, you can do the following:
Define an initial volume setting. Do this by entering a value in the
volume field on the IMMAudioCD part settings page. Values range from 0
for no volume to 100 for the maximum volume.
If you are providing an IMMMasterAudio part for volume control and are
not providing visual access to the volume setting for the CD player, set
the volume field value to 100.
Provide visual access to the volume setting. Do this using a circular
slider as a volume dial:
- Use the Add part choice on the Composition Editor Options menu to
get an ICircularSlider part; then, drop it on a canvas.
- Define the circular slider as a volume control with values from 0 to
100.
- Connect the ICircularSlider value attribute to the IMMAudioCD volume
attribute.
If you are providing visual volume control with an IMMMasterAudio part as
well as with the CD player, the master audio volume setting determines
the maximum volume produced. The player volume is the product of the
master audio volume setting and the player volume setting. For example,
if the master audio volume is set at 50 and the player volume is set at
80, the player volume is 40 percent of its potential maximum.
Provide visual access to CD player actions. Do this using animated
buttons that the user can press to activate controls. For example,
provide a play button as follows:
- Select an IAnimatedButton part from the parts palette and drop it on
a canvas.
- Define the animated button as a latchable play button. Do this as
follows:
-- Assign play bitmaps to the animated button. Do this by
selecting the play bitmap identifier in the Bitmap field on the
IAnimatedButton General settings page.
-- Give the button the appearance of remaining latched down while
it is active. Do this by setting the latchable field on the
IAnimatedButton Styles settings page.
- Connect the IAnimatedButton buttonClickEvent feature to the
IMMAudioCD play action.
Define the speed format for the CD player if you do not want to use the
system-provided format. Do this by selecting a choice for the speedFormat
field on the IMMAudioCD part settings page.
Define the time format for the CD player if you do not want to use the
system-provided format. Do this by selecting a choice for the timeFormat
field on the IMMAudioCD part settings page.
ΓòÉΓòÉΓòÉ <hidden> Attributes - IMMAudioCD ΓòÉΓòÉΓòÉ
Attribute S E Data type
acquired Boolean
aliasName IString
asDebugInfo IString
asString IString
audioEnabled Γûá Boolean
autoPlayEnabled Γûá Boolean
closeOnDestroy Γûá Boolean
contents IMMAudioCDContents
continuousPlayEnabled Γûá Boolean
description IString
deviceId unsigned long
deviceName IString
deviceType unsigned long
discId IString
discTitle Γûá IString
enabledForNotification Γûá Boolean
isOpen Boolean
length unsigned long
mediaPresent Boolean
mode Mode
numberOfTracks unsigned long
position unsigned long
prerollTime IMMTime
prerollType PrerollType
profile Γûá IProfile
requiresFiles Boolean
speedFormat Γûá IMMSpeed::Format
supportsAudio Boolean
supportsDigitalTransfer Boolean
supportsDisableEject Boolean
supportsEject Boolean
supportsPlay Boolean
supportsRecord Boolean
supportsRecordInsertion Boolean
supportsSave Boolean
supportsStreaming Boolean
supportsVideo Boolean
supportsVolumeAdjustment Boolean
timeFormat Γûá IMMTime::Format
upc IString
volume Γûá unsigned long
ΓòÉΓòÉΓòÉ <hidden> Actions - IMMAudioCD ΓòÉΓòÉΓòÉ
Action Parameters
acquire ShareMode, Boolean, CallType
addCuePoint IMMTime&, CallType
close CallType
closeDoor CallType
connectedDeviceId ConnectorType, CallType
cueForPlayback CallType
deletePendingEvents EventType
disableAudio AudioChannel, IMMMillisecondTime&, CallType
disableAutoPlay None
disableConnector ConnectorType, CallType
disableContinuousPlay None
disableNotification None
enableConnector ConnectorType, Boolean, CallType
goToEntry unsigned long
isConnectionSupported ConnectorType, CallType
isConnectorEnabled ConnectorType, CallType
lockDoor Boolean, CallType
notifyObservers INotificationId&
open IString&, Boolean, CallType
openDoor Boolean, CallType
openOnThread IString&, Boolean, CallType
operator = IStandardNotifier&
pause CallType
play IMMTime&, IMMTime&, Boolean, CallType
release CallType
removeCuePoint IMMTime&, CallType
resume Boolean, CallType
seek IMMTime&, CallType
seekToEnd CallType
seekToStart CallType
setProgram IMMAudioCDContents&
setTrackTitle IString&, unsigned long
startPositionTracking IMMTime&, CallType
startScanningBackward None
startScanningForward None
stepFrame unsigned long, Boolean, CallType
stop CallType
stopPositionTracking CallType
supportsCommand IMMNotifyEvent::Command, CallType
trackBackward unsigned long
trackForward unsigned long
trackTitle unsigned long
unlockDoor CallType
ΓòÉΓòÉΓòÉ <hidden> Events - IMMAudioCD ΓòÉΓòÉΓòÉ
Event Notification ID
commandNotifyEvent commandNotifyId
cuePointEvent cuePointId
deviceEvent deviceEventId
mediaLoadedEvent mediaLoadedId
passDeviceEvent passDeviceId
positionChangeEvent positionChangeId
positionTimerEvent positionTimerId
trackStartedEvent trackStartedId
ΓòÉΓòÉΓòÉ 3.26. IMMCDXA ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Events
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IMMCDXA ΓòÉΓòÉΓòÉ
Title: IBM support for compact disc XA
Class name: IMMCDXA
Base part: IMMRemovableMedia
Part type: Nonvisual part
Part file: vbmm.vbb
An IMMCDXA part is an extended architecture (XA) compact disc (CD) player
control. It operates a CD-XA device, which can read a CD with interleaved
audio, video, and standard file data.
The user can operate the CD player through visual controls. You can easily
provide button controls with the IMMPlayerPanel part. You can provide volume
control for all audio devices with the IMMMasterAudio part.
Use an IMMCDXA part to provide extended architecture CD player functions.
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - IMMCDXA ΓòÉΓòÉΓòÉ
When building with an IMMCDXA part, you can do the following:
Define an initial volume setting. Do this by entering a value in the
volume field on the IMMCDXA part settings page. Values range from 0 for
no volume to 100 for the maximum volume.
If you are providing an IMMMasterAudio part for volume control and are
not providing visual access to the volume setting for the CD player, set
the volume field value to 100.
Provide visual access to the volume setting. Do this using a circular
slider as a volume dial:
- Use the Add part choice on the Composition Editor Options menu to
get an ICircularSlider part; then, drop it on a canvas.
- Define the circular slider as a volume control with values from 0 to
100.
- Connect the ICircularSlider value attribute to the IMMCDXA volume
attribute.
If you are providing visual volume control with an IMMMasterAudio part as
well as with the CD player, the master audio volume setting determines
the maximum volume produced. The player volume is the product of the
master audio volume setting and the player volume setting. For example,
if the master audio volume is set at 50 and the player volume is set at
80, the player volume is 40 percent of its potential maximum.
Provide visual access to CD player actions. Do this using animated
buttons that the user can press to activate controls. For example,
provide a play button as follows:
- Select an IAnimatedButton part from the parts palette and drop it on
a canvas.
- Define the animated button as a latchable play button. Do this as
follows:
-- Assign play bitmaps to the animated button. Do this by
selecting the play bitmap identifier in the Bitmap field on the
IAnimatedButton General settings page.
-- Give the button the appearance of remaining latched down while
it is active. Do this by setting the latchable field on the
IAnimatedButton Styles settings page.
- Connect the IAnimatedButton buttonClickEvent feature to the IMMCDXA
play action.
Define the speed format for the CD player if you do not want to use the
system-provided format. Do this by selecting a choice for the speedFormat
field on the IMMCDXA part settings page.
Define the time format for the CD player if you do not want to use the
system-provided format. Do this by selecting a choice for the timeFormat
field on the IMMCDXA part settings page.
ΓòÉΓòÉΓòÉ <hidden> Attributes - IMMCDXA ΓòÉΓòÉΓòÉ
Attribute S E Data type
acquired Boolean
aliasName IString
asDebugInfo IString
asString IString
audioEnabled Γûá Boolean
closeOnDestroy Γûá Boolean
description IString
deviceId unsigned long
deviceName IString
deviceType unsigned long
enabledForNotification Γûá Boolean
isOpen Boolean
length unsigned long
mediaPresent Boolean
mode Mode
position unsigned long
prerollTime IMMTime
prerollType PrerollType
requiresFiles Boolean
speedFormat Γûá IMMSpeed::Format
supportsAudio Boolean
supportsDigitalTransfer Boolean
supportsDisableEject Boolean
supportsEject Boolean
supportsPlay Boolean
supportsRecord Boolean
supportsRecordInsertion Boolean
supportsSave Boolean
supportsStreaming Boolean
supportsVideo Boolean
supportsVolumeAdjustment Boolean
timeFormat Γûá IMMTime::Format
upc IString
volume Γûá unsigned long
ΓòÉΓòÉΓòÉ <hidden> Actions - IMMCDXA ΓòÉΓòÉΓòÉ
Action Parameters
acquire ShareMode, Boolean, CallType
addCuePoint IMMTime&, CallType
close CallType
closeDoor CallType
connectedDeviceId ConnectorType, CallType
cueForPlayback CallType
deletePendingEvents EventType
disableAudio AudioChannel, IMMMillisecondTime&, CallType
disableConnector ConnectorType, CallType
disableNotification None
enableConnector ConnectorType, Boolean, CallType
isConnectionSupported ConnectorType, CallType
isConnectorEnabled ConnectorType, CallType
lockDoor Boolean, CallType
notifyObservers INotificationId&
open IString&, Boolean, CallType
openDoor Boolean, CallType
openOnThread IString&, Boolean, CallType
operator = IStandardNotifier&
pause CallType
play IMMTime&, IMMTime&, Boolean, CallType
release CallType
removeCuePoint IMMTime&, CallType
resume Boolean, CallType
seek IMMTime&, CallType
seekToEnd CallType
seekToStart CallType
startPositionTracking IMMTime&, CallType
stepFrame unsigned long, Boolean, CallType
stop CallType
stopPositionTracking CallType
supportsCommand IMMNotifyEvent::Command, CallType
unlockDoor CallType
ΓòÉΓòÉΓòÉ <hidden> Events - IMMCDXA ΓòÉΓòÉΓòÉ
Event Notification ID
commandNotifyEvent commandNotifyId
cuePointEvent cuePointId
deviceEvent deviceEventId
mediaLoadedEvent mediaLoadedId
passDeviceEvent passDeviceId
positionChangeEvent positionChangeId
ΓòÉΓòÉΓòÉ 3.27. IMMDigitalVideo ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Events
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IMMDigitalVideo ΓòÉΓòÉΓòÉ
Title: IBM digital video
Class name: IMMDigitalVideo
Base part: IMMConfigurableAudio
Part type: Nonvisual part
Part file: vbmm.vbb
An IMMDigitalVideo part is a digital video player control.
The user can operate the video player through visual controls. You can easily
provide button controls with the IMMPlayerPanel part. You can provide volume
control for all audio devices with the IMMMasterAudio part.
Use an IMMDigitalVideo part to provide standard video player functions.
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - IMMDigitalVideo ΓòÉΓòÉΓòÉ
When building with an IMMDigitalVideo part, you can do the following:
Define an initial volume setting. Do this by entering a value in the
volume field on the IMMDigitalVideo part settings page. Values range from
0 for no volume to 100 for the maximum volume.
If you are providing an IMMMasterAudio part for volume control and are
not providing visual access to the volume setting for the video player,
set the volume field value to 100.
Provide visual access to the volume setting. Do this using a circular
slider as a volume dial:
- Use the Add part choice on the Composition Editor Options menu to
get an ICircularSlider part; then, drop it on a canvas.
- Define the circular slider as a volume control with values from 0 to
100.
- Connect the ICircularSlider value attribute to the IMMDigitalVideo
volume attribute.
If you are providing visual volume control with an IMMMasterAudio part as
well as with the video player, the master audio volume setting determines
the maximum volume produced. The player volume is the product of the
master audio volume setting and the player volume setting. For example,
if the master audio volume is set at 50 and the player volume is set at
80, the player volume is 40 percent of its potential maximum.
Provide visual access to video player actions. Do this using animated
buttons that the user can press to activate controls. For example,
provide a play button as follows:
- Select an IAnimatedButton part from the parts palette and drop it on
a canvas.
- Define the animated button as a latchable play button. Do this as
follows:
-- Assign play bitmaps to the animated button. Do this by
selecting the play bitmap identifier in the Bitmap field on the
IAnimatedButton General settings page.
-- Give the button the appearance of remaining latched down while
it is active. Do this by setting the latchable field on the
IAnimatedButton Styles settings page.
- Connect the IAnimatedButton buttonClickEvent feature to the
IMMDigitalVideo play action.
- Define the number of audio output channels for the video player. Do
this by entering a number in the channels field on the
IMMDigitalVideo part settings page. Enter 1 for monophonic (mono)
output or 2 for stereophonic (stereo) output.
- Define the audio format for the video player. The default format is
pcm. Do this by selecting a choice for the format field on the
IMMDigitalVideo part settings page.
- Define the speed format for the video player if you do not want to
use the system-provided format. Do this by selecting a choice for
the speedFormat field on the IMMDigitalVideo part settings page.
- Define the time format for the video player if you do not want to
use the system-provided format. Do this by selecting a choice for
the timeFormat field on the IMMDigitalVideo part settings page.
ΓòÉΓòÉΓòÉ <hidden> Attributes - IMMDigitalVideo ΓòÉΓòÉΓòÉ
Attribute S E Data type
acquired Boolean
aliasName IString
asDebugInfo IString
asString IString
audioEnabled Γûá Boolean
bitsPerSample Γûá unsigned long
blockAlignment Γûá unsigned long
bytesPerSecond Γûá unsigned long
canRedo Boolean
canUndo Boolean
channels Γûá unsigned long
closeOnDestroy Γûá Boolean
description IString
destinationRectangle IRectangle
deviceId unsigned long
deviceName IString
deviceType unsigned long
enabledForNotification Γûá Boolean
fastSpeed IMMSpeed
filename Γûá IString
fileNormalSpeed IMMSpeed
format Γûá IMMAudioBuffer::Format
handle IWindowHandle
isOpen Boolean
length unsigned long
maximumSpeed IMMSpeed
maximumWindows unsigned long
minimumSpeed IMMSpeed
mode Mode
monitorHandle IWindowHandle
monitoringEnabled Γûá Boolean
normalSpeed IMMSpeed
playingForward Boolean
position unsigned long
prerollTime IMMTime
prerollType PrerollType
readOnly Boolean
requiresFiles Boolean
samplesPerSecond Γûá unsigned long
slowSpeed IMMSpeed
sourceRectangle IRectangle
speed IMMSpeed
speedFormat Γûá IMMSpeed::Format
supportsAudio Boolean
supportsDigitalTransfer Boolean
supportsDisableEject Boolean
supportsEject Boolean
supportsOverlayGraphics Boolean
supportsPlay Boolean
supportsRecord Boolean
supportsRecordInsertion Boolean
supportsReverse Boolean
supportsSave Boolean
supportsSizing Boolean
supportsStreaming Boolean
supportsStretchToFit Boolean
supportsVideo Boolean
supportsVolumeAdjustment Boolean
timeFormat Γûá IMMTime::Format
videoFileHeight unsigned long
videoFileName IString
videoFileWidth unsigned long
videoHeight unsigned long
videoWidth unsigned long
volume Γûá unsigned long
ΓòÉΓòÉΓòÉ <hidden> Actions - IMMDigitalVideo ΓòÉΓòÉΓòÉ
Action Parameters
acquire ShareMode, Boolean, CallType
addCuePoint IMMTime&, CallType
close CallType
connectedDeviceId ConnectorType, CallType
copy IMMTime&, IMMTime&, CallType
cueForPlayback CallType
cueForRecording CallType
cut IMMTime&, IMMTime&, CallType
deletePendingEvents EventType
deleteSelection IMMTime&, IMMTime&, CallType
disableAudio AudioChannel, IMMMillisecondTime&, CallType
disableConnector ConnectorType, CallType
disableMonitoring CallType
disableNotification None
enableConnector ConnectorType, Boolean, CallType
isConnectionSupported ConnectorType, CallType
isConnectorEnabled ConnectorType, CallType
loadOnThread IString&, Boolean
notifyObservers INotificationId&
open IString&, Boolean, CallType
openOnThread IString&, Boolean, CallType
operator = IStandardNotifier&
paste IMMTime&, IMMTime&, Boolean, CallType
pause CallType
play IMMTime&, IMMTime&, Boolean, CallType
playAt IMMSpeed&, IMMTime&, IMMTime&, CallType
playFast IMMTime&, IMMTime&, CallType
playScan IMMTime&, IMMTime&, CallType
playSlow IMMTime&, IMMTime&, CallType
record Boolean, IMMTime&, IMMTime&, Boolean, CallType
redo CallType
refresh IRectangle&, IRectangle&, CallType
release CallType
removeCuePoint IMMTime&, CallType
resume Boolean, CallType
save CallType
saveAs IString&, CallType
seek IMMTime&, CallType
seekToEnd CallType
seekToStart CallType
setDestination IRectangle&, CallType
setMonitorWindow IWindow&, CallType
setWindow IWindowHandle&, CallType
startPositionTracking IMMTime&, CallType
stepFrame unsigned long, Boolean, CallType
stop CallType
stopPositionTracking CallType
supportsCommand IMMNotifyEvent::Command, CallType
undo CallType
useDefaultMonitorWindow CallType
useDefaultWindow CallType
ΓòÉΓòÉΓòÉ <hidden> Events - IMMDigitalVideo ΓòÉΓòÉΓòÉ
Event Notification ID
commandNotifyEvent commandNotifyId
cuePointEvent cuePointId
deviceEvent deviceEventId
passDeviceEvent passDeviceId
positionChangeEvent positionChangeId
ΓòÉΓòÉΓòÉ 3.28. IMMMasterAudio ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IMMMasterAudio ΓòÉΓòÉΓòÉ
Title: IBM master audio
Class name: IMMMasterAudio
Base part: IStandardNotifier
Part type: Nonvisual part
Part file: vbmm.vbb
An IMMMasterAudio part is a master volume and sound device control.
The user can operate the master volume through a visual control you provide. A
circular slider is well suited for visual control of volume.
Use an IMMMasterAudio part to provide a master volume control. Your
application can also use the control to enable and disable speakers and
headphones. Be aware that a master audio control affects all sound output for
the system.
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - IMMMasterAudio ΓòÉΓòÉΓòÉ
When building with an IMMMasterAudio part, you can do the following:
Define an initial volume setting. Do this by entering a value in the
volume field on the IMMMasterAudio part settings page. Values range from
0 for no volume to 100 for the maximum volume.
Provide visual access to the volume setting. Do this using a circular
slider as a volume dial:
- Use the Add part choice on the Composition Editor Options menu to
get an ICircularSlider part; then, drop it on a canvas.
- Define the circular slider as a volume control with values from 0 to
100.
- Connect the ICircularSlider value attribute to the IMMMasterAudio
volume attribute.
Provide visual access to master audio actions. Do this using animated
buttons that the user can press to activate controls. For example,
provide a mute button as follows:
- Select an IAnimatedButton part from the parts palette and drop it on
a canvas.
- Define the animated button as a latchable mute button. Do this as
follows:
-- Assign play bitmaps to the animated button. Do this by
selecting the mute bitmap identifier in the Bitmap field on the
IAnimatedButton General settings page.
-- Give the button the appearance of remaining latched down while
it is active. Do this by setting the latchable field on the
IAnimatedButton Styles settings page.
- Connect the IAnimatedButton buttonClickEvent feature to
IMMMasterAudio Custom logic. Enter C++ code to mute and unmute the
sound.
For example, you could enter the following code:
unsigned long volumeBeforeMute = 50; // Set an initial previous volume
if (target->volume() == 0) // Turn sound on if it is off
{
target->setVolume(volumeBeforeMute);
}
else // Turn sound off if it is on
{
volumeBeforeMute = target->volume();
target->setVolume(0);
}
ΓòÉΓòÉΓòÉ <hidden> Attributes - IMMMasterAudio ΓòÉΓòÉΓòÉ
Attribute S E Data type
areHeadphonesEnabled Boolean
areSpeakersEnabled Boolean
asDebugInfo IString
asString IString
enabledForNotification Γûá Boolean
volume Γûá unsigned long
ΓòÉΓòÉΓòÉ <hidden> Actions - IMMMasterAudio ΓòÉΓòÉΓòÉ
Action Parameters
disableHeadphones IMMDevice::CallType
disableNotification None
disableSpeakers IMMDevice::CallType
enableHeadphones Boolean, IMMDevice::CallType
enableSpeakers Boolean, IMMDevice::CallType
notifyObservers INotificationId&
operator = IStandardNotifier&
saveHeadphonesSetting IMMDevice::CallType
saveSpeakersSetting IMMDevice::CallType
saveVolume IMMDevice::CallType
ΓòÉΓòÉΓòÉ 3.29. IMMPlayerPanel ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Events
Settings Pages
General
Control
Styles
Handlers
Color
Size/Position
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IMMPlayerPanel ΓòÉΓòÉΓòÉ
Title: IBM player panel
Class name: IMMPlayerPanel
Base part: IMultiCellCanvas
Part type: Visual part
Part file: vbmm.vbb
An IMMPlayerPanel part is a multimedia device control panel.
The user can operate an audio or video player through visual controls in the
player panel.
Use an IMMPlayerPanel part for easy composition and control of audio and video
players.
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - IMMPlayerPanel ΓòÉΓòÉΓòÉ
When building with an IMMPlayerPanel part, you can do the following:
Associate the player panel with a device. Do this by identifying the
device as the playable device for the panel.
For example, to use the player panel with an audio CD player, connect the
IMMAudioCD this attribute to the IMMPlayerPanel playableDevice attribute.
Buttons in the player panel are automatically connected to corresponding
actions in the associated player. For example, the play button is
automatically connected to the play action of the player part.
The IMMPlayerPanel part also provides automatic disablement and
enablement of buttons when related buttons are pressed. For example, if
the player is stopped, the stop and pause buttons are disabled. As
another example, if the pause button is pressed while the device is
playing, the pause button is latched down and the play button is
unlatched.
ΓòÉΓòÉΓòÉ <hidden> Attributes - IMMPlayerPanel ΓòÉΓòÉΓòÉ
Attribute S E Data type
activeColor Γûá Γûá IColor
asDebugInfo IString
asString IString
autoDeleteObject Γûá Boolean
autoDestroyWindow Γûá Boolean
backgroundColor Γûá Γûá IColor
bidiSupported Boolean
borderColor Γûá Γûá IColor
characterSize ISize
defaultCell Γûá ISize
defaultPushButton IWindowHandle
deviceType unsigned long
disabledBackgroundColor Γûá Γûá IColor
disabledForegroundColor Γûá Γûá IColor
dragLines Γûá Boolean
enabled Γûá Γûá Boolean
enabledForNotification Γûá Boolean
fastForwardButton IAnimatedButton*
focus Γûá Boolean
font Γûá Γûá IFont
foregroundColor Γûá Γûá IColor
frameWindow Boolean
gridLines Γûá Boolean
group Γûá Boolean
handle IWindowHandle
hiliteBackgroundColor Γûá Γûá IColor
hiliteForegroundColor Γûá Γûá IColor
id Γûá unsigned long
inactiveColor Γûá Γûá IColor
itemProvider Γûá IDMItemProvider*
layoutAdjustment IRectangle
menu
messageQueue IMessageQueueHandle
minimumSize Γûá ISize
nativeRect IRectangle
origDefaultButtonHandle IWindowHandle
owner Γûá IWindow*
parent Γûá IWindow*
parentSize ISize
pauseButton IAnimatedButton*
playableDevice Γûá IMMPlayableDevice*
playButton IAnimatedButton*
pointerCaptured Boolean
position Γûá Γûá IPoint
presSpace IPresSpaceHandle
rect Γûá IRectangle
rewindButton IAnimatedButton*
shadowColor Γûá Γûá IColor
showing Boolean
size Γûá Γûá ISize
stepBackwardButton IAnimatedButton*
stepForwardButton IAnimatedButton*
stopButton IAnimatedButton*
tabStop Γûá Boolean
valid Boolean
visible Γûá Γûá Boolean
visibleRectangle IRectangle
ΓòÉΓòÉΓòÉ <hidden> Actions - IMMPlayerPanel ΓòÉΓòÉΓòÉ
Action Parameters
addToCell IWindow*, unsigned long, unsigned long,
unsigned long, unsigned long
applyBidiSettings BidiSettings&, Boolean, Boolean
capturePointer Boolean
columnWidth unsigned long
convertToGUIStyle IBitFlag&, Boolean
disable None
disableDragLines None
disableGridLines None
disableGroup None
disableNotification None
disableTabStop None
disableUpdate None
dispatchRemainingHandlers IEvent&, Boolean
enable Boolean
enableUpdate Boolean
handleException IException&, IEvent&
hide None
hideSourceEmphasis None
isColumnExpandable unsigned long
isLayoutDistorted unsigned long
isRowExpandable unsigned long
matchForMnemonic unsigned short
notifyObservers INotificationEvent&
positionBehindSibling IWindowHandle&
positionBehindSiblings None
positionOnSiblings None
postEvent unsigned long, IEventParameter1&,
IEventParameter2&
refresh IRectangle&
releasePointer None
releasePresSpace IPresSpaceHandle&
removeFromCell unsigned long, unsigned long
resetActiveColor None
resetBackgroundColor None
resetBorderColor None
resetDisabledBackgroundColor None
resetDisabledForegroundColor None
resetFont None
resetForegroundColor None
resetHiliteBackgroundColor None
resetHiliteForegroundColor None
resetInactiveColor None
resetMinimumSize None
resetShadowColor None
rowHeight unsigned long
sendEvent unsigned long, IEventParameter1&,
IEventParameter2&
setColumnWidth unsigned long, unsigned long, Boolean
setFocus None
setLayoutDistorted unsigned long, unsigned long
setRowHeight unsigned long, unsigned long, Boolean
show Boolean
showSourceEmphasis Boolean
windowInCell unsigned long, unsigned long
ΓòÉΓòÉΓòÉ <hidden> Events - IMMPlayerPanel ΓòÉΓòÉΓòÉ
Event Notification ID
commandEvent commandId
gotFocusEvent FOCUSTRUEID
inputDisabledEvent ENABLEFALSEID
inputEnabledEvent ENABLETRUEID
lostFocusEvent FOCUSFALSEID
systemCommandEvent systemCommandId
visibilityDisabledEvent VISIBLEFALSEID
visibilityEnabledEvent VISIBLETRUEID
ΓòÉΓòÉΓòÉ <hidden> General Settings - IMMPlayerPanel ΓòÉΓòÉΓòÉ
Subpart name Sets the name of the subpart (a part placed on a composite part).
Default value: The name of the part
ΓòÉΓòÉΓòÉ <hidden> Control Settings - IMMPlayerPanel ΓòÉΓòÉΓòÉ
Fly over short text Specifies the short text for the fly-over text control.
Default value: None
Fly over long text Specifies the long text for the fly-over text control.
Default value: None
Window id Sets the window identifier.
Default value: None
Help panel id Sets the help panel identifier for the part.
Default value: None
Enabled Enables the handler by default.
Default value: Selected
ΓòÉΓòÉΓòÉ <hidden> Styles Settings - IMMPlayerPanel ΓòÉΓòÉΓòÉ
defaultStyle() Resets the part to the original default style.
Default value: Selected
clipChildren Excludes the area occupied by the children of the window when
drawing in the window. Child windows are always "clipped" to their parent
window. When a parent window is painted, the clipChildren style controls
whether the invalidated region of the parent window includes the area
occupied by its children, thus preventing a window from painting over its
child windows.
Default value: The Default radio button is selected.
clipSiblings Controls which sibling window is displayed on top when multiple
siblings are displayed. Sibling windows are windows that share the same
parent window. Assign the clipSiblings style to the sibling window that you
want displayed on top of the other siblings, in Z-order.
Default value: The Default radio button is selected.
clipToParent Allows a window to paint outside of its window boundary up to the
window boundary of its parent.
Default value: The Default radio button is selected.
saveBits Optimizes the painting of a window by saving the screen image of the
area under the window as a bitmap and then using the bitmap to redraw the
window, when necessary.
Default value: The Default radio button is selected.
synchPaint Synchronously repaints the window. Without this style, painting
only occurs if there are no other events waiting to be processed.
Default value: The Default radio button is selected.
visible Makes the window visible. In general, controls are constructed as
visible, and frame windows are constructed as invisible.
Default value: The default is on, and the Default radio button is selected.
ΓòÉΓòÉΓòÉ <hidden> Handlers Settings - IMMPlayerPanel ΓòÉΓòÉΓòÉ
Handler name Sets the name of the default handler.
Default value: None
Handler list Sets the name of the handler for the MLE control.
Default value: None
Add after Adds the new choice after the selected choice in the list. If no
choice is selected, the new choice is added after the first choice in the
list.
Default value: Highlighted
Add before Adds the new choice before the selected choice in the list. If no
choice is selected, the new choice is added before the first choice in the
list.
Default value: Not highlighted
Move Determines whether a part and its descendants can be moved to a new
location.
Default value: Not highlighted
Remove Removes one item from the part and returns the count of the number of
items that remain.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ <hidden> Color Settings - IMMPlayerPanel ΓòÉΓòÉΓòÉ
Color area Sets the color of the given area. Choices are as follows:
Background
Sets the color for background text
Default value: Background is selected
Color selection Enables color selection by either color values or RGB values.
Select Colors or RGB. If you select Colors, you can set the Color values. If
you select RGB, you can set the RGB values.
Default value: Colors selected
Color values Sets the color value of the window area, or sets the passed
default if no color for the area has been set.
Default value: None
RGB values Sets the color values for the canvas.
Default value: Red=255, Green=255, Blue=255
ΓòÉΓòÉΓòÉ <hidden> Size/Position Settings - IMMPlayerPanel ΓòÉΓòÉΓòÉ
X field Sets the X coordinate of the part if it is not the client part.
Default value: Not available
Y field Sets the Y coordinate of the part if it is not the client part.
Default value: Not available
Width Sets the width of the canvas, if it is not the client part.
Default value: Not available
Height Sets the height of the canvas, if it is not the client part.
Default value: Not available
Minimum size Determines the minimum size of the part.
Select Calculate at execution time or Set value here. If you select
Calculate at execution time, the minimum size is determined dynamically. If
you select Set value here, you can set the Minimum size Width and Height
fields to define a fixed minimum size.
Default value: Calculate at execution time is selected
Width Sets the minimum-allowable width, which is set by the user's class.
Default value: None (calculated at execution time)
Height Sets the minimum-allowable height, which is set by the user's class.
Default value: None (calculated at execution time)
ΓòÉΓòÉΓòÉ 3.30. IMMSequencer ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Events
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IMMSequencer ΓòÉΓòÉΓòÉ
Title: IBM sequencer
Class name: IMMSequencer
Base part: IMMFileMedia
Part type: Nonvisual part
Part file: vbmm.vbb
An IMMSequencer part is a Musical Instrument Digital Interface (MIDI) file
audio player control.
The user can operate the sequencer through visual controls. You can easily
provide button controls with the IMMPlayerPanel part. You can provide volume
control for all audio devices with the IMMMasterAudio part.
Use an IMMSequencer part to provide standard audio player functions for MIDI
files.
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - IMMSequencer ΓòÉΓòÉΓòÉ
When building with an IMMSequencer part, you can do the following:
Define an initial volume setting. Do this by entering a value in the
volume field on the IMMSequencer part settings page. Values range from 0
for no volume to 100 for the maximum volume.
If you are providing an IMMMasterAudio part for volume control and are
not providing visual access to the volume setting for the sequencer, set
the volume field value to 100.
Provide visual access to the volume setting. Do this using a circular
slider as a volume dial:
- Use the Add part choice on the Composition Editor Options menu to
get an ICircularSlider part; then, drop it on a canvas.
- Define the circular slider as a volume control with values from 0 to
100.
- Connect the ICircularSlider value attribute to the IMMSequencer
volume attribute.
If you are providing visual volume control with an IMMMasterAudio part as
well as with the sequencer, the master audio volume setting determines
the maximum volume produced. The player volume is the product of the
master audio volume setting and the player volume setting. For example,
if the master audio volume is set at 50 and the player volume is set at
80, the player volume is 40 percent of its potential maximum.
Provide visual access to sequencer actions. Do this using animated
buttons that the user can press to activate controls. For example,
provide a play button as follows:
- Select an IAnimatedButton part from the parts palette and drop it on
a canvas.
- Define the animated button as a latchable play button. Do this as
follows:
-- Assign play bitmaps to the animated button. Do this by
selecting the play bitmap identifier in the Bitmap field on the
IAnimatedButton General settings page.
-- Give the button the appearance of remaining latched down while
it is active. Do this by setting the latchable field on the
IAnimatedButton Styles settings page.
- Connect the IAnimatedButton buttonClickEvent feature to the
IMMSequencer play action.
Define the speed format for the sequencer if you do not want to use the
system-provided format. Do this by selecting a choice for the speedFormat
field on the IMMSequencer part settings page.
Define the time format for the sequencer if you do not want to use the
system-provided format. Do this by selecting a choice for the timeFormat
field on the IMMSequencer part settings page.
ΓòÉΓòÉΓòÉ <hidden> Attributes - IMMSequencer ΓòÉΓòÉΓòÉ
Attribute S E Data type
acquired Boolean
aliasName IString
asDebugInfo IString
asString IString
audioEnabled Γûá Boolean
closeOnDestroy Γûá Boolean
description IString
deviceId unsigned long
deviceName IString
deviceType unsigned long
enabledForNotification Γûá Boolean
filename Γûá IString
isOpen Boolean
length unsigned long
mode Mode
position unsigned long
prerollTime IMMTime
prerollType PrerollType
readOnly Boolean
requiresFiles Boolean
speedFormat Γûá IMMSpeed::Format
supportsAudio Boolean
supportsDigitalTransfer Boolean
supportsDisableEject Boolean
supportsEject Boolean
supportsPlay Boolean
supportsRecord Boolean
supportsRecordInsertion Boolean
supportsSave Boolean
supportsStreaming Boolean
supportsVideo Boolean
supportsVolumeAdjustment Boolean
timeFormat Γûá IMMTime::Format
volume Γûá unsigned long
ΓòÉΓòÉΓòÉ <hidden> Actions - IMMSequencer ΓòÉΓòÉΓòÉ
Action Parameters
acquire ShareMode, Boolean, CallType
addCuePoint IMMTime&, CallType
close CallType
connectedDeviceId ConnectorType, CallType
cueForPlayback CallType
deletePendingEvents EventType
disableAudio AudioChannel, IMMMillisecondTime&, CallType
disableConnector ConnectorType, CallType
disableNotification None
enableConnector ConnectorType, Boolean, CallType
isConnectionSupported ConnectorType, CallType
isConnectorEnabled ConnectorType, CallType
loadOnThread IString&, Boolean
notifyObservers INotificationId&
open IString&, Boolean, CallType
openOnThread IString&, Boolean, CallType
operator = IStandardNotifier&
pause CallType
play IMMTime&, IMMTime&, Boolean, CallType
release CallType
removeCuePoint IMMTime&, CallType
resume Boolean, CallType
seek IMMTime&, CallType
seekToEnd CallType
seekToStart CallType
startPositionTracking IMMTime&, CallType
stepFrame unsigned long, Boolean, CallType
stop CallType
stopPositionTracking CallType
supportsCommand IMMNotifyEvent::Command, CallType
ΓòÉΓòÉΓòÉ <hidden> Events - IMMSequencer ΓòÉΓòÉΓòÉ
Event Notification ID
commandNotifyEvent commandNotifyId
cuePointEvent cuePointId
deviceEvent deviceEventId
passDeviceEvent passDeviceId
positionChangeEvent positionChangeId
ΓòÉΓòÉΓòÉ 3.31. IMMWaveAudio ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Events
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IMMWaveAudio ΓòÉΓòÉΓòÉ
Title: IBM wave audio
Class name: IMMWaveAudio
Base part: IMMConfigurableAudio
Part type: Nonvisual part
Part file: vbmm.vbb
An IMMWaveAudio part is a waveform file audio player and recorder control.
The user can operate the sequencer through visual controls. You can easily
provide button controls with the IMMPlayerPanel part. You can provide volume
control for all audio devices with the IMMMasterAudio part.
Use an IMMWaveAudio part to provide standard audio player functions for
waveform files.
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - IMMWaveAudio ΓòÉΓòÉΓòÉ
When building with an IMMWaveAudio part, you can do the following:
Define an initial volume setting. Do this by entering a value in the
volume field on the IMMWaveAudio part settings page. Values range from 0
for no volume to 100 for the maximum volume.
If you are providing an IMMMasterAudio part for volume control and are
not providing visual access to the volume setting for the waveform
player, set the volume field value to 100.
Provide visual access to the volume setting. Do this using a circular
slider as a volume dial:
- Use the Add part choice on the Composition Editor Options menu to
get an ICircularSlider part; then, drop it on a canvas.
- Define the circular slider as a volume control with values from 0 to
100.
- Connect the ICircularSlider value attribute to the IMMWaveAudio
volume attribute.
If you are providing visual volume control with an IMMMasterAudio part as
well as with the waveform player, the master audio volume setting
determines the maximum volume produced. The player volume is the product
of the master audio volume setting and the player volume setting. For
example, if the master audio volume is set at 50 and the player volume is
set at 80, the player volume is 40 percent of its potential maximum.
Provide visual access to waveform player actions. Do this using animated
buttons that the user can press to activate controls. For example,
provide a play button as follows:
- Select an IAnimatedButton part from the parts palette and drop it on
a canvas.
- Define the animated button as a latchable play button. Do this as
follows:
-- Assign play bitmaps to the animated button. Do this by
selecting the play bitmap identifier in the Bitmap field on the
IAnimatedButton General settings page.
-- Give the button the appearance of remaining latched down while
it is active. Do this by setting the latchable field on the
IAnimatedButton Styles settings page.
- Connect the IAnimatedButton buttonClickEvent feature to the
IMMWaveAudio play action.
Define the number of audio output channels for the waveform player. Do
this by entering a number in the channels field on the IMMWaveAudio part
settings page. Enter 1 for monophonic (mono) output or 2 for stereophonic
(stereo) output.
Define the audio format for the waveform player. The default format is
pcm. Do this by selecting a choice for the format field on the
IMMWaveAudio part settings page.
Define the speed format for the waveform player if you do not want to use
the system-provided format. Do this by selecting a choice for the
speedFormat field on the IMMWaveAudio part settings page.
Define the time format for the waveform player if you do not want to use
the system-provided format. Do this by selecting a choice for the
timeFormat field on the IMMWaveAudio part settings page.
ΓòÉΓòÉΓòÉ <hidden> Attributes - IMMWaveAudio ΓòÉΓòÉΓòÉ
Attribute S E Data type
acquired Boolean
aliasName IString
asDebugInfo IString
asString IString
audioEnabled Γûá Boolean
bitsPerSample Γûá unsigned long
blockAlignment Γûá unsigned long
bytesPerSecond Γûá unsigned long
canRedo Boolean
canUndo Boolean
channels Γûá unsigned long
closeOnDestroy Γûá Boolean
cutCopyBufferSize unsigned long
description IString
deviceId unsigned long
deviceName IString
deviceType unsigned long
enabledForNotification Γûá Boolean
filename Γûá IString
format Γûá IMMAudioBuffer::Format
isOpen Boolean
length unsigned long
mode Mode
position unsigned long
prerollTime IMMTime
prerollType PrerollType
readOnly Boolean
requiresFiles Boolean
samplesPerSecond Γûá unsigned long
speedFormat Γûá IMMSpeed::Format
supportsAudio Boolean
supportsDigitalTransfer Boolean
supportsDisableEject Boolean
supportsEject Boolean
supportsPlay Boolean
supportsRecord Boolean
supportsRecordInsertion Boolean
supportsSave Boolean
supportsStreaming Boolean
supportsVideo Boolean
supportsVolumeAdjustment Boolean
timeFormat Γûá IMMTime::Format
volume Γûá unsigned long
ΓòÉΓòÉΓòÉ <hidden> Actions - IMMWaveAudio ΓòÉΓòÉΓòÉ
Action Parameters
acquire ShareMode, Boolean, CallType
addCuePoint IMMTime&, CallType
close CallType
connectedDeviceId ConnectorType, CallType
copy IMMTime&, IMMTime&, CallType
copyFromBuffer IMMAudioBuffer&, CallType
copyToBuffer IMMAudioBuffer&, IMMTime&, IMMTime&, CallType
cueForPlayback CallType
cueForRecording CallType
cut IMMTime&, IMMTime&, CallType
cutToBuffer IMMAudioBuffer&, IMMTime&, IMMTime&, CallType
deletePendingEvents EventType
deleteSelection IMMTime&, IMMTime&, CallType
disableAudio AudioChannel, IMMMillisecondTime&, CallType
disableConnector ConnectorType, CallType
disableNotification None
enableConnector ConnectorType, Boolean, CallType
isConnectionSupported ConnectorType, CallType
isConnectorEnabled ConnectorType, CallType
loadOnThread IString&, Boolean
notifyObservers INotificationId&
open IString&, Boolean, CallType
openOnThread IString&, Boolean, CallType
operator = IStandardNotifier&
paste IMMTime&, IMMTime&, Boolean, CallType
pasteFromBuffer IMMAudioBuffer&, IMMTime&, IMMTime&, CallType
pasteToBuffer IMMAudioBuffer&, CallType
pause CallType
play IMMTime&, IMMTime&, Boolean, CallType
record Boolean, IMMTime&, IMMTime&, Boolean, CallType
redo CallType
release CallType
removeCuePoint IMMTime&, CallType
resume Boolean, CallType
save CallType
saveAs IString&, CallType
seek IMMTime&, CallType
seekToEnd CallType
seekToStart CallType
startPositionTracking IMMTime&, CallType
stepFrame unsigned long, Boolean, CallType
stop CallType
stopPositionTracking CallType
supportsCommand IMMNotifyEvent::Command, CallType
supportsWaveFormat unsigned long, unsigned long, unsigned long,
IMMAudioBuffer::Format, CallType
undo CallType
ΓòÉΓòÉΓòÉ <hidden> Events - IMMWaveAudio ΓòÉΓòÉΓòÉ
Event Notification ID
commandNotifyEvent commandNotifyId
cuePointEvent cuePointId
deviceEvent deviceEventId
passDeviceEvent passDeviceId
positionChangeEvent positionChangeId
ΓòÉΓòÉΓòÉ 3.32. IMultiCellCanvas ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Events
Settings Pages
General
Control
Styles
Handlers
Color
Size/Position
Font
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IMultiCellCanvas ΓòÉΓòÉΓòÉ
Title: IBM resizable multicell canvas
Class name: IMultiCellCanvas
Base part: ICanvas
Part type: Visual part
Part file: vbbase.vbb
An IMultiCellCanvas part is a set of cells in rows and columns that can
contain controls spanning rows and columns. This provides flexibility in
arranging controls on the canvas.
The user interacts with controls placed on the canvas, not with the canvas
itself.
Use an IMultiCellCanvas part to provide freely arranged canvas cells within a
framework, such as one of the following:
The client area of a frame window
A view port
A multicell canvas cell
A split canvas pane
A notebook page
You can then place other controls within the cells of the multicell canvas.
You can also use a multicell canvas as the base part for a composite part.
Then, you can add the canvas with its controls as a subpart on a canvas in
another composite part.
The cells in a multicell canvas are adjusted for varying control text length.
This enhances national language support. If you build the multicell canvas
with some expandable rows and columns, controls in the cells remain uniformly
spaced when the user resizes the canvas.
Alternatively, use one of the following canvases:
ICanvas for a single canvas cell
ISplitCanvas for split windows
ISetCanvas for canvas cells in uniform rows or columns
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - IMultiCellCanvas ΓòÉΓòÉΓòÉ
When building with an IMultiCellCanvas part, you can do the following:
Place controls in the multicell canvas. Do this by dropping controls in
the cells where they are to begin. The cell is sized to accommodate the
largest minimum size of controls in the row and column.
Do not place controls in the first row and the first column. Reserve them
as left and top margins.
If you drop a control in the expansion space initially provided on the
right and bottom of the canvas, a new row or column is added to
accommodate the size of the control.
Stretch a control to span multiple rows or columns. Do this as follows:
1. Select the control with mouse button 1
2. Press an Alt key and drag a corner handle of the control to the far
side of the row or column that the control is to end in.
Add or remove rows. Do this as follows:
1. Press mouse button 2 and select the Rows choice in the contextual
menu.
2. Select the Add row after, the Add row before, or the Delete row
choice from the submenu.
Add or remove columns. Do this as follows:
1. Select the Columns choice in the contextual menu.
2. Select the Add column after, the Add column before, or the Delete
column choice from the submenu.
Create expansion space between controls so they remain evenly spaced when
the user resizes the canvas. Do this by changing the Expand value for
rows and columns between controls to y (yes). Change these values in the
Rows table and the Columns table on the IMultiCellCanvas General settings
page.
The initial expansion space on the right or bottom of the canvas is
removed when you make a column or row expandable.
You can also add and remove rows and columns in these tables.
Create right and bottom margins for the multicell canvas. Do this by
adding a row and column at the right and bottom. Do not place any
controls in these margins.
Add a handler for all parts on the canvas. Do this as follows:
- Add the handler name and parameters in the Handler list field on the
IMultiCellCanvas Handlers settings page.
- Type the .hpp file name for the handler in the Class Editor Required
include files field.
ΓòÉΓòÉΓòÉ <hidden> Attributes - IMultiCellCanvas ΓòÉΓòÉΓòÉ
Attribute S E Data type
activeColor Γûá Γûá IColor
asDebugInfo IString
asString IString
autoDeleteObject Γûá Boolean
autoDestroyWindow Γûá Boolean
backgroundColor Γûá Γûá IColor
bidiSupported Boolean
borderColor Γûá Γûá IColor
characterSize ISize
defaultCell Γûá ISize
defaultPushButton IWindowHandle
disabledBackgroundColor Γûá Γûá IColor
disabledForegroundColor Γûá Γûá IColor
dragLines Γûá Boolean
enabled Γûá Γûá Boolean
enabledForNotification Γûá Boolean
focus Γûá Boolean
font Γûá Γûá IFont
foregroundColor Γûá Γûá IColor
frameWindow Boolean
gridLines Γûá Boolean
group Γûá Boolean
handle IWindowHandle
hiliteBackgroundColor Γûá Γûá IColor
hiliteForegroundColor Γûá Γûá IColor
id Γûá unsigned long
inactiveColor Γûá Γûá IColor
itemProvider Γûá IDMItemProvider*
layoutAdjustment IRectangle
menu
messageQueue IMessageQueueHandle
minimumSize Γûá ISize
nativeRect IRectangle
origDefaultButtonHandle IWindowHandle
owner Γûá IWindow*
parent Γûá IWindow*
parentSize ISize
pointerCaptured Boolean
position Γûá Γûá IPoint
presSpace IPresSpaceHandle
rect Γûá IRectangle
shadowColor Γûá Γûá IColor
showing Boolean
size Γûá Γûá ISize
tabStop Γûá Boolean
valid Boolean
visible Γûá Γûá Boolean
visibleRectangle IRectangle
ΓòÉΓòÉΓòÉ <hidden> Actions - IMultiCellCanvas ΓòÉΓòÉΓòÉ
Action Parameters
addToCell IWindow*, unsigned long, unsigned long,
unsigned long, unsigned long
applyBidiSettings BidiSettings&, Boolean, Boolean
capturePointer Boolean
columnWidth unsigned long
convertToGUIStyle IBitFlag&, Boolean
disable None
disableDragLines None
disableGridLines None
disableGroup None
disableNotification None
disableTabStop None
disableUpdate None
dispatchRemainingHandlers IEvent&, Boolean
enable Boolean
enableUpdate Boolean
handleException IException&, IEvent&
hide None
hideSourceEmphasis None
isColumnExpandable unsigned long
isLayoutDistorted unsigned long
isRowExpandable unsigned long
matchForMnemonic unsigned short
notifyObservers INotificationEvent&
positionBehindSibling IWindowHandle&
positionBehindSiblings None
positionOnSiblings None
postEvent unsigned long, IEventParameter1&,
IEventParameter2&
refresh IRectangle&
releasePointer None
releasePresSpace IPresSpaceHandle&
removeFromCell unsigned long, unsigned long
resetActiveColor None
resetBackgroundColor None
resetBorderColor None
resetDisabledBackgroundColor None
resetDisabledForegroundColor None
resetFont None
resetForegroundColor None
resetHiliteBackgroundColor None
resetHiliteForegroundColor None
resetInactiveColor None
resetMinimumSize None
resetShadowColor None
rowHeight unsigned long
sendEvent unsigned long, IEventParameter1&,
IEventParameter2&
setColumnWidth unsigned long, unsigned long, Boolean
setFocus None
setLayoutDistorted unsigned long, unsigned long
setRowHeight unsigned long, unsigned long, Boolean
show Boolean
showSourceEmphasis Boolean
windowInCell unsigned long, unsigned long
ΓòÉΓòÉΓòÉ <hidden> Events - IMultiCellCanvas ΓòÉΓòÉΓòÉ
Event Notification ID
commandEvent commandId
gotFocusEvent FOCUSTRUEID
inputDisabledEvent ENABLEFALSEID
inputEnabledEvent ENABLETRUEID
lostFocusEvent FOCUSFALSEID
systemCommandEvent systemCommandId
visibilityDisabledEvent VISIBLEFALSEID
visibilityEnabledEvent VISIBLETRUEID
ΓòÉΓòÉΓòÉ <hidden> General Settings - IMultiCellCanvas ΓòÉΓòÉΓòÉ
Subpart name Sets the name of the subpart (a part placed on a composite part).
Default value: The name of the part
Controls Defines the name of all rows and columns that appear on the multicell
canvas, and sets how many rows and columns to display.
Default value: None
Rows Sets the number and height of rows, and whether or not their height can
be adjusted.
Default value: Nil
Columns Sets the number and width of columns, and whether or not they can be
widened.
Default value: Foreground is selected
Add Adds a row or column to the multicell canvas.
Default value: Selectable
Add after Adds a row or column to the multicell canvas after the the selected
row or column.
Default value: Not selectable
Add before Adds a row or column to the multicell canvas before the the
selected row or column.
Default value: Not selectable
Delete Deletes the selected row or column from the canvas.
Default value: Not selectable
ΓòÉΓòÉΓòÉ <hidden> Control Settings - IMultiCellCanvas ΓòÉΓòÉΓòÉ
Fly over short text Specifies the short text for the fly-over text control.
Default value: None
Fly over long text Specifies the long text for the fly-over text control.
Default value: None
Window id Sets the window identifier.
Default value: None
Help panel id Sets the help panel identifier for the part.
Default value: None
Enabled Enables the handler by default.
Default value: Selected
ΓòÉΓòÉΓòÉ <hidden> Styles Settings - IMultiCellCanvas ΓòÉΓòÉΓòÉ
defaultStyle() Resets the part to the original default style.
Default value: Selected
dragLines Adds draggable grid lines between the rows and columns of the
multicell canvas.
Default value: The default is off, and the Default radio button is selected.
gridLines Adds grid lines between the rows and columns of the multicell
canvas.
Default value: The default is off, and the Default radio button is selected.
clipChildren Excludes the area occupied by the children of the window when
drawing in the window. Child windows are always "clipped" to their parent
window. When a parent window is painted, the clipChildren style controls
whether the invalidated region of the parent window includes the area
occupied by its children, thus preventing a window from painting over its
child windows.
Default value: The Default radio button is selected.
clipSiblings Controls which sibling window is displayed on top when multiple
siblings are displayed. Sibling windows are windows that share the same
parent window. Assign the clipSiblings style to the sibling window that you
want displayed on top of the other siblings, in Z-order.
Default value: The Default radio button is selected.
clipToParent Allows a window to paint outside of its window boundary up to the
window boundary of its parent.
Default value: The Default radio button is selected.
saveBits Optimizes the painting of a window by saving the screen image of the
area under the window as a bitmap and then using the bitmap to redraw the
window, when necessary.
Default value: The Default radio button is selected.
synchPaint Synchronously repaints the window. Without this style, painting
only occurs if there are no other events waiting to be processed.
Default value: The Default radio button is selected.
visible Makes the window visible. In general, controls are constructed as
visible, and frame windows are constructed as invisible.
Default value: The default is on, and the Default radio button is selected.
ΓòÉΓòÉΓòÉ <hidden> Handlers Settings - IMultiCellCanvas ΓòÉΓòÉΓòÉ
Handler name Sets the name of the default handler.
Default value: None
Handler list Sets the name of the handler for the MLE control.
Default value: None
Add after Adds the new choice after the selected choice in the list. If no
choice is selected, the new choice is added after the first choice in the
list.
Default value: Highlighted
Add before Adds the new choice before the selected choice in the list. If no
choice is selected, the new choice is added before the first choice in the
list.
Default value: Not highlighted
Move Determines whether a part and its descendants can be moved to a new
location.
Default value: Not highlighted
Remove Removes one item from the part and returns the count of the number of
items that remain.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ <hidden> Color Settings - IMultiCellCanvas ΓòÉΓòÉΓòÉ
Color area Sets the color of the given area. Choices are as follows:
Background
Sets the color for background text
Default value: Background is selected
Color selection Enables color selection by either color values or RGB values.
Select Colors or RGB. If you select Colors, you can set the Color values. If
you select RGB, you can set the RGB values.
Default value: Colors selected
Color values Sets the color value of the window area, or sets the passed
default if no color for the area has been set.
Default value: None
RGB values Sets the color values for the canvas.
Default value: Red=255, Green=255, Blue=255
ΓòÉΓòÉΓòÉ <hidden> Size/Position Settings - IMultiCellCanvas ΓòÉΓòÉΓòÉ
X field Sets the X coordinate of the part.
Default value: The x coordinate of the part currently positioned on the
free-form surface
Y field Sets the Y coordinate of the point.
Default value: The y coordinate of the part currently positioned on the
free-form surface
Width Sets the width of the text.
Default value: None
Height Sets the height of the text.
Default value: None
Minimum size Determines the minimum size of the part.
Select Calculate at execution time or Set value here. If you select
Calculate at execution time, the minimum size is determined dynamically. If
you select Set value here, you can set the Minimum size Width and Height
fields to define a fixed minimum size.
Default value: Calculate at execution time is selected
Width Sets the minimum-allowable width, which is set by the user's class.
Default value: None (calculated at execution time)
Height Sets the minimum-allowable height, which is set by the user's class.
Default value: None (calculated at execution time)
ΓòÉΓòÉΓòÉ <hidden> Font Settings - IMultiCellCanvas ΓòÉΓòÉΓòÉ
Name Sets the name of the font.
Default value: System proportional
Point size Sets the point size of the font.
Default value: 10
Style Sets the style for the part.
Default value: None
Emphasis Gives the part emphasis. If a part is specified, the emphasis is
drawn around the part.
Default value: None
Edit Opens an edit field on a part or setting.
Default value: Highlighted
Default font Sets the current default font style.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ 3.33. IMultiLineEdit ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Events
Settings Pages
General
Control
Styles
Handlers
Color
Size/Position
Font
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IMultiLineEdit ΓòÉΓòÉΓòÉ
Title: IBM multiple-line edit control
Class name: IMultiLineEdit
Base part: ITextControl
Part type: Visual part
Part file: vbbase.vbb
An IMultiLineEdit part is a multiple-line entry (MLE) field.
The user can type or place text into the multiple-line entry field.
Use an IMultiLineEdit part to let the user define or view multiple-line text
data. Alternatively, use an IEntryField part for single-line data.
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - IMultiLineEdit ΓòÉΓòÉΓòÉ
When building with an IMultiLineEdit part, you can do the following:
Prime the multiple-line entry (MLE) field with variable initial data. Do
this by connecting your data source to the text attribute. Your
application should make this connection before it shows the frame window.
Allow the user to reach the entry field by using a tab key. Do this by
setting the tabStop field to On on the IMultiLineEdit Styles settings
page.
Load the MLE when the user presses the OK push button in a file dialog.
Do this with an IMultiLineEdit part and an IVBFileDialog as follows:
1. Connect the IVBFileDialog pressedOK event to the IMultiLineEdit
importFromFile action.
2. Connect the IVBFileDialog fileName attribute to the fileName
parameter of the pressedOK-to-importFromFile connection.
Save the contents of the MLE to a file when the user presses the OK push
button in a file dialog. Do this with an IMultiLineEdit part and an
IVBFileDialog as follows:
1. Connect the IVBFileDialog pressedOK event to the IMultiLineEdit
exportToFile action.
2. Connect the IVBFileDialog fileName attribute to the fileName
parameter of the pressedOK-to-exportToFile connection.
ΓòÉΓòÉΓòÉ <hidden> Attributes - IMultiLineEdit ΓòÉΓòÉΓòÉ
Attribute S E Data type
activeColor Γûá Γûá IColor
asDebugInfo IString
asString IString
autoDeleteObject Γûá Boolean
autoDestroyWindow Γûá Boolean
backgroundColor Γûá Γûá IColor
bidiSupported Boolean
borderColor Γûá Γûá IColor
changed Boolean
characterSize ISize
clipboardHasTextFormat Boolean
cursorLinePosition Γûá unsigned long
cursorPosition Γûá unsigned long
defaultPushButton IWindowHandle
disabledBackgroundColor Γûá Γûá IColor
disabledForegroundColor Γûá Γûá IColor
displaySize ISize
editRegionHeight Γûá unsigned long
editRegionWidth Γûá unsigned long
enabled Γûá Γûá Boolean
enabledForNotification Γûá Boolean
focus Γûá Boolean
font Γûá Γûá IFont
foregroundColor Γûá Γûá IColor
frameWindow Boolean
group Γûá Boolean
handle IWindowHandle
hasSelectedText Boolean
hiliteBackgroundColor Γûá Γûá IColor
hiliteForegroundColor Γûá Γûá IColor
id Γûá unsigned long
inactiveColor Γûá Γûá IColor
isDigits Γûá
itemProvider Γûá IDMItemProvider*
layoutAdjustment IRectangle
limit Γûá Γûá unsigned long
menu
messageQueue IMessageQueueHandle
minimumSize Γûá ISize
nativeRect IRectangle
numberOfLines unsigned long
owner Γûá IWindow*
parent Γûá IWindow*
parentSize ISize
pointerCaptured Boolean
position Γûá Γûá IPoint
presSpace IPresSpaceHandle
rect Γûá IRectangle
selectedRange IRange
selectedText IString
selectedTextLength unsigned long
shadowColor Γûá Γûá IColor
showing Boolean
size Γûá Γûá ISize
tabStop Γûá Boolean
text Γûá Γûá IString
textLength Γûá unsigned long
top Γûá unsigned long
undoable Boolean
valid Boolean
valueAsDouble Γûá Γûá
valueAsInt Γûá Γûá
valueAsUnsigned Γûá Γûá
visible Γûá Γûá Boolean
visibleLines unsigned long
visibleRectangle IRectangle
wordWrap Γûá Boolean
writeable Γûá Γûá Boolean
ΓòÉΓòÉΓòÉ <hidden> Actions - IMultiLineEdit ΓòÉΓòÉΓòÉ
Action Parameters
add char*, unsigned long, EOLFormat
addAsLast char*, unsigned long, EOLFormat
addAtOffset char*, unsigned long, unsigned long, EOLFormat
addLine char*, unsigned long, EOLFormat
addLineAsLast char*, EOLFormat
applyBidiSettings BidiSettings&, Boolean, Boolean
capturePointer Boolean
clear unsigned long
convertToGUIStyle IBitFlag&, Boolean
copy unsigned long
cut unsigned long
disable None
disableDataUpdate None
disableGroup None
disableNotification None
disableTabStop None
disableUpdate None
disableWordWrap None
discard None
dispatchRemainingHandlers IEvent&, Boolean
enable Boolean
enableUpdate Boolean
exportSelectedTextToFile char*, EOLFormat
exportToFile char*, EOLFormat
handleException IException&, IEvent&
hide None
hideSourceEmphasis None
importFromFile char*, EOLFormat
isLayoutDistorted unsigned long
matchForMnemonic unsigned short
notifyObservers INotificationEvent&
paste None
positionBehindSibling IWindowHandle&
positionBehindSiblings None
positionOnSiblings None
postEvent unsigned long, IEventParameter1&,
IEventParameter2&
refresh IRectangle&
releasePointer None
releasePresSpace IPresSpaceHandle&
removeAll None
removeLine unsigned long
resetActiveColor None
resetBackgroundColor None
resetBorderColor None
resetChangedFlag None
resetDisabledBackgroundColor None
resetDisabledForegroundColor None
resetFont None
resetForegroundColor None
resetHiliteBackgroundColor None
resetHiliteForegroundColor None
resetInactiveColor None
resetMinimumSize None
resetShadowColor None
selectRange constIRange&range, unsigned long
sendEvent unsigned long, IEventParameter1&,
IEventParameter2&
setChangedFlag Boolean
setEditRegion None
setFocus None
setLayoutDistorted unsigned long, unsigned long
setTab unsigned long
show Boolean
showSourceEmphasis Boolean
undo None
ΓòÉΓòÉΓòÉ <hidden> Events - IMultiLineEdit ΓòÉΓòÉΓòÉ
Event Notification ID
commandEvent commandId
gotFocusEvent FOCUSTRUEID
inputDisabledEvent ENABLEFALSEID
inputEnabledEvent ENABLETRUEID
lostFocusEvent FOCUSFALSEID
systemCommandEvent systemCommandId
visibilityDisabledEvent VISIBLEFALSEID
visibilityEnabledEvent VISIBLETRUEID
ΓòÉΓòÉΓòÉ <hidden> General Settings - IMultiLineEdit ΓòÉΓòÉΓòÉ
Subpart name Sets the name of the subpart (a part placed on a composite part).
Default value: The name of the part
Text Sets the text for the part.
Default value: The name of the part
Limit Sets the length (in bytes) of the longest text the part can hold.
Default value: 4 294 967 295
ΓòÉΓòÉΓòÉ <hidden> Control Settings - IMultiLineEdit ΓòÉΓòÉΓòÉ
Fly over short text Specifies the short text for the fly-over text control.
Default value: None
Fly over long text Specifies the long text for the fly-over text control.
Default value: None
Window id Sets the window identifier.
Default value: None
Help panel id Sets the help panel identifier for the part.
Default value: None
Enabled Enables the handler by default.
Default value: Selected
ΓòÉΓòÉΓòÉ <hidden> Styles Settings - IMultiLineEdit ΓòÉΓòÉΓòÉ
defaultStyle() Resets the part to the original default style.
Default value: Selected
border Draws a border around the frame window, or sets the color of the border
that surrounds the button window.
Default value: The Default radio button is selected.
readOnly Prevents entering input into the field.
Default value: The default is off, and the Default radio button is selected.
horizontalScroll Provides a horizontal scroll bar for the part.
Default value: The default is on, and the Default radio button is selected.
verticalScroll Provides a vertical scroll bar for the part.
Default value: The Default radio button is selected.
ignoreTab Sets the MLE so it ignore tab key strokes. The function sends a
keyboard event to the owner of the MLE.
Default value: The Default radio button is selected.
wordWrap Sets the word-wrap style for the part.
Default value: The default is on, and the Default radio button is selected.
group Identifies the control as being the first in a group. No other controls
in the group can have this style. Controls in the group must be siblings
that are constructed following the first control. The group can be cursored
and when the last control in the group is reached, the cursor returns the
first control in the group.
Default value: The default is off, and the Default radio button is selected.
tabStop Identifies the control as one to which the user can tab.
Default value: The default is off, and the Default radio button is selected.
clipChildren Excludes the area occupied by the children of the window when
drawing in the window. Child windows are always "clipped" to their parent
window. When a parent window is painted, the clipChildren style controls
whether the invalidated region of the parent window includes the area
occupied by its children, thus preventing a window from painting over its
child windows.
Default value: The Default radio button is selected.
clipSiblings Controls which sibling window is displayed on top when multiple
siblings are displayed. Sibling windows are windows that share the same
parent window. Assign the clipSiblings style to the sibling window that you
want displayed on top of the other siblings, in Z-order.
Default value: The Default radio button is selected.
clipToParent Allows a window to paint outside of its window boundary up to the
window boundary of its parent.
Default value: The Default radio button is selected.
saveBits Optimizes the painting of a window by saving the screen image of the
area under the window as a bitmap and then using the bitmap to redraw the
window, when necessary.
Default value: The Default radio button is selected.
synchPaint Synchronously repaints the window. Without this style, painting
only occurs if there are no other events waiting to be processed.
Default value: The Default radio button is selected.
visible Makes the window visible. In general, controls are constructed as
visible, and frame windows are constructed as invisible.
Default value: The default is on, and the Default radio button is selected.
ΓòÉΓòÉΓòÉ <hidden> Handlers Settings - IMultiLineEdit ΓòÉΓòÉΓòÉ
Handler name Sets the name of the default handler.
Default value: None
Handler list Sets the name of the handler for the MLE control.
Default value: None
Add after Adds the new choice after the selected choice in the list. If no
choice is selected, the new choice is added after the first choice in the
list.
Default value: Highlighted
Add before Adds the new choice before the selected choice in the list. If no
choice is selected, the new choice is added before the first choice in the
list.
Default value: Not highlighted
Move Determines whether a part and its descendants can be moved to a new
location.
Default value: Not highlighted
Remove Removes one item from the part and returns the count of the number of
items that remain.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ <hidden> Color Settings - IMultiLineEdit ΓòÉΓòÉΓòÉ
Color area Sets the color of the given area. Choices are as follows:
Foreground
Sets the color for foreground text
Background
Sets the color for background text
Border
Sets the color of the border that surrounds the part.
Default value: Foreground is selected
Color selection Enables color selection by either color values or RGB values.
Select Colors or RGB. If you select Colors, you can set the Color values. If
you select RGB, you can set the RGB values.
Default value: RGB selected
Color values Sets the color value of the window area, or sets the passed
default if no color for the area has been set.
Default value: None
RGB values Sets the color values for the window area.
Default value: Not set
ΓòÉΓòÉΓòÉ <hidden> Size/Position Settings - IMultiLineEdit ΓòÉΓòÉΓòÉ
X field Sets the X coordinate of the part.
Default value: The x coordinate of the part currently positioned on the
free-form surface
Y field Sets the Y coordinate of the point.
Default value: The y coordinate of the part currently positioned on the
free-form surface
Width Sets the width of the text.
Default value: None
Height Sets the height of the text.
Default value: None
Minimum size Determines the minimum size of the part.
Select Calculate at execution time or Set value here. If you select
Calculate at execution time, the minimum size is determined dynamically. If
you select Set value here, you can set the Minimum size Width and Height
fields to define a fixed minimum size.
Default value: Calculate at execution time is selected
Width Sets the minimum-allowable width, which is set by the user's class.
Default value: None (calculated at execution time)
Height Sets the minimum-allowable height, which is set by the user's class.
Default value: None (calculated at execution time)
ΓòÉΓòÉΓòÉ <hidden> Font Settings - IMultiLineEdit ΓòÉΓòÉΓòÉ
Name Sets the name of the font.
Default value: System proportional
Point size Sets the point size of the font.
Default value: 10
Style Sets the style for the part.
Default value: None
Emphasis Gives the part emphasis. If a part is specified, the emphasis is
drawn around the part.
Default value: None
Edit Opens an edit field on a part or setting.
Default value: Highlighted
Default font Sets the current default font style.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ 3.34. INotebook ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Events
Settings Pages
General
Control
Styles
Handlers
Color
Size/Position
Font
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - INotebook ΓòÉΓòÉΓòÉ
Title: IBM notebook control
Class name: INotebook
Base part: IControl
Part type: Visual part
Part file: vbbase.vbb
An INotebook part is a software representation of a physical notebook. It
presents information on pages and marks the first page of each section with a
tab.
The user can do the following with a notebook:
Turn the pages by clicking on page buttons
Move directly to a section by selecting a tab
View or change information by using other controls
Use an INotebook part for settings choices or for information that can be
organized into sections.
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - INotebook ΓòÉΓòÉΓòÉ
When building with an INotebook part, you can do the following:
Place a notebook in a frame window. Do this by selecting an INotebook
part from the parts palette and dropping it on the client area of a frame
window.
Define the orientation of a notebook. Do this by selecting the back page
and major tab orientation you want in the Layout field on the INotebook
General settings page.
Define the binding for a notebook. Do this by selecting the Solid or
Spiral choice in the Binding field on the INotebook General settings
page.
Define tab appearance for a notebook. Do this by selecting the shape you
want in the tabShape field and the tab text alignment you want in the Tab
Justification field on the INotebook General settings page.
By default, the tab size is determined by the underlying class. If you
want to set a tab size, set the majorTab and minorTab fields on the
INotebook General settings page.
Define the alignment of status text at the bottom of each notebook page.
Do this by selecting the alignment you want in the Status area
Justification field on the INotebook General settings page.
Add a page to a notebook. Do this by clicking mouse button 2 on the
notebook and selecting an add page choice. When there are no pages in the
notebook, your only page choice is Add Initial Page. When the notebook
has one or more pages, select Add Page After or Add Page Before. An
IVBNotebookPage part is placed in the notebook.
ΓòÉΓòÉΓòÉ <hidden> Attributes - INotebook ΓòÉΓòÉΓòÉ
Attribute S E Data type
activeColor Γûá Γûá IColor
asDebugInfo IString
asString IString
autoDeleteObject Γûá Boolean
autoDestroyWindow Γûá Boolean
backgroundColor Γûá Γûá IColor
bidiSupported Boolean
binding Γûá Binding
borderColor Γûá Γûá IColor
characterSize ISize
defaultPushButton IWindowHandle
disabledBackgroundColor Γûá Γûá IColor
disabledForegroundColor Γûá Γûá IColor
empty Boolean
enabled Γûá Γûá Boolean
enabledForNotification Γûá Boolean
firstPage IPageHandle
focus Γûá Boolean
font Γûá Γûá IFont
foregroundColor Γûá Γûá IColor
frameWindow Boolean
group Γûá Boolean
handle IWindowHandle
hiliteBackgroundColor Γûá Γûá IColor
hiliteForegroundColor Γûá Γûá IColor
id Γûá unsigned long
inactiveColor Γûá Γûá IColor
itemProvider Γûá IDMItemProvider*
lastPage IPageHandle
layoutAdjustment IRectangle
majorTabBackgroundColor Γûá Γûá IColor
majorTabForegroundColor Γûá Γûá IColor
menu
messageQueue IMessageQueueHandle
minimumSize Γûá ISize
minorTabBackgroundColor Γûá Γûá IColor
minorTabForegroundColor Γûá Γûá IColor
nativeRect IRectangle
orientation Γûá Γûá Orientation
owner Γûá IWindow*
pageBackgroundColor Γûá Γûá IColor
pageSize ISize
parent Γûá IWindow*
parentSize ISize
pointerCaptured Boolean
position Γûá Γûá IPoint
presSpace IPresSpaceHandle
rect Γûá IRectangle
shadowColor Γûá Γûá IColor
showing Boolean
size Γûá Γûá ISize
statusTextAlignment Γûá TextAlignment
tabShape Γûá TabShape
tabStop Γûá Boolean
tabTextAlignment Γûá TextAlignment
topPage IPageHandle
totalPages unsigned long
valid Boolean
visible Γûá Γûá Boolean
visibleRectangle IRectangle
ΓòÉΓòÉΓòÉ <hidden> Actions - INotebook ΓòÉΓòÉΓòÉ
Action Parameters
addFirstPage PageSettings&, IWindow*
addLastPage PageSettings&, IWindow*
addPageAfter PageSettings&, Cursor&, IWindow*
addPageBefore PageSettings&, Cursor&, IWindow*
applyBidiSettings BidiSettings&, Boolean, Boolean
capturePointer Boolean
convertToGUIStyle IBitFlag&, Boolean
disable None
disableGroup None
disableNotification None
disableTabStop None
disableUpdate None
dispatchRemainingHandlers IEvent&, Boolean
enable Boolean
enableUpdate Boolean
handleException IException&, IEvent&
hide None
hideSourceEmphasis None
isLayoutDistorted unsigned long
matchForMnemonic unsigned short
nextPage IPageHandle&
notebookSize IPageHandle&
notifyObservers INotificationEvent&
pageSettings Cursor&
pagesToEnd Cursor&
pagesToMajorTab Cursor&
pagesToMinorTab Cursor&
positionBehindSibling IWindowHandle&
positionBehindSiblings None
positionOnSiblings None
postEvent unsigned long, IEventParameter1&,
IEventParameter2&
previousPage IPageHandle&
refresh IRectangle&
refreshTabs None
releasePointer None
releasePresSpace IPresSpaceHandle&
removeAllPages None
removePage IPageHandle&
removeTabSection IPageHandle&
resetActiveColor None
resetBackgroundColor None
resetBorderColor None
resetDisabledBackgroundColor None
resetDisabledForegroundColor None
resetFont None
resetForegroundColor None
resetHiliteBackgroundColor None
resetHiliteForegroundColor None
resetInactiveColor None
resetMajorTabBackgroundColor None
resetMajorTabForegroundColor None
resetMinimumSize None
resetMinorTabBackgroundColor None
resetMinorTabForegroundColor None
resetPageBackgroundColor None
resetShadowColor None
sendEvent unsigned long, IEventParameter1&,
IEventParameter2&
setFocus None
setLayoutDistorted unsigned long, unsigned long
setMajorTabSize ISize&
setMinorTabSize ISize&
setPageButtonSize ISize&
setStatusText IPageHandle&, IResourceId&
setTabBitmap IPageHandle&, IResourceId&
setTabText IPageHandle&, char*
setUserData IPageHandle&, unsigned long
setWindow IPageHandle&, IWindow*
show Boolean
showSourceEmphasis Boolean
turnToPage Cursor&
window IPageHandle&
ΓòÉΓòÉΓòÉ <hidden> Events - INotebook ΓòÉΓòÉΓòÉ
Event Notification ID
commandEvent commandId
gotFocusEvent FOCUSTRUEID
inputDisabledEvent ENABLEFALSEID
inputEnabledEvent ENABLETRUEID
lostFocusEvent FOCUSFALSEID
systemCommandEvent systemCommandId
visibilityDisabledEvent VISIBLEFALSEID
visibilityEnabledEvent VISIBLETRUEID
ΓòÉΓòÉΓòÉ <hidden> General Settings - INotebook ΓòÉΓòÉΓòÉ
Subpart name Sets the name of the subpart (a part placed on a composite part).
Default value: The name of the part
Layout Defines the placement and layout of the part.
Default value: First orientation (to the left of those shown) selected
Binding Sets the type of binding used for the notebook.
Default value: Solid
tabShape Sets the shape of the notebook tabs.
Default value: Square
Preview Lets you preview the text, which displays in the current font.
Default value: Tab tab on the right appears as Page 1
Justification Defines the alignment for the text in the status line for the
notebook.
Default value: Left
Tab Defines the alignment for the text in the tabs for the notebook.
Default value: Left
Width Sets the width of the arrow push button on the notebook page.
Default value: None
Height Sets the height of the arrow push button on the notebook page.
Default value: None
Width Sets the size (width) of the major tabs in the notebook, in pixels.
Default value: None
Height Sets the size (height) of the major tabs in the notebook, in pixels.
Default value: None
Width Sets the size (width) of the minor tabs in the notebook, in pixels.
Default value: None
Height Sets the size (height) of the minor tabs in the notebook, in pixels.
Default value: None
ΓòÉΓòÉΓòÉ <hidden> Control Settings - INotebook ΓòÉΓòÉΓòÉ
Fly over short text Specifies the short text for the fly-over text control.
Default value: None
Fly over long text Specifies the long text for the fly-over text control.
Default value: None
Window id Sets the window identifier.
Default value: None
Help panel id Sets the help panel identifier for the part.
Default value: None
Enabled Enables the handler by default.
Default value: Selected
ΓòÉΓòÉΓòÉ <hidden> Styles Settings - INotebook ΓòÉΓòÉΓòÉ
defaultStyle() Resets the part to the original default style.
Default value: Selected
group Identifies the control as being the first in a group. No other controls
in the group can have this style. Controls in the group must be siblings
that are constructed following the first control. The group can be cursored
and when the last control in the group is reached, the cursor returns the
first control in the group.
Default value: The default is off, and the Default radio button is selected.
tabStop Identifies the control as one to which the user can tab.
Default value: The default is off, and the Default radio button is selected.
clipChildren Excludes the area occupied by the children of the window when
drawing in the window. Child windows are always "clipped" to their parent
window. When a parent window is painted, the clipChildren style controls
whether the invalidated region of the parent window includes the area
occupied by its children, thus preventing a window from painting over its
child windows.
Default value: The Default radio button is selected.
clipSiblings Controls which sibling window is displayed on top when multiple
siblings are displayed. Sibling windows are windows that share the same
parent window. Assign the clipSiblings style to the sibling window that you
want displayed on top of the other siblings, in Z-order.
Default value: The Default radio button is selected.
clipToParent Allows a window to paint outside of its window boundary up to the
window boundary of its parent.
Default value: The Default radio button is selected.
saveBits Optimizes the painting of a window by saving the screen image of the
area under the window as a bitmap and then using the bitmap to redraw the
window, when necessary.
Default value: The Default radio button is selected.
synchPaint Synchronously repaints the window. Without this style, painting
only occurs if there are no other events waiting to be processed.
Default value: The Default radio button is selected.
visible Makes the window visible. In general, controls are constructed as
visible, and frame windows are constructed as invisible.
Default value: The default is on, and the Default radio button is selected.
ΓòÉΓòÉΓòÉ <hidden> Handlers Settings - INotebook ΓòÉΓòÉΓòÉ
Handler name Sets the name of the default handler.
Default value: None
Handler list Sets the name of the handler for the MLE control.
Default value: None
Add after Adds the new choice after the selected choice in the list. If no
choice is selected, the new choice is added after the first choice in the
list.
Default value: Highlighted
Add before Adds the new choice before the selected choice in the list. If no
choice is selected, the new choice is added before the first choice in the
list.
Default value: Not highlighted
Move Determines whether a part and its descendants can be moved to a new
location.
Default value: Not highlighted
Remove Removes one item from the part and returns the count of the number of
items that remain.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ <hidden> Color Settings - INotebook ΓòÉΓòÉΓòÉ
Color area Sets the color of the given area. Choices are as follows:
Foreground
Sets the color for foreground text
Background
Sets the color for background text
Page background
Sets the color of the page background
Major tab background
Sets the color of the background for the major tab
Major tab foreground
Sets the color of the foreground for the major tab
Minor tab background
Sets the color of the background for the minor tab
Minor tab foreground
Sets the color of the foreground for the minor tab
Default value: Background is selected
Color selection Enables color selection by either color values or RGB values.
Select Colors or RGB. If you select Colors, you can set the Color values. If
you select RGB, you can set the RGB values.
Default value: RGB selected
Color values Sets the color value of the window area, or sets the passed
default if no color for the area has been set.
Default value: None
RGB values Sets the color values for the notebook.
Default value: Red=204, Green=204, Blue=204
ΓòÉΓòÉΓòÉ <hidden> Size/Position Settings - INotebook ΓòÉΓòÉΓòÉ
X field Sets the X coordinate of the part.
Default value: The x coordinate of the part currently positioned on the
free-form surface
Y field Sets the Y coordinate of the point.
Default value: The y coordinate of the part currently positioned on the
free-form surface
Width Sets the width of the text.
Default value: None
Height Sets the height of the text.
Default value: None
Minimum size Determines the minimum size of the part.
Select Calculate at execution time or Set value here. If you select
Calculate at execution time, the minimum size is determined dynamically. If
you select Set value here, you can set the Minimum size Width and Height
fields to define a fixed minimum size.
Default value: Calculate at execution time is selected
Width Sets the minimum-allowable width, which is set by the user's class.
Default value: None (calculated at execution time)
Height Sets the minimum-allowable height, which is set by the user's class.
Default value: None (calculated at execution time)
ΓòÉΓòÉΓòÉ <hidden> Font Settings - INotebook ΓòÉΓòÉΓòÉ
Name Sets the name of the font.
Default value: System proportional
Point size Sets the point size of the font.
Default value: 10
Style Sets the style for the part.
Default value: None
Emphasis Gives the part emphasis. If a part is specified, the emphasis is
drawn around the part.
Default value: None
Edit Opens an edit field on a part or setting.
Default value: Highlighted
Default font Sets the current default font style.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ 3.35. INumericSpinButton ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Events
Settings Pages
General
Control
Styles
Handlers
Color
Size/Position
Font
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - INumericSpinButton ΓòÉΓòÉΓòÉ
Title: IBM spin-button control with numeric contents
Class name: INumericSpinButton
Base part: IBaseSpinButton
Part type: Visual part
Part file: vbbase.vbb
An INumericSpinButton part is a ring of numeric choices. One choice is visible
at a time.
The user can spin the ring upward or downward to select another choice.
Use an INumericSpinButton part to provide, in sequence, a ring of related but
mutually exclusive numeric choices. For example, use a spin button for a
numeric selection list of the months of the year.
Alternatively, use an ITextSpinButton for a ring of text choices.
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - INumericSpinButton ΓòÉΓòÉΓòÉ
When building with an INumericSpinButton part, you can do the following:
Define the range of numbers for the spin button. Do this by setting the
Numeric range field on the INumericSpinButton General settings page.
Define a default selection for the spin button. Do this by setting the
Value field on the INumericSpinButton General settings page.
Align numeric values to the right in the spin button entry field. Do this
by selecting the Right setting in the Alignment field on the
INumericSpinButton General settings page.
Prevent the user from typing a choice. Do this by setting the Read only
field on the INumericSpinButton Styles settings page.
Make the spin button skip values to cycle faster when the user continues
to spin the button. Do this by setting the Fast spin field on the
INumericSpinButton Styles settings page.
Copy the selection from the spin button to a numeric connection parameter
or attribute. Do this by connecting the INumericSpinButton value
attribute to the numeric target.
ΓòÉΓòÉΓòÉ <hidden> Attributes - INumericSpinButton ΓòÉΓòÉΓòÉ
Attribute S E Data type
activeColor Γûá Γûá IColor
alignment Γûá Alignment
asDebugInfo IString
asString IString
autoDeleteObject Γûá Boolean
autoDestroyWindow Γûá Boolean
backgroundColor Γûá Γûá IColor
bidiSupported Boolean
border Boolean
borderColor Γûá Γûá IColor
characterSize ISize
defaultPushButton IWindowHandle
disabledBackgroundColor Γûá Γûá IColor
disabledForegroundColor Γûá Γûá IColor
enabled Γûá Γûá Boolean
enabledForNotification Γûá Boolean
fastSpinEnabled Γûá Boolean
focus Γûá Boolean
font Γûá Γûá IFont
foregroundColor Γûá Γûá IColor
frameWindow Boolean
group Γûá Boolean
handle IWindowHandle
hiliteBackgroundColor Γûá Γûá IColor
hiliteForegroundColor Γûá Γûá IColor
id Γûá unsigned long
inactiveColor Γûá Γûá IColor
itemProvider Γûá IDMItemProvider*
layoutAdjustment IRectangle
limit Γûá unsigned long
master Boolean
menu
messageQueue IMessageQueueHandle
minimumSize Γûá ISize
nativeRect IRectangle
owner Γûá IWindow*
parent Γûá IWindow*
parentSize ISize
pointerCaptured Boolean
position Γûá Γûá IPoint
presSpace IPresSpaceHandle
range Γûá IRange
rect Γûá IRectangle
servant Boolean
shadowColor Γûá Γûá IColor
showing Boolean
size Γûá Γûá ISize
spinFieldValid Boolean
tabStop Γûá Boolean
valid Boolean
value Γûá Γûá long
visible Γûá Γûá Boolean
visibleRectangle IRectangle
writeable Γûá Boolean
ΓòÉΓòÉΓòÉ <hidden> Actions - INumericSpinButton ΓòÉΓòÉΓòÉ
Action Parameters
addBorder Boolean
applyBidiSettings BidiSettings&, Boolean, Boolean
capturePointer Boolean
convertToGUIStyle IBitFlag&, Boolean
disable None
disableDataUpdate None
disableFastSpin None
disableGroup None
disableNotification None
disableTabStop None
disableUpdate None
dispatchRemainingHandlers IEvent&, Boolean
enable Boolean
enableUpdate Boolean
handleException IException&, IEvent&
hide None
hideSourceEmphasis None
isLayoutDistorted unsigned long
matchForMnemonic unsigned short
notifyObservers INotificationEvent&
positionBehindSibling IWindowHandle&
positionBehindSiblings None
positionOnSiblings None
postEvent unsigned long, IEventParameter1&,
IEventParameter2&
refresh IRectangle&
releasePointer None
releasePresSpace IPresSpaceHandle&
removeBorder None
resetActiveColor None
resetBackgroundColor None
resetBorderColor None
resetDisabledBackgroundColor None
resetDisabledForegroundColor None
resetFont None
resetForegroundColor None
resetHiliteBackgroundColor None
resetHiliteForegroundColor None
resetInactiveColor None
resetMinimumSize None
resetShadowColor None
sendEvent unsigned long, IEventParameter1&,
IEventParameter2&
setFocus None
setLayoutDistorted unsigned long, unsigned long
setMaster IBaseSpinButton&
show Boolean
showSourceEmphasis Boolean
spinDown unsigned long
spinTo long, Boolean
spinUp unsigned long
ΓòÉΓòÉΓòÉ <hidden> Events - INumericSpinButton ΓòÉΓòÉΓòÉ
Event Notification ID
commandEvent commandId
gotFocusEvent FOCUSTRUEID
inputDisabledEvent ENABLEFALSEID
inputEnabledEvent ENABLETRUEID
lostFocusEvent FOCUSFALSEID
systemCommandEvent systemCommandId
textEvent textId
valueEvent valueId
visibilityDisabledEvent VISIBLEFALSEID
visibilityEnabledEvent VISIBLETRUEID
ΓòÉΓòÉΓòÉ <hidden> General Settings - INumericSpinButton ΓòÉΓòÉΓòÉ
Subpart name Sets the name of the subpart (a part placed on a composite part).
Default value: The name of the part
Alignment Changes the text alignment of the part. Left aligns the text to the
left, Center centers the text, and Right aligns the text at the right.
Default value: Left
Numeric range Sets a range of values for an attribute of the part. The Lower
field sets the lower limit of the range for a spin button part, while the
Upper field sets the upper limit.
Default value: 0
Value Sets the current value for the spin button.
Default value: 0
Limit Sets the length (in bytes) of the longest text the part can hold.
Default value: 32
ΓòÉΓòÉΓòÉ <hidden> Control Settings - INumericSpinButton ΓòÉΓòÉΓòÉ
Fly over short text Specifies the short text for the fly-over text control.
Default value: None
Fly over long text Specifies the long text for the fly-over text control.
Default value: None
Window id Sets the window identifier.
Default value: None
Help panel id Sets the help panel identifier for the part.
Default value: None
Enabled Enables the handler by default.
Default value: Selected
ΓòÉΓòÉΓòÉ <hidden> Styles Settings - INumericSpinButton ΓòÉΓòÉΓòÉ
defaultStyle() Resets the part to the original default style.
Default value: Selected
padWithZeros Pads the displayed number with zeros at the front.
Default value: The Default radio button is selected.
readOnly Prevents entering input into the field.
Default value: The default is off, and the Default radio button is selected.
noBorder Suppresses the drawing of a border.
Default value: The Default radio button is selected.
fastSpin Enables the spin button to increase the spin speed with time. The
speed doubles every two seconds.
Default value: The Default radio button is selected.
master Specifies that the spin button component consists of:
One or more single-line entry fields (SLE) or spin fields
Two arrows-the Up arrow and the Down arrow
When a spin button contains more than one spin field, the master component
contains the spin arrows. If the component contains only one spin field, it
must be the master.
Default value: The default is on, and the Default radio button is selected.
servant Allows the user to create a multiple-field spin button by spinning
servants from the master.
Default value: The default is off, and the Default radio button is selected.
group Identifies the control as being the first in a group. No other controls
in the group can have this style. Controls in the group must be siblings
that are constructed following the first control. The group can be cursored
and when the last control in the group is reached, the cursor returns the
first control in the group.
Default value: The default is off, and the Default radio button is selected.
tabStop Identifies the control as one to which the user can tab.
Default value: The default is off, and the Default radio button is selected.
clipChildren Excludes the area occupied by the children of the window when
drawing in the window. Child windows are always "clipped" to their parent
window. When a parent window is painted, the clipChildren style controls
whether the invalidated region of the parent window includes the area
occupied by its children, thus preventing a window from painting over its
child windows.
Default value: The Default radio button is selected.
clipSiblings Controls which sibling window is displayed on top when multiple
siblings are displayed. Sibling windows are windows that share the same
parent window. Assign the clipSiblings style to the sibling window that you
want displayed on top of the other siblings, in Z-order.
Default value: The Default radio button is selected.
clipToParent Allows a window to paint outside of its window boundary up to the
window boundary of its parent.
Default value: The Default radio button is selected.
saveBits Optimizes the painting of a window by saving the screen image of the
area under the window as a bitmap and then using the bitmap to redraw the
window, when necessary.
Default value: The Default radio button is selected.
synchPaint Synchronously repaints the window. Without this style, painting
only occurs if there are no other events waiting to be processed.
Default value: The Default radio button is selected.
visible Makes the window visible. In general, controls are constructed as
visible, and frame windows are constructed as invisible.
Default value: The default is on, and the Default radio button is selected.
ΓòÉΓòÉΓòÉ <hidden> Handlers Settings - INumericSpinButton ΓòÉΓòÉΓòÉ
Handler name Sets the name of the default handler.
Default value: None
Handler list Sets the name of the handler for the MLE control.
Default value: None
Add after Adds the new choice after the selected choice in the list. If no
choice is selected, the new choice is added after the first choice in the
list.
Default value: Highlighted
Add before Adds the new choice before the selected choice in the list. If no
choice is selected, the new choice is added before the first choice in the
list.
Default value: Not highlighted
Move Determines whether a part and its descendants can be moved to a new
location.
Default value: Not highlighted
Remove Removes one item from the part and returns the count of the number of
items that remain.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ <hidden> Color Settings - INumericSpinButton ΓòÉΓòÉΓòÉ
Color area Sets the color of the given area. Choices are as follows:
Foreground
Sets the color for foreground text
Background
Sets the color for background text
Disabled foreground
Sets the foreground color for disabled text
Border
Sets the color of the border that surrounds the part.
Default value: Foreground is selected
Color selection Enables color selection by either color values or RGB values.
Select Colors or RGB. If you select Colors, you can set the Color values. If
you select RGB, you can set the RGB values.
Default value: RGB selected
Color values Sets the color value of the window area, or sets the passed
default if no color for the area has been set.
Default value: None
RGB values Sets the color values for the window area.
Default value: Not set
ΓòÉΓòÉΓòÉ <hidden> Size/Position Settings - INumericSpinButton ΓòÉΓòÉΓòÉ
X field Sets the X coordinate of the part.
Default value: The x coordinate of the part currently positioned on the
free-form surface
Y field Sets the Y coordinate of the point.
Default value: The y coordinate of the part currently positioned on the
free-form surface
Width Sets the width of the text.
Default value: None
Height Sets the height of the text.
Default value: None
Minimum size Determines the minimum size of the part.
Select Calculate at execution time or Set value here. If you select
Calculate at execution time, the minimum size is determined dynamically. If
you select Set value here, you can set the Minimum size Width and Height
fields to define a fixed minimum size.
Default value: Calculate at execution time is selected
Width Sets the minimum-allowable width, which is set by the user's class.
Default value: None (calculated at execution time)
Height Sets the minimum-allowable height, which is set by the user's class.
Default value: None (calculated at execution time)
ΓòÉΓòÉΓòÉ <hidden> Font Settings - INumericSpinButton ΓòÉΓòÉΓòÉ
Name Sets the name of the font.
Default value: System proportional
Point size Sets the point size of the font.
Default value: 10
Style Sets the style for the part.
Default value: None
Emphasis Gives the part emphasis. If a part is specified, the emphasis is
drawn around the part.
Default value: None
Edit Opens an edit field on a part or setting.
Default value: Highlighted
Default font Sets the current default font style.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ 3.36. IOutlineBox ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Events
Settings Pages
General
Control
Styles
Handlers
Color
Size/Position
Font
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IOutlineBox ΓòÉΓòÉΓòÉ
Title: IBM outline control without text label
Class name: IOutlineBox
Base part: IControl
Part type: Visual part
Part file: vbbase.vbb
An IOutlineBox part is an unlabeled rectangular box that can contain a group
of related user-interface controls.
The user can move through the controls in a group using the keyboard cursor
keys. When the user moves the cursor forward from the last control in the
group, the cursor returns to the first control in the group.
Use an IOutlineBox part to visually group a set of controls without labeling
the group. Alternatively, use an IGroupBox part if you want to label the
group.
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - IOutlineBox ΓòÉΓòÉΓòÉ
When building with an IOutlineBox part, you can do the following:
Define a set of related controls in a group box. Do this as follows:
1. Select an IOutlineBox part from the parts palette and drop it on a
canvas.
2. Resize the outline box to the size you think you need by selecting
it on the canvas and dragging a corner handle.
3. Add the controls you want in the outline box. If you add the outline
box after adding the controls you are enclosing, you must change the
tabbing and depth order of controls on the canvas to position the outline
box ahead of the controls within it. Do this by clicking mouse button 2
on the canvas and selecting the Tabbing And Depth Order choice. Then,
press mouse button 2 on the outline box in the Tabbing And Depth Order
panel and drag it to a new position just before the first control it
contains.
Make the controls in the outline box a cursoring group that the user can
reach with a tab key. The user can cycle through controls in a cursoring
group using the keyboard cursor keys.
Do this by setting the group and tabStop fields to On on the Styles
settings page of the first control in the outline box. Leave these fields
set to Off for the rest of the controls in the outline box.
Also make sure that the first control following the outline box on your
canvas has the group field set to On. This makes the last control in the
outline box the end of the cursoring group. You can view and modify the
group and tabStop settings of controls in the Tabbing And Depth Order
panel.
ΓòÉΓòÉΓòÉ <hidden> Attributes - IOutlineBox ΓòÉΓòÉΓòÉ
Attribute S E Data type
activeColor Γûá Γûá IColor
asDebugInfo IString
asString IString
autoDeleteObject Γûá Boolean
autoDestroyWindow Γûá Boolean
backgroundColor Γûá Γûá IColor
bidiSupported Boolean
borderColor Γûá Γûá IColor
characterSize ISize
defaultPushButton IWindowHandle
disabledBackgroundColor Γûá Γûá IColor
disabledForegroundColor Γûá Γûá IColor
enabled Γûá Γûá Boolean
enabledForNotification Γûá Boolean
focus Γûá Boolean
font Γûá Γûá IFont
foregroundColor Γûá Γûá IColor
frameWindow Boolean
group Γûá Boolean
handle IWindowHandle
hiliteBackgroundColor Γûá Γûá IColor
hiliteForegroundColor Γûá Γûá IColor
id Γûá unsigned long
inactiveColor Γûá Γûá IColor
itemProvider Γûá IDMItemProvider*
layoutAdjustment IRectangle
menu
messageQueue IMessageQueueHandle
minimumSize Γûá ISize
nativeRect IRectangle
outlineType Γûá OutlineType
owner Γûá IWindow*
parent Γûá IWindow*
parentSize ISize
pointerCaptured Boolean
position Γûá Γûá IPoint
presSpace IPresSpaceHandle
rect Γûá IRectangle
shadowColor Γûá Γûá IColor
showing Boolean
size Γûá Γûá ISize
tabStop Γûá Boolean
valid Boolean
visible Γûá Γûá Boolean
visibleRectangle IRectangle
ΓòÉΓòÉΓòÉ <hidden> Actions - IOutlineBox ΓòÉΓòÉΓòÉ
Action Parameters
applyBidiSettings BidiSettings&, Boolean, Boolean
capturePointer Boolean
convertToGUIStyle IBitFlag&, Boolean
disable None
disableGroup None
disableNotification None
disableTabStop None
disableUpdate None
dispatchRemainingHandlers IEvent&, Boolean
enable Boolean
enableUpdate Boolean
handleException IException&, IEvent&
hide None
hideSourceEmphasis None
isLayoutDistorted unsigned long
matchForMnemonic unsigned short
notifyObservers INotificationEvent&
positionBehindSibling IWindowHandle&
positionBehindSiblings None
positionOnSiblings None
postEvent unsigned long, IEventParameter1&,
IEventParameter2&
refresh IRectangle&
releasePointer None
releasePresSpace IPresSpaceHandle&
resetActiveColor None
resetBackgroundColor None
resetBorderColor None
resetDisabledBackgroundColor None
resetDisabledForegroundColor None
resetFont None
resetForegroundColor None
resetHiliteBackgroundColor None
resetHiliteForegroundColor None
resetInactiveColor None
resetMinimumSize None
resetShadowColor None
sendEvent unsigned long, IEventParameter1&,
IEventParameter2&
setFocus None
setLayoutDistorted unsigned long, unsigned long
show Boolean
showSourceEmphasis Boolean
ΓòÉΓòÉΓòÉ <hidden> Events - IOutlineBox ΓòÉΓòÉΓòÉ
Event Notification ID
commandEvent commandId
gotFocusEvent FOCUSTRUEID
inputDisabledEvent ENABLEFALSEID
inputEnabledEvent ENABLETRUEID
lostFocusEvent FOCUSFALSEID
systemCommandEvent systemCommandId
visibilityDisabledEvent VISIBLEFALSEID
visibilityEnabledEvent VISIBLETRUEID
ΓòÉΓòÉΓòÉ <hidden> General Settings - IOutlineBox ΓòÉΓòÉΓòÉ
Subpart name Sets the name of the subpart (a part placed on a composite part).
Default value: The name of the part
ΓòÉΓòÉΓòÉ <hidden> Control Settings - IOutlineBox ΓòÉΓòÉΓòÉ
Fly over short text Specifies the short text for the fly-over text control.
Default value: None
Fly over long text Specifies the long text for the fly-over text control.
Default value: None
Window id Sets the window identifier.
Default value: None
Help panel id Sets the help panel identifier for the part.
Default value: None
Enabled Enables the handler by default.
Default value: Selected
ΓòÉΓòÉΓòÉ <hidden> Styles Settings - IOutlineBox ΓòÉΓòÉΓòÉ
defaultStyle() Resets the part to the original default style.
Default value: Selected
clipChildren Excludes the area occupied by the children of the window when
drawing in the window. Child windows are always "clipped" to their parent
window. When a parent window is painted, the clipChildren style controls
whether the invalidated region of the parent window includes the area
occupied by its children, thus preventing a window from painting over its
child windows.
Default value: The Default radio button is selected.
clipSiblings Controls which sibling window is displayed on top when multiple
siblings are displayed. Sibling windows are windows that share the same
parent window. Assign the clipSiblings style to the sibling window that you
want displayed on top of the other siblings, in Z-order.
Default value: The Default radio button is selected.
clipToParent Allows a window to paint outside of its window boundary up to the
window boundary of its parent.
Default value: The Default radio button is selected.
saveBits Optimizes the painting of a window by saving the screen image of the
area under the window as a bitmap and then using the bitmap to redraw the
window, when necessary.
Default value: The Default radio button is selected.
synchPaint Synchronously repaints the window. Without this style, painting
only occurs if there are no other events waiting to be processed.
Default value: The Default radio button is selected.
visible Makes the window visible. In general, controls are constructed as
visible, and frame windows are constructed as invisible.
Default value: The default is on, and the Default radio button is selected.
ΓòÉΓòÉΓòÉ <hidden> Handlers Settings - IOutlineBox ΓòÉΓòÉΓòÉ
Handler name Sets the name of the default handler.
Default value: None
Handler list Sets the name of the handler for the MLE control.
Default value: None
Add after Adds the new choice after the selected choice in the list. If no
choice is selected, the new choice is added after the first choice in the
list.
Default value: Highlighted
Add before Adds the new choice before the selected choice in the list. If no
choice is selected, the new choice is added before the first choice in the
list.
Default value: Not highlighted
Move Determines whether a part and its descendants can be moved to a new
location.
Default value: Not highlighted
Remove Removes one item from the part and returns the count of the number of
items that remain.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ <hidden> Color Settings - IOutlineBox ΓòÉΓòÉΓòÉ
Outline type Sets the type of outline.
Default value: Foreground color
Color area Sets the color of the given area. Choices are as follows:
Foreground
Sets the color for foreground text
Default value: Foreground is selected
Color selection Enables color selection by either color values or RGB values.
Select Colors or RGB. If you select Colors, you can set the Color values. If
you select RGB, you can set the RGB values.
Default value: RGB selected
Color values Sets the color value of the window area, or sets the passed
default if no color for the area has been set.
Default value: None
RGB values Sets the color values for the canvas.
Default value: Red=255, Green=255, Blue=255
ΓòÉΓòÉΓòÉ <hidden> Size/Position Settings - IOutlineBox ΓòÉΓòÉΓòÉ
X field Sets the X coordinate of the part.
Default value: The x coordinate of the part currently positioned on the
free-form surface
Y field Sets the Y coordinate of the point.
Default value: The y coordinate of the part currently positioned on the
free-form surface
Width Sets the width of the text.
Default value: None
Height Sets the height of the text.
Default value: None
Minimum size Determines the minimum size of the part.
Select Calculate at execution time or Set value here. If you select
Calculate at execution time, the minimum size is determined dynamically. If
you select Set value here, you can set the Minimum size Width and Height
fields to define a fixed minimum size.
Default value: Calculate at execution time is selected
Width Sets the minimum-allowable width, which is set by the user's class.
Default value: None (calculated at execution time)
Height Sets the minimum-allowable height, which is set by the user's class.
Default value: None (calculated at execution time)
ΓòÉΓòÉΓòÉ <hidden> Font Settings - IOutlineBox ΓòÉΓòÉΓòÉ
Name Sets the name of the font.
Default value: System proportional
Point size Sets the point size of the font.
Default value: 10
Style Sets the style for the part.
Default value: None
Emphasis Gives the part emphasis. If a part is specified, the emphasis is
drawn around the part.
Default value: None
Edit Opens an edit field on a part or setting.
Default value: Highlighted
Default font Sets the current default font style.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ 3.37. IProgressIndicator ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Events
Settings Pages
General
Control
Styles
Handlers
Color
Size/Position
Font
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IProgressIndicator ΓòÉΓòÉΓòÉ
Title: IBM read-only slider control
Class name: IProgressIndicator
Base part: IControl
Part type: Visual part
Part file: vbbase.vbb
An IProgressIndicator part shows the progress of a task. A horizontal or
vertical shaft represents the task.
An arm moves along the shaft to show the progress of the task. The arm starts
at one end of the shaft, called the home position, and reaches the other end
when the task finishes. The shaft can be colored between the home position and
the arm to emphasize the progress of the task. This colored portion of the
shaft is called a ribbon strip.
The user can note the progress of a task by observing the progress indicator.
If your application provides a push button with cancel support, the user can
end the task.
Use an IProgressIndicator part to provide a visual measure of the progress of
a task. Use a progress indicator for tasks of significant duration.
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - IProgressIndicator ΓòÉΓòÉΓòÉ
When building with an IProgressIndicator part, you can do the following:
Define the value scale for the progress indicator. Do this as follows:
- Enter the number of ticks in the Number of ticks field on the
IProgressIndicator General settings page.
- Select the location of the scale of tick marks and text relative to
the progress indicator. Do this by selecting a choice in the Primary
scale field on the IProgressIndicator General settings page. If you
want the scale above a horizontal progress indicator or to the right
of a vertical indicator, select the Scale 1 choice. If you want the
scale below a horizontal progress indicator or to the left of a
vertical indicator, select the Scale 2 choice.
- Add scale tick marks and text to the progress indicator. Do this
using custom logic. Click mouse button 2 on the free-form surface
and connect the composite part ready event to IProgressIndicator
Custom logic. Enter C++ code to set the size and text for each tick
mark.
For example, if you want to show percentage of completion with marks
at ten-percent intervals, you could enter the following code:
for (int i = 0; i < 101; i += 10)
{
target->setTickLength(i, 10);
target->setTickText(i, IString(i));
}
Add a ribbon strip to the progress indicator. Do this by setting the
Ribbon strip field to On on the IProgressIndicator Styles settings page.
Determine the orientation of the progress indicator. By default, the
orientation is horizontal. To orient the progress indicator vertically,
set the vertical field to On and the set the horizontal field to Off on
the IProgressIndicator Styles settings page.
Define the home position for the progress indicator. Do this by selecting
a choice in the Home position field on the IProgressIndicator General
settings page. If you want the home position at the left of a horizontal
progress indicator or at the bottom of a vertical indicator, select the
Left or bottom choice. If you want the home position at the right of a
horizontal progress indicator or at the top of a vertical indicator,
select the Top or right choice.
If you want the initial arm offset somewhere other than at the home
position, set the Arm offset field on the IProgressIndicator General
settings page. Specify either a tick offset for Ticks or a pixel offset
for Pixels.
Force the arm to the nearest tick if you use a pixel offset. Do this by
setting the snapToTickMark field to On on the IProgressIndicator Styles
settings page.
Advance the arm to indicate progress. Do this by connecting the source of
your progress information to the IProgressIndicator armTickOffset
attribute, providing the new tick location of the arm.
ΓòÉΓòÉΓòÉ <hidden> Attributes - IProgressIndicator ΓòÉΓòÉΓòÉ
Attribute S E Data type
activeColor Γûá Γûá IColor
alignment Alignment
armPixelOffset Γûá Γûá unsigned long
armRange unsigned long
armTickOffset Γûá Γûá unsigned long
asDebugInfo IString
asString IString
autoDeleteObject Γûá Boolean
autoDestroyWindow Γûá Boolean
backgroundColor Γûá Γûá IColor
bidiSupported Boolean
borderColor Γûá Γûá IColor
characterSize ISize
defaultPushButton IWindowHandle
disabledBackgroundColor Γûá Γûá IColor
disabledForegroundColor Γûá Γûá IColor
drawItemEnabled Γûá Boolean
enabled Γûá Γûá Boolean
enabledForNotification Γûá Boolean
focus Γûá Boolean
font Γûá Γûá IFont
foregroundColor Γûá Γûá IColor
frameWindow Boolean
group Γûá Boolean
handle IWindowHandle
hiliteBackgroundColor Γûá Γûá IColor
hiliteForegroundColor Γûá Γûá IColor
homePosition Γûá HomePosition
id Γûá unsigned long
inactiveColor Γûá Γûá IColor
itemProvider Γûá IDMItemProvider*
layoutAdjustment IRectangle
menu
messageQueue IMessageQueueHandle
minimumSize Γûá ISize
nativeRect IRectangle
owner Γûá IWindow*
parent Γûá IWindow*
parentSize ISize
pointerCaptured Boolean
position Γûá Γûá IPoint
presSpace IPresSpaceHandle
primaryScale Γûá Γûá Scale
rect Γûá IRectangle
ribbonStripEnabled Γûá Boolean
shadowColor Γûá Γûá IColor
shaftPosition Γûá IPoint
shaftSize ISize
showing Boolean
size Γûá Γûá ISize
snapToTickEnabled Γûá Boolean
tabStop Γûá Boolean
valid Boolean
vertical Boolean
visible Γûá Γûá Boolean
visibleRectangle IRectangle
ΓòÉΓòÉΓòÉ <hidden> Actions - IProgressIndicator ΓòÉΓòÉΓòÉ
Action Parameters
applyBidiSettings BidiSettings&, Boolean, Boolean
capturePointer Boolean
convertToGUIStyle IBitFlag&, Boolean
disable None
disableDrawItem None
disableGroup None
disableNotification None
disableRibbonStrip None
disableSnapToTick None
disableTabStop None
disableUpdate None
dispatchRemainingHandlers IEvent&, Boolean
enable Boolean
enableUpdate Boolean
handleException IException&, IEvent&
hide None
hideSourceEmphasis None
isLayoutDistorted unsigned long
matchForMnemonic unsigned short
notifyObservers INotificationEvent&
numberOfTicks Scale
positionBehindSibling IWindowHandle&
positionBehindSiblings None
positionOnSiblings None
postEvent unsigned long, IEventParameter1&,
IEventParameter2&
refresh IRectangle&
releasePointer None
releasePresSpace IPresSpaceHandle&
resetActiveColor None
resetBackgroundColor None
resetBorderColor None
resetDisabledBackgroundColor None
resetDisabledForegroundColor None
resetFont None
resetForegroundColor None
resetHiliteBackgroundColor None
resetHiliteForegroundColor None
resetInactiveColor None
resetMinimumSize None
resetShadowColor None
sendEvent unsigned long, IEventParameter1&,
IEventParameter2&
setFocus None
setLayoutDistorted unsigned long, unsigned long
setShaftBreadth unsigned long
setTickLength unsigned long, unsigned long
setTicks unsigned long, unsigned long, unsigned long,
unsigned long
setTickText unsigned long, char*
show Boolean
showSourceEmphasis Boolean
tickLength unsigned long
tickPosition unsigned long
tickSpacing Scale
tickText unsigned long
ΓòÉΓòÉΓòÉ <hidden> Events - IProgressIndicator ΓòÉΓòÉΓòÉ
Event Notification ID
commandEvent commandId
gotFocusEvent FOCUSTRUEID
inputDisabledEvent ENABLEFALSEID
inputEnabledEvent ENABLETRUEID
lostFocusEvent FOCUSFALSEID
scaleEvent scaleId
systemCommandEvent systemCommandId
visibilityDisabledEvent VISIBLEFALSEID
visibilityEnabledEvent VISIBLETRUEID
ΓòÉΓòÉΓòÉ <hidden> General Settings - IProgressIndicator ΓòÉΓòÉΓòÉ
Subpart name Sets the name of the subpart (a part placed on a composite part).
Default value: The name of the part
Number of ticks Sets the number of ticks.
Default value: 2
Tick spacing Sets the number of pixels between ticks for the specified scale.
Default value: None
Ticks Sets the position of the arm as a tick number. Ticks are numbered
starting at zero.
Default value: 0
Pixels Sets the offset of the arm from the home position.
Default value: 0
Home position Sets the home position of the progress indicator.
Default value: Left or bottom
Primary scale Sets the primary scale of the progress indicator.
Default value: Scale 1
ΓòÉΓòÉΓòÉ <hidden> Control Settings - IProgressIndicator ΓòÉΓòÉΓòÉ
Fly over short text Specifies the short text for the fly-over text control.
Default value: None
Fly over long text Specifies the long text for the fly-over text control.
Default value: None
Window id Sets the window identifier.
Default value: None
Help panel id Sets the help panel identifier for the part.
Default value: None
Enabled Enables the handler by default.
Default value: Selected
ΓòÉΓòÉΓòÉ <hidden> Styles Settings - IProgressIndicator ΓòÉΓòÉΓòÉ
defaultStyle() Resets the part to the original default style.
Default value: Selected
horizontal Creates a horizontal scroll bar. This style is ignored if it is
used with vertical.
A deck of child windows is arranged in the canvas horizontally in rows from
left to right. Decks of rows are arranged from top to bottom.
Default value: The default is off, and the Default radio button is selected.
snapToTickMark Specifies that the progress indicator arm snap to the nearest
tick when moved between two ticks.
Default value: The Default radio button is selected.
ribbonStrip Sets the default ribbonStrip style.
Default value: The Default radio button is selected.
handleDrawItem Generates a draw item event to allow the application to draw
the part.
Default value: The Default radio button is selected.
vertical Creates a vertical scroll bar. This style is used if both it and
horizontal are specified.
A deck of child windows is arranged in the canvas vertically in columns from
top to bottom. Decks of columns are arranged from left to right.
Default value: The default is on, and the Default radio button is selected.
group Identifies the control as being the first in a group. No other controls
in the group can have this style. Controls in the group must be siblings
that are constructed following the first control. The group can be cursored
and when the last control in the group is reached, the cursor returns the
first control in the group.
Default value: The default is off, and the Default radio button is selected.
tabStop Identifies the control as one to which the user can tab.
Default value: The default is off, and the Default radio button is selected.
clipChildren Excludes the area occupied by the children of the window when
drawing in the window. Child windows are always "clipped" to their parent
window. When a parent window is painted, the clipChildren style controls
whether the invalidated region of the parent window includes the area
occupied by its children, thus preventing a window from painting over its
child windows.
Default value: The Default radio button is selected.
clipSiblings Controls which sibling window is displayed on top when multiple
siblings are displayed. Sibling windows are windows that share the same
parent window. Assign the clipSiblings style to the sibling window that you
want displayed on top of the other siblings, in Z-order.
Default value: The Default radio button is selected.
clipToParent Allows a window to paint outside of its window boundary up to the
window boundary of its parent.
Default value: The Default radio button is selected.
saveBits Optimizes the painting of a window by saving the screen image of the
area under the window as a bitmap and then using the bitmap to redraw the
window, when necessary.
Default value: The Default radio button is selected.
synchPaint Synchronously repaints the window. Without this style, painting
only occurs if there are no other events waiting to be processed.
Default value: The Default radio button is selected.
visible Makes the window visible. In general, controls are constructed as
visible, and frame windows are constructed as invisible.
Default value: The default is on, and the Default radio button is selected.
ΓòÉΓòÉΓòÉ <hidden> Handlers Settings - IProgressIndicator ΓòÉΓòÉΓòÉ
Handler name Sets the name of the default handler.
Default value: None
Handler list Sets the name of the handler for the MLE control.
Default value: None
Add after Adds the new choice after the selected choice in the list. If no
choice is selected, the new choice is added after the first choice in the
list.
Default value: Highlighted
Add before Adds the new choice before the selected choice in the list. If no
choice is selected, the new choice is added before the first choice in the
list.
Default value: Not highlighted
Move Determines whether a part and its descendants can be moved to a new
location.
Default value: Not highlighted
Remove Removes one item from the part and returns the count of the number of
items that remain.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ <hidden> Color Settings - IProgressIndicator ΓòÉΓòÉΓòÉ
Color area Sets the color of the given area. Choices are as follows:
Foreground
Sets the color for foreground text
Background
Sets the color for background text
Border
Sets the color of the border drawn around the children of the
frame window.
Default value: Foreground is selected
Color selection Enables color selection by either color values or RGB values.
Select Colors or RGB. If you select Colors, you can set the Color values. If
you select RGB, you can set the RGB values.
Default value: RGB selected
Color values Sets the color value of the window area, or sets the passed
default if no color for the area has been set.
Default value: None
RGB values Sets the color values for the window area.
Default value: Not set
ΓòÉΓòÉΓòÉ <hidden> Size/Position Settings - IProgressIndicator ΓòÉΓòÉΓòÉ
X field Sets the X coordinate of the part.
Default value: The x coordinate of the part currently positioned on the
free-form surface
Y field Sets the Y coordinate of the point.
Default value: The y coordinate of the part currently positioned on the
free-form surface
Width Sets the width of the text.
Default value: None
Height Sets the height of the text.
Default value: None
Minimum size Determines the minimum size of the part.
Select Calculate at execution time or Set value here. If you select
Calculate at execution time, the minimum size is determined dynamically. If
you select Set value here, you can set the Minimum size Width and Height
fields to define a fixed minimum size.
Default value: Calculate at execution time is selected
Width Sets the minimum-allowable width, which is set by the user's class.
Default value: None (calculated at execution time)
Height Sets the minimum-allowable height, which is set by the user's class.
Default value: None (calculated at execution time)
ΓòÉΓòÉΓòÉ <hidden> Font Settings - IProgressIndicator ΓòÉΓòÉΓòÉ
Name Sets the name of the font.
Default value: System proportional
Point size Sets the point size of the font.
Default value: 10
Style Sets the style for the part.
Default value: None
Emphasis Gives the part emphasis. If a part is specified, the emphasis is
drawn around the part.
Default value: None
Edit Opens an edit field on a part or setting.
Default value: Highlighted
Default font Sets the current default font style.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ 3.38. IPushButton ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Events
Settings Pages
General
Control
Styles
Handlers
Color
Size/Position
Font
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IPushButton ΓòÉΓòÉΓòÉ
Title: IBM push-button control
Class name: IPushButton
Base part: IButton
Part type: Visual part
Part file: vbbase.vbb
An IPushButton part is a selection button for an action or routing choice. The
choice is identified by text on the push button.
The user can click the push button to perform the indicated function.
Use an IPushButton part to let the user confirm changes or request a function.
OK and Help push buttons are commonly used examples.
Alternatively, to identify the choice with a graphic image, use an
IGraphicPushButton part.
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - IPushButton ΓòÉΓòÉΓòÉ
When building with an IPushButton part, you can do the following:
Assign text to the push button. Do this by setting the Text field on the
IPushButton General settings page.
Make the push button be the initial default button. Do this by setting
the defaultButton field on the IPushButton Styles settings page.
Allow the user to reach the button by using a tab key. Do this by setting
the tabStop field to On on the IPushButton Styles settings page.
If the button is the first control in a group, allow the user to use
cursor keys to move between the button and follow controls in the group.
Do this by setting the group field to On on the IPushButton Styles
settings page.
Start the action represented by the button. Do this by connecting the
IPushButton buttonClickEvent feature to the action on the target part.
Open your application help with the push button. Do this by selecting the
Help and noPointerFocus fields on the IPushButton Styles settings page.
Enable or disable the push button when an event occurs.
Enable the button as follows:
1. Connect the event to the IPushButton enable action.
2. Open settings for the connection, press the Set parameters push
button, and check the enabled setting.
Disable the button by connecting the event to the IPushButton disable
action.
ΓòÉΓòÉΓòÉ <hidden> Attributes - IPushButton ΓòÉΓòÉΓòÉ
Attribute S E Data type
activeColor Γûá Γûá IColor
allowsMouseClickFocus Γûá Boolean
asDebugInfo IString
asString IString
autoDeleteObject Γûá Boolean
autoDestroyWindow Γûá Boolean
backgroundColor Γûá Γûá IColor
bidiSupported Boolean
border Γûá Boolean
borderColor Γûá Γûá IColor
characterSize ISize
clipboardHasTextFormat Boolean
default Γûá Boolean
defaultPushButton IWindowHandle
disabledBackgroundColor Γûá Γûá IColor
disabledForegroundColor Γûá Γûá IColor
displaySize ISize
enabled Γûá Γûá Boolean
enabledForNotification Γûá Boolean
focus Γûá Boolean
font Γûá Γûá IFont
foregroundColor Γûá Γûá IColor
frameWindow Boolean
group Γûá Boolean
handle IWindowHandle
help Γûá Boolean
highlighted Boolean
hiliteBackgroundColor Γûá Γûá IColor
hiliteForegroundColor Γûá Γûá IColor
id Γûá unsigned long
inactiveColor Γûá Γûá IColor
isDigits Γûá
itemProvider Γûá IDMItemProvider*
layoutAdjustment IRectangle
menu
messageQueue IMessageQueueHandle
minimumSize Γûá ISize
nativeRect IRectangle
owner Γûá IWindow*
parent Γûá IWindow*
parentSize ISize
pointerCaptured Boolean
position Γûá Γûá IPoint
presSpace IPresSpaceHandle
rect Γûá IRectangle
shadowColor Γûá Γûá IColor
showing Boolean
size Γûá Γûá ISize
systemCommand Γûá Γûá Boolean
tabStop Γûá Boolean
text Γûá Γûá IString
textLength Γûá unsigned long
valid Boolean
valueAsDouble Γûá Γûá
valueAsInt Γûá Γûá
valueAsUnsigned Γûá Γûá
visible Γûá Γûá Boolean
visibleRectangle IRectangle
ΓòÉΓòÉΓòÉ <hidden> Actions - IPushButton ΓòÉΓòÉΓòÉ
Action Parameters
applyBidiSettings BidiSettings&, Boolean, Boolean
capturePointer Boolean
click None
convertToGUIStyle IBitFlag&, Boolean
disable None
disableDefault None
disableGroup None
disableHelp None
disableMouseClickFocus None
disableNotification None
disableSystemCommand None
disableTabStop None
disableUpdate None
dispatchRemainingHandlers IEvent&, Boolean
enable Boolean
enableUpdate Boolean
handleException IException&, IEvent&
hide None
hideSourceEmphasis None
highlight Boolean
isLayoutDistorted unsigned long
matchForMnemonic unsigned short
notifyObservers INotificationEvent&
positionBehindSibling IWindowHandle&
positionBehindSiblings None
positionOnSiblings None
postEvent unsigned long, IEventParameter1&,
IEventParameter2&
refresh IRectangle&
releasePointer None
releasePresSpace IPresSpaceHandle&
removeBorder None
resetActiveColor None
resetBackgroundColor None
resetBorderColor None
resetDisabledBackgroundColor None
resetDisabledForegroundColor None
resetFont None
resetForegroundColor None
resetHiliteBackgroundColor None
resetHiliteForegroundColor None
resetInactiveColor None
resetMinimumSize None
resetShadowColor None
sendEvent unsigned long, IEventParameter1&,
IEventParameter2&
setFocus None
setLayoutDistorted unsigned long, unsigned long
show Boolean
showSourceEmphasis Boolean
unhighlight None
ΓòÉΓòÉΓòÉ <hidden> Events - IPushButton ΓòÉΓòÉΓòÉ
Event Notification ID
buttonClickEvent buttonClickId
commandEvent commandId
gotFocusEvent FOCUSTRUEID
inputDisabledEvent ENABLEFALSEID
inputEnabledEvent ENABLETRUEID
lostFocusEvent FOCUSFALSEID
systemCommandEvent systemCommandId
visibilityDisabledEvent VISIBLEFALSEID
visibilityEnabledEvent VISIBLETRUEID
ΓòÉΓòÉΓòÉ <hidden> General Settings - IPushButton ΓòÉΓòÉΓòÉ
Subpart name Sets the name of the subpart (a part placed on a composite part).
Default value: The name of the part
Text Sets the text for the part.
Default value: The name of the part
ΓòÉΓòÉΓòÉ <hidden> Control Settings - IPushButton ΓòÉΓòÉΓòÉ
Fly over short text Specifies the short text for the fly-over text control.
Default value: None
Fly over long text Specifies the long text for the fly-over text control.
Default value: None
Window id Sets the window identifier.
Default value: None
Help panel id Sets the help panel identifier for the part.
Default value: None
Enabled Enables the handler by default.
Default value: Selected
ΓòÉΓòÉΓòÉ <hidden> Styles Settings - IPushButton ΓòÉΓòÉΓòÉ
defaultStyle() Resets the part to the original default style.
Default value: Selected
noBorder Suppresses the drawing of a border.
Default value: The Default radio button is selected.
defaultButton Specifies this push button as the default push button.
Default value: The default is on, and the Default radio button is selected.
Help Enables help for the part.
Default value: Not selected
systemCommand Generates a system command event when the user selects the part.
Default value: The default is off, and the Default radio button is selected.
noPointerFocus Allows the cursor stay on a control for which information is
required, rather than moving to the button. Buttons with this style do not
set the focus to themselves when the user clicks on them using the mouse.
This has no effect on keyboard interaction.
Default value: The Default radio button is selected.
group Identifies the control as being the first in a group. No other controls
in the group can have this style. Controls in the group must be siblings
that are constructed following the first control. The group can be cursored
and when the last control in the group is reached, the cursor returns the
first control in the group.
Default value: The default is off, and the Default radio button is selected.
tabStop Identifies the control as one to which the user can tab.
Default value: The default is off, and the Default radio button is selected.
clipChildren Excludes the area occupied by the children of the window when
drawing in the window. Child windows are always "clipped" to their parent
window. When a parent window is painted, the clipChildren style controls
whether the invalidated region of the parent window includes the area
occupied by its children, thus preventing a window from painting over its
child windows.
Default value: The Default radio button is selected.
clipSiblings Controls which sibling window is displayed on top when multiple
siblings are displayed. Sibling windows are windows that share the same
parent window. Assign the clipSiblings style to the sibling window that you
want displayed on top of the other siblings, in Z-order.
Default value: The Default radio button is selected.
clipToParent Allows a window to paint outside of its window boundary up to the
window boundary of its parent.
Default value: The Default radio button is selected.
saveBits Optimizes the painting of a window by saving the screen image of the
area under the window as a bitmap and then using the bitmap to redraw the
window, when necessary.
Default value: The Default radio button is selected.
synchPaint Synchronously repaints the window. Without this style, painting
only occurs if there are no other events waiting to be processed.
Default value: The Default radio button is selected.
visible Makes the window visible. In general, controls are constructed as
visible, and frame windows are constructed as invisible.
Default value: The default is on, and the Default radio button is selected.
ΓòÉΓòÉΓòÉ <hidden> Handlers Settings - IPushButton ΓòÉΓòÉΓòÉ
Handler name Sets the name of the default handler.
Default value: None
Handler list Sets the name of the handler for the MLE control.
Default value: None
Add after Adds the new choice after the selected choice in the list. If no
choice is selected, the new choice is added after the first choice in the
list.
Default value: Highlighted
Add before Adds the new choice before the selected choice in the list. If no
choice is selected, the new choice is added before the first choice in the
list.
Default value: Not highlighted
Move Determines whether a part and its descendants can be moved to a new
location.
Default value: Not highlighted
Remove Removes one item from the part and returns the count of the number of
items that remain.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ <hidden> Color Settings - IPushButton ΓòÉΓòÉΓòÉ
Color area Sets the color of the given area. Choices are as follows:
Foreground
Sets the color for foreground text
Background
Sets the color for background text
Disabled foreground
Sets the foreground color for disabled text
Highlighted foreground
Sets the foreground color for selected text
Border
Sets the color of the border that surrounds the part.
Default value: Foreground is selected
Color selection Enables color selection by either color values or RGB values.
Select Colors or RGB. If you select Colors, you can set the Color values. If
you select RGB, you can set the RGB values.
Default value: RGB selected
Color values Sets the color value of the window area, or sets the passed
default if no color for the area has been set.
Default value: None
RGB values Sets the color values for the window area.
Default value: Not set
ΓòÉΓòÉΓòÉ <hidden> Size/Position Settings - IPushButton ΓòÉΓòÉΓòÉ
X field Sets the X coordinate of the part.
Default value: The x coordinate of the part currently positioned on the
free-form surface
Y field Sets the Y coordinate of the point.
Default value: The y coordinate of the part currently positioned on the
free-form surface
Width Sets the width of the text.
Default value: None
Height Sets the height of the text.
Default value: None
Minimum size Determines the minimum size of the part.
Select Calculate at execution time or Set value here. If you select
Calculate at execution time, the minimum size is determined dynamically. If
you select Set value here, you can set the Minimum size Width and Height
fields to define a fixed minimum size.
Default value: Calculate at execution time is selected
Width Sets the minimum-allowable width, which is set by the user's class.
Default value: None (calculated at execution time)
Height Sets the minimum-allowable height, which is set by the user's class.
Default value: None (calculated at execution time)
ΓòÉΓòÉΓòÉ <hidden> Font Settings - IPushButton ΓòÉΓòÉΓòÉ
Name Sets the name of the font.
Default value: System proportional
Point size Sets the point size of the font.
Default value: 10
Style Sets the style for the part.
Default value: None
Emphasis Gives the part emphasis. If a part is specified, the emphasis is
drawn around the part.
Default value: None
Edit Opens an edit field on a part or setting.
Default value: Highlighted
Default font Sets the current default font style.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ 3.39. IRadioButton ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Events
Settings Pages
General
Control
Styles
Handlers
Color
Size/Position
Font
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IRadioButton ΓòÉΓòÉΓòÉ
Title: IBM radio-button control
Class name: IRadioButton
Base part: ISettingButton
Part type: Visual part
Part file: vbbase.vbb
An IRadioButton part is a circle with text that represents a settings choice.
Selection of the choice is indicated by a mark in the radio button.
The user can select a single choice from a set of radio buttons. When the user
selects a choice, the previously selected choice is no longer selected.
Use an IRadioButton part to provide a choice for a set of mutually exclusive
choices, where one choice is always selected.
Use radio buttons in a group for a small, fixed set of choices. For example,
use a set of radio buttons for a choice of sizes, such as small, medium, and
large. You can also use a set of radio buttons for a set of answers to a
multiple-choice question.
Alternatively, use a group of ICheckBox parts for a set of choices that are
not mutually exclusive.
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - IRadioButton ΓòÉΓòÉΓòÉ
When building with an IRadioButton part, you can do the following:
Set the text for the radio button. Do this by entering the text you want
in the Text field on the IRadioButton General settings page.
Set the initial state of the radio button. Do this by selecting or
deselecting the Selected field on the IRadioButton General settings page.
To initially select your radio button, make sure the Selected field check
box is checked. If it is not checked, click on it with mouse button 1 to
select it.
To initially not select your check box, make sure the Selected field
check box is not checked. If it is checked, click on it with mouse
button1 to deselect it.
Allow the user to reach the radio button by using a tab key. Do this by
setting the tabStop field to On on the IRadioButton Styles settings page.
If the button is the first control in a group, allow the user to use
cursor keys to move between the button and follow controls in the group.
Do this by setting the group field to On on the IRadioButton Styles
settings page.
Placing radio buttons in a group also ensures that when the user selects
one radio button, the other buttons are deselected.
Enable or disable another control when the user selects the radio button.
Enable the other control by connecting the IRadioButton selected
attribute to the enabled attribute of the other control. When the user
deselects the radio button, the other control is disabled.
Disable the other control by connecting the IRadioButton selected
attribute to the value attribute of an IVBBooleanPart and then connecting
the IVBBooleanPart notValue attribute to the enabled attribute of the
other control. When the user deselects the radio button, the other
control is enabled.
IVBBooleanPart is available in the vbsample.vbb file.
Enable or disable the radio button when an event occurs.
Enable the radio button as follows:
1. Connect the event to the IRadioButton enable action.
2. The button is enabled by default. If you have changed this default,
open settings for the connection, press the Set parameters push
button, and check the Enabled setting.
Disable the radio button by connecting the event to the IRadioButton
disable action.
ΓòÉΓòÉΓòÉ <hidden> Attributes - IRadioButton ΓòÉΓòÉΓòÉ
Attribute S E Data type
activeColor Γûá Γûá IColor
allowsMouseClickFocus Γûá Boolean
asDebugInfo IString
asString IString
autoDeleteObject Γûá Boolean
autoDestroyWindow Γûá Boolean
autoSelect Γûá Boolean
backgroundColor Γûá Γûá IColor
bidiSupported Boolean
borderColor Γûá Γûá IColor
characterSize ISize
clipboardHasTextFormat Boolean
cursorSelect Γûá Boolean
defaultPushButton IWindowHandle
disabledBackgroundColor Γûá Γûá IColor
disabledForegroundColor Γûá Γûá IColor
displaySize ISize
enabled Γûá Γûá Boolean
enabledForNotification Γûá Boolean
focus Γûá Boolean
font Γûá Γûá IFont
foregroundColor Γûá Γûá IColor
frameWindow Boolean
group Γûá Boolean
handle IWindowHandle
highlighted Boolean
hiliteBackgroundColor Γûá Γûá IColor
hiliteForegroundColor Γûá Γûá IColor
id Γûá unsigned long
inactiveColor Γûá Γûá IColor
isDigits Γûá
itemProvider Γûá IDMItemProvider*
layoutAdjustment IRectangle
menu
messageQueue IMessageQueueHandle
minimumSize Γûá ISize
nativeRect IRectangle
owner Γûá IWindow*
parent Γûá IWindow*
parentSize ISize
pointerCaptured Boolean
position Γûá Γûá IPoint
presSpace IPresSpaceHandle
rect Γûá IRectangle
selected Γûá Boolean
selectedIndex unsigned long
shadowColor Γûá Γûá IColor
showing Boolean
size Γûá Γûá ISize
tabStop Γûá Boolean
text Γûá Γûá IString
textLength Γûá unsigned long
valid Boolean
valueAsDouble Γûá Γûá
valueAsInt Γûá Γûá
valueAsUnsigned Γûá Γûá
visible Γûá Γûá Boolean
visibleRectangle IRectangle
ΓòÉΓòÉΓòÉ <hidden> Actions - IRadioButton ΓòÉΓòÉΓòÉ
Action Parameters
applyBidiSettings BidiSettings&, Boolean, Boolean
capturePointer Boolean
click None
convertToGUIStyle IBitFlag&, Boolean
deselect None
disable None
disableAutoSelect None
disableCursorSelect None
disableGroup None
disableMouseClickFocus None
disableNotification None
disableTabStop None
disableUpdate None
dispatchRemainingHandlers IEvent&, Boolean
enable Boolean
enableUpdate Boolean
handleException IException&, IEvent&
hide None
hideSourceEmphasis None
highlight Boolean
isLayoutDistorted unsigned long
matchForMnemonic unsigned short
notifyObservers INotificationEvent&
positionBehindSibling IWindowHandle&
positionBehindSiblings None
positionOnSiblings None
postEvent unsigned long, IEventParameter1&,
IEventParameter2&
refresh IRectangle&
releasePointer None
releasePresSpace IPresSpaceHandle&
resetActiveColor None
resetBackgroundColor None
resetBorderColor None
resetDisabledBackgroundColor None
resetDisabledForegroundColor None
resetFont None
resetForegroundColor None
resetHiliteBackgroundColor None
resetHiliteForegroundColor None
resetInactiveColor None
resetMinimumSize None
resetShadowColor None
sendEvent unsigned long, IEventParameter1&,
IEventParameter2&
setFocus None
setLayoutDistorted unsigned long, unsigned long
show Boolean
showSourceEmphasis Boolean
unhighlight None
ΓòÉΓòÉΓòÉ <hidden> Events - IRadioButton ΓòÉΓòÉΓòÉ
Event Notification ID
buttonClickEvent buttonClickId
commandEvent commandId
gotFocusEvent FOCUSTRUEID
inputDisabledEvent ENABLEFALSEID
inputEnabledEvent ENABLETRUEID
lostFocusEvent FOCUSFALSEID
systemCommandEvent systemCommandId
visibilityDisabledEvent VISIBLEFALSEID
visibilityEnabledEvent VISIBLETRUEID
ΓòÉΓòÉΓòÉ <hidden> General Settings - IRadioButton ΓòÉΓòÉΓòÉ
Subpart name Sets the name of the subpart (a part placed on a composite part).
Default value: The name of the part
Text Sets the text for the part.
Default value: The name of the part
Selected Sets the selection state of the item to selected.
Default value: Not selected
ΓòÉΓòÉΓòÉ <hidden> Control Settings - IRadioButton ΓòÉΓòÉΓòÉ
Fly over short text Specifies the short text for the fly-over text control.
Default value: None
Fly over long text Specifies the long text for the fly-over text control.
Default value: None
Window id Sets the window identifier.
Default value: None
Help panel id Sets the help panel identifier for the part.
Default value: None
Enabled Enables the handler by default.
Default value: Selected
ΓòÉΓòÉΓòÉ <hidden> Styles Settings - IRadioButton ΓòÉΓòÉΓòÉ
defaultStyle() Resets the part to the original default style.
Default value: Selected
noCursorSelect Enables selection of the part when the user uses the cursor.
Default value: The Default radio button is selected.
autoSelect Lets the user change the current selection by moving the cursor.
Default value: The default is on, and the Default radio button is selected.
noPointerFocus Allows the cursor stay on a control for which information is
required, rather than moving to the button. Buttons with this style do not
set the focus to themselves when the user clicks on them using the mouse.
This has no effect on keyboard interaction.
Default value: The Default radio button is selected.
group Identifies the control as being the first in a group. No other controls
in the group can have this style. Controls in the group must be siblings
that are constructed following the first control. The group can be cursored
and when the last control in the group is reached, the cursor returns the
first control in the group.
Default value: The default is off, and the Default radio button is selected.
tabStop Identifies the control as one to which the user can tab.
Default value: The default is off, and the Default radio button is selected.
clipChildren Excludes the area occupied by the children of the window when
drawing in the window. Child windows are always "clipped" to their parent
window. When a parent window is painted, the clipChildren style controls
whether the invalidated region of the parent window includes the area
occupied by its children, thus preventing a window from painting over its
child windows.
Default value: The Default radio button is selected.
clipSiblings Controls which sibling window is displayed on top when multiple
siblings are displayed. Sibling windows are windows that share the same
parent window. Assign the clipSiblings style to the sibling window that you
want displayed on top of the other siblings, in Z-order.
Default value: The Default radio button is selected.
clipToParent Allows a window to paint outside of its window boundary up to the
window boundary of its parent.
Default value: The Default radio button is selected.
saveBits Optimizes the painting of a window by saving the screen image of the
area under the window as a bitmap and then using the bitmap to redraw the
window, when necessary.
Default value: The Default radio button is selected.
synchPaint Synchronously repaints the window. Without this style, painting
only occurs if there are no other events waiting to be processed.
Default value: The Default radio button is selected.
visible Makes the window visible. In general, controls are constructed as
visible, and frame windows are constructed as invisible.
Default value: The default is on, and the Default radio button is selected.
ΓòÉΓòÉΓòÉ <hidden> Handlers Settings - IRadioButton ΓòÉΓòÉΓòÉ
Handler name Sets the name of the default handler.
Default value: None
Handler list Sets the name of the handler for the MLE control.
Default value: None
Add after Adds the new choice after the selected choice in the list. If no
choice is selected, the new choice is added after the first choice in the
list.
Default value: Highlighted
Add before Adds the new choice before the selected choice in the list. If no
choice is selected, the new choice is added before the first choice in the
list.
Default value: Not highlighted
Move Determines whether a part and its descendants can be moved to a new
location.
Default value: Not highlighted
Remove Removes one item from the part and returns the count of the number of
items that remain.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ <hidden> Color Settings - IRadioButton ΓòÉΓòÉΓòÉ
Color area Sets the color of the given area. Choices are as follows:
Foreground
Sets the color for foreground text
Background
Sets the color for background text
Disabled foreground
Sets the foreground color for disabled text
Highlighted foreground
Sets the foreground color for selected text
Border
Sets the color of the border that surrounds the part.
Default value: Foreground is selected
Color selection Enables color selection by either color values or RGB values.
Select Colors or RGB. If you select Colors, you can set the Color values. If
you select RGB, you can set the RGB values.
Default value: RGB selected
Color values Sets the color value of the window area, or sets the passed
default if no color for the area has been set.
Default value: None
RGB values Sets the color values for the window area.
Default value: Not set
ΓòÉΓòÉΓòÉ <hidden> Size/Position Settings - IRadioButton ΓòÉΓòÉΓòÉ
X field Sets the X coordinate of the part.
Default value: The x coordinate of the part currently positioned on the
free-form surface
Y field Sets the Y coordinate of the point.
Default value: The y coordinate of the part currently positioned on the
free-form surface
Width Sets the width of the text.
Default value: None
Height Sets the height of the text.
Default value: None
Minimum size Determines the minimum size of the part.
Select Calculate at execution time or Set value here. If you select
Calculate at execution time, the minimum size is determined dynamically. If
you select Set value here, you can set the Minimum size Width and Height
fields to define a fixed minimum size.
Default value: Calculate at execution time is selected
Width Sets the minimum-allowable width, which is set by the user's class.
Default value: None (calculated at execution time)
Height Sets the minimum-allowable height, which is set by the user's class.
Default value: None (calculated at execution time)
ΓòÉΓòÉΓòÉ <hidden> Font Settings - IRadioButton ΓòÉΓòÉΓòÉ
Name Sets the name of the font.
Default value: System proportional
Point size Sets the point size of the font.
Default value: 10
Style Sets the style for the part.
Default value: None
Emphasis Gives the part emphasis. If a part is specified, the emphasis is
drawn around the part.
Default value: None
Edit Opens an edit field on a part or setting.
Default value: Highlighted
Default font Sets the current default font style.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ 3.40. IScrollBar ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Events
Settings Pages
General
Control
Styles
Handlers
Color
Size/Position
Font
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IScrollBar ΓòÉΓòÉΓòÉ
Title: IBM scroll-bar control
Class name: IScrollBar
Base part: IControl
Part type: Visual part
Part file: vbbase.vbb
An IScrollBar part is a window component consisting of a shaft, a scroll box
in the shaft, and scroll buttons at the ends of the shaft. A scroll bar is
either horizontal or vertical, indicating the availability of more information
in the same dimension.
The user can bring information into view using a scroll bar. This is done by
moving the scroll box along the shaft in the direction of the additional
information. The user can move the scroll box in any of the following ways:
Drag it with the mouse.
Click or hold down mouse button 1 in the shaft away from the scroll box
to pull it in that direction. This moves the scroll box and view contents
by increments of the view width or height.
Click or hold down a scroll button to pull the scroll box in the
direction of the scroll button. This moves the scroll box and view
contents by increments of the line height or character width.
Generally, use an IViewPort part for a view with scroll bars. Use an
IScrollBar part for custom logic that requires a scrollable view.
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - IScrollBar ΓòÉΓòÉΓòÉ
When building with an IScrollBar part, you can do the following:
Add a scroll bar to a canvas. Do this by dropping an IScrollBar part on
the canvas. Then, position and size the scroll bar to fit the canvas.
Change the scroll bar orientation to horizontal. Do this by setting the
vertical field to On and the horizontal field to Off on the IScrollBar
Styles settings page.
ΓòÉΓòÉΓòÉ <hidden> Attributes - IScrollBar ΓòÉΓòÉΓòÉ
Attribute S E Data type
activeColor Γûá Γûá IColor
asDebugInfo IString
asString IString
autoDeleteObject Γûá Boolean
autoDestroyWindow Γûá Boolean
backgroundColor Γûá Γûá IColor
bidiSupported Boolean
borderColor Γûá Γûá IColor
characterSize ISize
defaultPushButton IWindowHandle
disabledBackgroundColor Γûá Γûá IColor
disabledForegroundColor Γûá Γûá IColor
enabled Γûá Γûá Boolean
enabledForNotification Γûá Boolean
focus Γûá Boolean
font Γûá Γûá IFont
foregroundColor Γûá Γûá IColor
frameWindow Boolean
group Γûá Boolean
handle IWindowHandle
hiliteBackgroundColor Γûá Γûá IColor
hiliteForegroundColor Γûá Γûá IColor
horizontal Boolean
id Γûá unsigned long
inactiveColor Γûá Γûá IColor
itemProvider Γûá IDMItemProvider*
layoutAdjustment IRectangle
menu
messageQueue IMessageQueueHandle
minimumSize Γûá ISize
minScrollIncrement Γûá unsigned long
nativeRect IRectangle
owner Γûá IWindow*
pageScrollIncrement Γûá unsigned long
parent Γûá IWindow*
parentSize ISize
pointerCaptured Boolean
position Γûá Γûá IPoint
presSpace IPresSpaceHandle
rect Γûá IRectangle
scrollableRange Γûá IRange
scrollBoxPosition Γûá Γûá unsigned long
scrollBoxRange IRange
shadowColor Γûá Γûá IColor
showing Boolean
size Γûá Γûá ISize
systemScrollBarWidth unsigned long
systemScrollBoxLength unsigned long
systemScrollButtonLength unsigned long
tabStop Γûá Boolean
valid Boolean
vertical Boolean
visible Γûá Γûá Boolean
visibleCount Γûá unsigned long
visibleRectangle IRectangle
ΓòÉΓòÉΓòÉ <hidden> Actions - IScrollBar ΓòÉΓòÉΓòÉ
Action Parameters
applyBidiSettings BidiSettings&, Boolean, Boolean
capturePointer Boolean
convertToGUIStyle IBitFlag&, Boolean
disable None
disableGroup None
disableNotification None
disableTabStop None
disableUpdate None
dispatchRemainingHandlers IEvent&, Boolean
enable Boolean
enableUpdate Boolean
handleException IException&, IEvent&
hide None
hideSourceEmphasis None
isLayoutDistorted unsigned long
matchForMnemonic unsigned short
notifyObservers INotificationEvent&
positionBehindSibling IWindowHandle&
positionBehindSiblings None
positionOnSiblings None
postEvent unsigned long, IEventParameter1&,
IEventParameter2&
refresh IRectangle&
releasePointer None
releasePresSpace IPresSpaceHandle&
resetActiveColor None
resetBackgroundColor None
resetBorderColor None
resetDisabledBackgroundColor None
resetDisabledForegroundColor None
resetFont None
resetForegroundColor None
resetHiliteBackgroundColor None
resetHiliteForegroundColor None
resetInactiveColor None
resetMinimumSize None
resetShadowColor None
sendEvent unsigned long, IEventParameter1&,
IEventParameter2&
setFocus None
setLayoutDistorted unsigned long, unsigned long
setScrollBar IRange&, unsigned long
show Boolean
showSourceEmphasis Boolean
ΓòÉΓòÉΓòÉ <hidden> Events - IScrollBar ΓòÉΓòÉΓòÉ
Event Notification ID
commandEvent commandId
gotFocusEvent FOCUSTRUEID
inputDisabledEvent ENABLEFALSEID
inputEnabledEvent ENABLETRUEID
lostFocusEvent FOCUSFALSEID
systemCommandEvent systemCommandId
visibilityDisabledEvent VISIBLEFALSEID
visibilityEnabledEvent VISIBLETRUEID
ΓòÉΓòÉΓòÉ <hidden> General Settings - IScrollBar ΓòÉΓòÉΓòÉ
Name Sets the name of the part.
Default value: The name of the part
Lower Sets the length of the scroll bar.
Default value: 0
Upper Sets the width of the scroll bar.
Default value: 0
Visible Count Sets the amount of the scrollable range that is displayed.
Default value: 25
Scroll box position Sets the current position of the scroll bar.
Default value: 1
Color selection Sets the minimum amount of the scrollable range that the user
can scroll by selecting the scroll buttons.
Default value: 1
Page scroll increment Sets the amount of the scrollable range that is scrolled
by selecting the scroll shaft.
Default value: 24
Subpart name Sets the name of the subpart (a part placed on a composite part).
Default value: The name of the part
ΓòÉΓòÉΓòÉ <hidden> Control Settings - IScrollBar ΓòÉΓòÉΓòÉ
Fly over short text Specifies the short text for the fly-over text control.
Default value: None
Fly over long text Specifies the long text for the fly-over text control.
Default value: None
Window id Sets the window identifier.
Default value: None
Help panel id Sets the help panel identifier for the part.
Default value: None
Enabled Enables the handler by default.
Default value: Selected
ΓòÉΓòÉΓòÉ <hidden> Styles Settings - IScrollBar ΓòÉΓòÉΓòÉ
defaultStyle() Resets the part to the original default style.
Default value: Selected
autoSize Enables automatic sizing of the scroll bar. For a vertical scroll
bar, the width is determined. For a horizontal scroll bar, the height is
determined.
Default value: The Default radio button is selected.
horizontal Creates a horizontal scroll bar. This style is ignored if it is
used with vertical.
A deck of child windows is arranged in the canvas horizontally in rows from
left to right. Decks of rows are arranged from top to bottom.
Default value: The default is off, and the Default radio button is selected.
vertical Creates a vertical scroll bar. This style is used if both it and
horizontal are specified.
A deck of child windows is arranged in the canvas vertically in columns from
top to bottom. Decks of columns are arranged from left to right.
Default value: The default is on, and the Default radio button is selected.
group Identifies the control as being the first in a group. No other controls
in the group can have this style. Controls in the group must be siblings
that are constructed following the first control. The group can be cursored
and when the last control in the group is reached, the cursor returns the
first control in the group.
Default value: The default is off, and the Default radio button is selected.
tabStop Identifies the control as one to which the user can tab.
Default value: The default is off, and the Default radio button is selected.
clipChildren Excludes the area occupied by the children of the window when
drawing in the window. Child windows are always "clipped" to their parent
window. When a parent window is painted, the clipChildren style controls
whether the invalidated region of the parent window includes the area
occupied by its children, thus preventing a window from painting over its
child windows.
Default value: The Default radio button is selected.
clipSiblings Controls which sibling window is displayed on top when multiple
siblings are displayed. Sibling windows are windows that share the same
parent window. Assign the clipSiblings style to the sibling window that you
want displayed on top of the other siblings, in Z-order.
Default value: The Default radio button is selected.
clipToParent Allows a window to paint outside of its window boundary up to the
window boundary of its parent.
Default value: The Default radio button is selected.
saveBits Optimizes the painting of a window by saving the screen image of the
area under the window as a bitmap and then using the bitmap to redraw the
window, when necessary.
Default value: The Default radio button is selected.
synchPaint Synchronously repaints the window. Without this style, painting
only occurs if there are no other events waiting to be processed.
Default value: The Default radio button is selected.
visible Makes the window visible. In general, controls are constructed as
visible, and frame windows are constructed as invisible.
Default value: The default is on, and the Default radio button is selected.
ΓòÉΓòÉΓòÉ <hidden> Handlers Settings - IScrollBar ΓòÉΓòÉΓòÉ
Handler name Sets the name of the default handler.
Default value: None
Handler list Sets the name of the handler for the MLE control.
Default value: None
Add after Adds the new choice after the selected choice in the list. If no
choice is selected, the new choice is added after the first choice in the
list.
Default value: Highlighted
Add before Adds the new choice before the selected choice in the list. If no
choice is selected, the new choice is added before the first choice in the
list.
Default value: Not highlighted
Move Determines whether a part and its descendants can be moved to a new
location.
Default value: Not highlighted
Remove Removes one item from the part and returns the count of the number of
items that remain.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ <hidden> Color Settings - IScrollBar ΓòÉΓòÉΓòÉ
Color area Sets the color of the given area. Choices are as follows:
Foreground
Sets the color for foreground text
Highlighted foreground
Sets the foreground color for selected text
Default value: Foreground is selected
Color selection Enables color selection by either color values or RGB values.
Select Colors or RGB. If you select Colors, you can set the Color values. If
you select RGB, you can set the RGB values.
Default value: RGB selected
Color values Sets the color value of the window area, or sets the passed
default if no color for the area has been set.
Default value: None
RGB values Sets the color values for the scroll bar.
Default value: Red=204, Green=204, Blue=204
ΓòÉΓòÉΓòÉ <hidden> Size/Position Settings - IScrollBar ΓòÉΓòÉΓòÉ
X field Sets the X coordinate of the part.
Default value: The x coordinate of the part currently positioned on the
free-form surface
Y field Sets the Y coordinate of the point.
Default value: The y coordinate of the part currently positioned on the
free-form surface
Width Sets the width of the text.
Default value: None
Height Sets the height of the text.
Default value: None
Minimum size Determines the minimum size of the part.
Select Calculate at execution time or Set value here. If you select
Calculate at execution time, the minimum size is determined dynamically. If
you select Set value here, you can set the Minimum size Width and Height
fields to define a fixed minimum size.
Default value: Calculate at execution time is selected
Width Sets the minimum-allowable width, which is set by the user's class.
Default value: None (calculated at execution time)
Height Sets the minimum-allowable height, which is set by the user's class.
Default value: None (calculated at execution time)
ΓòÉΓòÉΓòÉ <hidden> Font Settings - IScrollBar ΓòÉΓòÉΓòÉ
Name Sets the name of the font.
Default value: System proportional
Point size Sets the point size of the font.
Default value: 10
Style Sets the style for the part.
Default value: None
Emphasis Gives the part emphasis. If a part is specified, the emphasis is
drawn around the part.
Default value: None
Edit Opens an edit field on a part or setting.
Default value: Highlighted
Default font Sets the current default font style.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ 3.41. ISetCanvas ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Events
Settings Pages
General
Control
Styles
Handlers
Color
Size/Position
Font
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - ISetCanvas ΓòÉΓòÉΓòÉ
Title: IBM canvas control with child windows set in decks
Class name: ISetCanvas
Base part: ICanvas
Part type: Visual part
Part file: vbbase.vbb
An ISetCanvas part is a set of cells organized in rows or columns. These rows
or columns are called decks.
The user interacts with controls placed in the cells, not with the canvas
itself.
Use an ISetCanvas part to provide adjustable cells in rows or columns within a
framework, such as one of the following:
The client area of a frame window
A view port
A multicell canvas cell
A split canvas pane
A notebook page
You can then place other controls in the cells of the set canvas. For example,
you can easily arrange a field of push buttons in the cells of a set canvas.
You can also use a set canvas as the base part for a composite part. Then, you
can add the canvas with its controls as a subpart on a canvas in another
composite part.
The cells in a set canvas are adjusted for varying control text length. This
enhances national language support.
Alternatively, use one of the following canvases:
ICanvas for a single canvas cell
ISplitCanvas for split windows
IMultiCellCanvas to provide freely arranged canvas cells
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - ISetCanvas ΓòÉΓòÉΓòÉ
When building with an ISetCanvas part, you can do the following:
Organize the cells in rows or columns. By default, the cells are
organized in a single row.
To change the cell orientation to columns, select the vertical setting in
the Deck orientation field on the ISetCanvas General settings page.
To change the number of decks (rows or columns), set the Deck count field
on the ISetCanvas General settings page to the number you want.
Place controls in the set canvas. Do this by dropping them on the set
canvas. Each cell is made large enough to accommodate any static text in
the control placed in the cell.
Align cells across multiple decks to give the appearance of both rows and
columns. Do this by selecting the Even setting in the Pack type field on
the ISetCanvas General settings page.
Make all cells in a deck the same size. Do this by selecting the Expanded
setting in the Pack type field on the ISetCanvas General settings page.
The cells are all the the size of the largest minimum size of controls in
the cells.
Align the cells in a deck with each other. Do this by selecting the
alignment you want in the Alignment field on the ISetCanvas General
settings page.
Add a handler for all parts on the canvas. Do this as follows:
- Add the handler name and parameters in the Handler list field on the
ISetCanvas Handlers settings page.
- Type the .hpp file name for the handler in the Class Editor Required
include files field.
ΓòÉΓòÉΓòÉ <hidden> Attributes - ISetCanvas ΓòÉΓòÉΓòÉ
Attribute S E Data type
activeColor Γûá Γûá IColor
alignment Γûá Alignment
asDebugInfo IString
asString IString
autoDeleteObject Γûá Boolean
autoDestroyWindow Γûá Boolean
backgroundColor Γûá Γûá IColor
bidiSupported Boolean
borderColor Γûá Γûá IColor
characterSize ISize
deckCount Γûá unsigned long
deckOrientation Γûá Γûá DeckOrientation
defaultPushButton IWindowHandle
disabledBackgroundColor Γûá Γûá IColor
disabledForegroundColor Γûá Γûá IColor
enabled Γûá Γûá Boolean
enabledForNotification Γûá Boolean
focus Γûá Boolean
font Γûá Γûá IFont
foregroundColor Γûá Γûá IColor
frameWindow Boolean
group Γûá Boolean
groupPad Γûá unsigned long
handle IWindowHandle
hiliteBackgroundColor Γûá Γûá IColor
hiliteForegroundColor Γûá Γûá IColor
id Γûá unsigned long
inactiveColor Γûá Γûá IColor
itemProvider Γûá IDMItemProvider*
layoutAdjustment IRectangle
margin Γûá ISize
menu
messageQueue IMessageQueueHandle
minimumSize Γûá ISize
nativeRect IRectangle
origDefaultButtonHandle IWindowHandle
owner Γûá IWindow*
packType Γûá PackType
pad Γûá ISize
parent Γûá IWindow*
parentSize ISize
pointerCaptured Boolean
position Γûá Γûá IPoint
presSpace IPresSpaceHandle
rect Γûá IRectangle
shadowColor Γûá Γûá IColor
showing Boolean
size Γûá Γûá ISize
tabStop Γûá Boolean
text Γûá Γûá IString
valid Boolean
visible Γûá Γûá Boolean
visibleRectangle IRectangle
ΓòÉΓòÉΓòÉ <hidden> Actions - ISetCanvas ΓòÉΓòÉΓòÉ
Action Parameters
applyBidiSettings BidiSettings&, Boolean, Boolean
capturePointer Boolean
convertToGUIStyle IBitFlag&, Boolean
disable None
disableGroup None
disableNotification None
disableTabStop None
disableUpdate None
dispatchRemainingHandlers IEvent&, Boolean
enable Boolean
enableUpdate Boolean
handleException IException&, IEvent&
hide None
hideSourceEmphasis None
isLayoutDistorted unsigned long
matchForMnemonic unsigned short
notifyObservers INotificationEvent&
positionBehindSibling IWindowHandle&
positionBehindSiblings None
positionOnSiblings None
postEvent unsigned long, IEventParameter1&,
IEventParameter2&
refresh IRectangle&
releasePointer None
releasePresSpace IPresSpaceHandle&
resetActiveColor None
resetBackgroundColor None
resetBorderColor None
resetDisabledBackgroundColor None
resetDisabledForegroundColor None
resetFont None
resetForegroundColor None
resetHiliteBackgroundColor None
resetHiliteForegroundColor None
resetInactiveColor None
resetMinimumSize None
resetShadowColor None
sendEvent unsigned long, IEventParameter1&,
IEventParameter2&
setFocus None
setLayoutDistorted unsigned long, unsigned long
show Boolean
showSourceEmphasis Boolean
ΓòÉΓòÉΓòÉ <hidden> Events - ISetCanvas ΓòÉΓòÉΓòÉ
Event Notification ID
commandEvent commandId
gotFocusEvent FOCUSTRUEID
inputDisabledEvent ENABLEFALSEID
inputEnabledEvent ENABLETRUEID
lostFocusEvent FOCUSFALSEID
systemCommandEvent systemCommandId
visibilityDisabledEvent VISIBLEFALSEID
visibilityEnabledEvent VISIBLETRUEID
ΓòÉΓòÉΓòÉ <hidden> General Settings - ISetCanvas ΓòÉΓòÉΓòÉ
Name Sets the name of the part.
Default value: The name of the part
Deck orientation Sets the current orientation of the deck of child windows.
Default value: Vertical
Pack type Sets how parts are spaced in decks.
Default value: Tight
Text Sets the text for the part.
Default value: The name of the part
Deck count Sets the maximum number of decks used by the canvas.
Default value: 1
Width Specifies the width of the margin. It is half a character and is based
on the current font being used for the entry field text.
Default value: 8
Height Specifies the height of the margin. It is half a character and is based
on the current font being used for the entry field text.
Default value: 10
Width Sets the pad width, which is the space between child windows in a deck
and between multiple decks.
Default value: 8
Height Sets the pad height, which is the space between child windows in a deck
and between multiple decks.
Default value: 10
Alignment Changes the alignment of the part.
Default value: Upper left
Subpart name Sets the name of the subpart (a part placed on a composite part).
Default value: The name of the part
ΓòÉΓòÉΓòÉ <hidden> Control Settings - ISetCanvas ΓòÉΓòÉΓòÉ
Fly over short text Specifies the short text for the fly-over text control.
Default value: None
Fly over long text Specifies the long text for the fly-over text control.
Default value: None
Window id Sets the window identifier.
Default value: None
Help panel id Sets the help panel identifier for the part.
Default value: None
Enabled Enables the handler by default.
Default value: Selected
ΓòÉΓòÉΓòÉ <hidden> Styles Settings - ISetCanvas ΓòÉΓòÉΓòÉ
defaultStyle() Resets the part to the original default style.
Default value: Selected
horizontalDecks Sets the orientation of the deck of child windows to
horizontal.
Default value: The Default radio button is selected.
verticalDecks Sets the orientation of the deck of child windows to vertical.
Default value: The Default radio button is selected.
tabStop Identifies the control as one to which the user can tab.
Default value: The default is off, and the Default radio button is selected.
clipChildren Excludes the area occupied by the children of the window when
drawing in the window. Child windows are always "clipped" to their parent
window. When a parent window is painted, the clipChildren style controls
whether the invalidated region of the parent window includes the area
occupied by its children, thus preventing a window from painting over its
child windows.
Default value: The Default radio button is selected.
clipSiblings Controls which sibling window is displayed on top when multiple
siblings are displayed. Sibling windows are windows that share the same
parent window. Assign the clipSiblings style to the sibling window that you
want displayed on top of the other siblings, in Z-order.
Default value: The Default radio button is selected.
clipToParent Allows a window to paint outside of its window boundary up to the
window boundary of its parent.
Default value: The Default radio button is selected.
saveBits Optimizes the painting of a window by saving the screen image of the
area under the window as a bitmap and then using the bitmap to redraw the
window, when necessary.
Default value: The Default radio button is selected.
synchPaint Synchronously repaints the window. Without this style, painting
only occurs if there are no other events waiting to be processed.
Default value: The Default radio button is selected.
visible Makes the window visible. In general, controls are constructed as
visible, and frame windows are constructed as invisible.
Default value: The default is on, and the Default radio button is selected.
ΓòÉΓòÉΓòÉ <hidden> Handlers Settings - ISetCanvas ΓòÉΓòÉΓòÉ
Handler name Sets the name of the default handler.
Default value: None
Handler list Sets the name of the handler for the MLE control.
Default value: None
Add after Adds the new choice after the selected choice in the list. If no
choice is selected, the new choice is added after the first choice in the
list.
Default value: Highlighted
Add before Adds the new choice before the selected choice in the list. If no
choice is selected, the new choice is added before the first choice in the
list.
Default value: Not highlighted
Move Determines whether a part and its descendants can be moved to a new
location.
Default value: Not highlighted
Remove Removes one item from the part and returns the count of the number of
items that remain.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ <hidden> Color Settings - ISetCanvas ΓòÉΓòÉΓòÉ
Color area Sets the color of the given area. Choices are as follows:
Background
Sets the color for background text
Default value: Background is selected
Color selection Enables color selection by either color values or RGB values.
Select Colors or RGB. If you select Colors, you can set the Color values. If
you select RGB, you can set the RGB values.
Default value: Colors selected
Color values Sets the color value of the window area, or sets the passed
default if no color for the area has been set.
Default value: None
RGB values Sets the color values for the canvas.
Default value: Red=255, Green=255, Blue=255
ΓòÉΓòÉΓòÉ <hidden> Size/Position Settings - ISetCanvas ΓòÉΓòÉΓòÉ
X field Sets the X coordinate of the part.
Default value: The x coordinate of the part currently positioned on the
free-form surface
Y field Sets the Y coordinate of the point.
Default value: The y coordinate of the part currently positioned on the
free-form surface
Width Sets the width of the text.
Default value: None
Height Sets the height of the text.
Default value: None
Minimum size Determines the minimum size of the part.
Select Calculate at execution time or Set value here. If you select
Calculate at execution time, the minimum size is determined dynamically. If
you select Set value here, you can set the Minimum size Width and Height
fields to define a fixed minimum size.
Default value: Calculate at execution time is selected
Width Sets the minimum-allowable width, which is set by the user's class.
Default value: None (calculated at execution time)
Height Sets the minimum-allowable height, which is set by the user's class.
Default value: None (calculated at execution time)
ΓòÉΓòÉΓòÉ <hidden> Font Settings - ISetCanvas ΓòÉΓòÉΓòÉ
Name Sets the name of the font.
Default value: System proportional
Point size Sets the point size of the font.
Default value: 10
Style Sets the style for the part.
Default value: None
Emphasis Gives the part emphasis. If a part is specified, the emphasis is
drawn around the part.
Default value: None
Edit Opens an edit field on a part or setting.
Default value: Highlighted
Default font Sets the current default font style.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ 3.42. ISlider ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Events
Settings Pages
General
Control
Styles
Handlers
Color
Size/Position
Font
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - ISlider ΓòÉΓòÉΓòÉ
Title: IBM linear slider control
Class name: ISlider
Base part: IProgressIndicator
Part type: Visual part
Part file: vbbase.vbb
An ISlider part shows a range of selection values. A horizontal or vertical
shaft represents the range of values. A slider arm marks the selected value.
The user moves the arm along the shaft to change the selected value. The user
can move the arm in any of the following ways:
Drag it with the mouse.
Click or press a slider button to move the scroll box in the direction
indicated on the button. This moves the arm by tick increments defined
for the slider.
Use an ISlider part to do the following:
Provide a range of seemingly nondiscrete selection values, such as shades
of visual color
Provide a range of discrete selection values, such as radio station
frequencies
Show a value relative to a range of potential values, such as the current
temperature on a thermometer
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - ISlider ΓòÉΓòÉΓòÉ
When building with an ISlider part, you can do the following:
Define the value scale for the slider. Do this as follows:
- Enter the number of ticks in the Number of ticks field on the
ISlider General settings page.
- Select the location of the scale of tick marks and text relative to
the slider. Do this by selecting a choice in the Primary scale field
on the ISlider General settings page. If you want the scale above a
horizontal slider or to the right of a vertical slider, select the
Scale 1 choice. If you want the scale below a horizontal slider or
to the left of a vertical slider, select the Scale 2 choice.
- Add scale tick marks and text to the slider. Do this using custom
logic. Click mouse button 2 on the free-form surface and connect the
composite part ready event to ISlider Custom logic. Enter C++ code
to set the size and text for each tick mark.
For example, if you want the user to set a rating from 0 to 100 with
marks at intervals of 10, you could enter the following code:
for (int i = 0; i < 101; i += 10)
{
target->setTickLength(i, 10);
target->setTickText(i, IString(i));
}
Determine the orientation of the slider. By default, the orientation is
horizontal. To orient the slider vertically, set the vertical field to On
and set the horizontal field to Off on the ISlider Styles settings page.
Select the location of slider buttons relative to the slider. Do this by
selecting a button location choice on the ISlider Styles settings page.
If you want slider buttons, set one of the following location choices to
On and set the others to Off:
Choice Button location
buttonsBottom Below the slider shaft.
buttonsLeft Left of the slider shaft.
buttonsRight Right of the slider shaft.
buttonsTop Above the slider shaft.
If you do not want slider buttons, set all of the location choices to
Off.
Define the home position for the slider. Do this by selecting a choice in
the Home position field on the ISlider General settings page. If you want
the home position at the left of a horizontal slider or at the bottom of
a vertical slider, select the Left or bottom choice. If you want the home
position at the right of a horizontal slider or at the top of a vertical
slider, select the Top or right choice.
If you want the initial arm offset somewhere other than at the home
position, set the Arm offset field on the ISlider General settings page.
Specify either a tick offset for Ticks or a pixel offset for Pixels.
Force the arm to the nearest tick if you use a pixel offset. Do this by
setting the snapToTickMark field to On on the ISlider Styles settings
page.
Provide the selected value to an attribute in another part or to an
action parameter. Do this by connecting the ISlider armTickOffset
attribute to the target attribute or action connection parameter.
ΓòÉΓòÉΓòÉ <hidden> Attributes - ISlider ΓòÉΓòÉΓòÉ
Attribute S E Data type
activeColor Γûá Γûá IColor
alignment Alignment
armPixelOffset Γûá Γûá unsigned long
armRange unsigned long
armSize Γûá ISize
armTickOffset Γûá Γûá unsigned long
asDebugInfo IString
asString IString
autoDeleteObject Γûá Boolean
autoDestroyWindow Γûá Boolean
backgroundColor Γûá Γûá IColor
bidiSupported Boolean
borderColor Γûá Γûá IColor
buttonsPosition ButtonsPosition
characterSize ISize
defaultPushButton IWindowHandle
disabledBackgroundColor Γûá Γûá IColor
disabledForegroundColor Γûá Γûá IColor
drawItemEnabled Γûá Boolean
enabled Γûá Γûá Boolean
enabledForNotification Γûá Boolean
focus Γûá Boolean
font Γûá Γûá IFont
foregroundColor Γûá Γûá IColor
frameWindow Boolean
group Γûá Boolean
handle IWindowHandle
hiliteBackgroundColor Γûá Γûá IColor
hiliteForegroundColor Γûá Γûá IColor
homePosition Γûá HomePosition
id Γûá unsigned long
inactiveColor Γûá Γûá IColor
itemProvider Γûá IDMItemProvider*
layoutAdjustment IRectangle
menu
messageQueue IMessageQueueHandle
minimumSize Γûá ISize
nativeRect IRectangle
owner Γûá IWindow*
parent Γûá IWindow*
parentSize ISize
pointerCaptured Boolean
position Γûá Γûá IPoint
presSpace IPresSpaceHandle
primaryScale Γûá Γûá Scale
rect Γûá IRectangle
ribbonStripEnabled Γûá Boolean
shadowColor Γûá Γûá IColor
shaftPosition Γûá IPoint
shaftSize ISize
showing Boolean
size Γûá Γûá ISize
snapToTickEnabled Γûá Boolean
tabStop Γûá Boolean
valid Boolean
vertical Boolean
visible Γûá Γûá Boolean
visibleRectangle IRectangle
ΓòÉΓòÉΓòÉ <hidden> Actions - ISlider ΓòÉΓòÉΓòÉ
Action Parameters
addDetent unsigned long
applyBidiSettings BidiSettings&, Boolean, Boolean
capturePointer Boolean
convertToGUIStyle IBitFlag&, Boolean
detentPosition unsigned long
disable None
disableDrawItem None
disableGroup None
disableNotification None
disableRibbonStrip None
disableSnapToTick None
disableTabStop None
disableUpdate None
dispatchRemainingHandlers IEvent&, Boolean
enable Boolean
enableUpdate Boolean
handleException IException&, IEvent&
hide None
hideSourceEmphasis None
isLayoutDistorted unsigned long
matchForMnemonic unsigned short
notifyObservers INotificationEvent&
numberOfTicks Scale
positionBehindSibling IWindowHandle&
positionBehindSiblings None
positionOnSiblings None
postEvent unsigned long, IEventParameter1&,
IEventParameter2&
refresh IRectangle&
releasePointer None
releasePresSpace IPresSpaceHandle&
removeDetent unsigned long
resetActiveColor None
resetBackgroundColor None
resetBorderColor None
resetDisabledBackgroundColor None
resetDisabledForegroundColor None
resetFont None
resetForegroundColor None
resetHiliteBackgroundColor None
resetHiliteForegroundColor None
resetInactiveColor None
resetMinimumSize None
resetShadowColor None
sendEvent unsigned long, IEventParameter1&,
IEventParameter2&
setFocus None
setLayoutDistorted unsigned long, unsigned long
setShaftBreadth unsigned long
setTickLength unsigned long, unsigned long
setTicks unsigned long, unsigned long, unsigned long,
unsigned long
setTickText unsigned long, char*
show Boolean
showSourceEmphasis Boolean
tickLength unsigned long
tickPosition unsigned long
tickSpacing Scale
tickText unsigned long
ΓòÉΓòÉΓòÉ <hidden> Events - ISlider ΓòÉΓòÉΓòÉ
Event Notification ID
commandEvent commandId
gotFocusEvent FOCUSTRUEID
inputDisabledEvent ENABLEFALSEID
inputEnabledEvent ENABLETRUEID
lostFocusEvent FOCUSFALSEID
scaleEvent scaleId
systemCommandEvent systemCommandId
visibilityDisabledEvent VISIBLEFALSEID
visibilityEnabledEvent VISIBLETRUEID
ΓòÉΓòÉΓòÉ <hidden> General Settings - ISlider ΓòÉΓòÉΓòÉ
Subpart name Sets the name of the subpart (a part placed on a composite part).
Default value: The name of the part
Number of ticks Sets the number of ticks.
Default value: 2
Tick spacing Sets the number of pixels between ticks for the specified scale.
Default value: None
Ticks Sets the position of the arm as a tick number. Ticks are numbered
starting at zero.
Default value: 0
Pixels Sets the offset of the arm from the home position.
Default value: 0
Home position Sets the home position of the progress indicator.
Default value: Left or bottom
Primary scale Sets the primary scale of the progress indicator.
Default value: Scale 1
ΓòÉΓòÉΓòÉ <hidden> Control Settings - ISlider ΓòÉΓòÉΓòÉ
Fly over short text Specifies the short text for the fly-over text control.
Default value: None
Fly over long text Specifies the long text for the fly-over text control.
Default value: None
Window id Sets the window identifier.
Default value: None
Help panel id Sets the help panel identifier for the part.
Default value: None
Enabled Enables the handler by default.
Default value: Selected
ΓòÉΓòÉΓòÉ <hidden> Styles Settings - ISlider ΓòÉΓòÉΓòÉ
defaultStyle() Resets the part to the original default style.
Default value: Selected
buttonsTop Aligns the push buttons with the top side of the part.
Default value: The Default radio button is selected.
buttonsBottom Aligns the push buttons with the bottom side of the part.
Default value: The Default radio button is selected.
buttonsLeft Aligns the push buttons with the left side of the part.
Default value: The Default radio button is selected.
buttonsRight Aligns the push buttons with the right side of the part.
Default value: The Default radio button is selected.
horizontal Creates a horizontal scroll bar. This style is ignored if it is
used with vertical.
A deck of child windows is arranged in the canvas horizontally in rows from
left to right. Decks of rows are arranged from top to bottom.
Default value: The default is off, and the Default radio button is selected.
snapToTickMark Specifies that the progress indicator arm snap to the nearest
tick when moved between two ticks.
Default value: The Default radio button is selected.
ribbonStrip Sets the default ribbonStrip style.
Default value: The Default radio button is selected.
handleDrawItem Generates a draw item event to allow the application to draw
the part.
Default value: The Default radio button is selected.
vertical Creates a vertical scroll bar. This style is used if both it and
horizontal are specified.
A deck of child windows is arranged in the canvas vertically in columns from
top to bottom. Decks of columns are arranged from left to right.
Default value: The default is on, and the Default radio button is selected.
group Identifies the control as being the first in a group. No other controls
in the group can have this style. Controls in the group must be siblings
that are constructed following the first control. The group can be cursored
and when the last control in the group is reached, the cursor returns the
first control in the group.
Default value: The default is off, and the Default radio button is selected.
tabStop Identifies the control as one to which the user can tab.
Default value: The default is off, and the Default radio button is selected.
clipChildren Excludes the area occupied by the children of the window when
drawing in the window. Child windows are always "clipped" to their parent
window. When a parent window is painted, the clipChildren style controls
whether the invalidated region of the parent window includes the area
occupied by its children, thus preventing a window from painting over its
child windows.
Default value: The Default radio button is selected.
clipSiblings Controls which sibling window is displayed on top when multiple
siblings are displayed. Sibling windows are windows that share the same
parent window. Assign the clipSiblings style to the sibling window that you
want displayed on top of the other siblings, in Z-order.
Default value: The Default radio button is selected.
clipToParent Allows a window to paint outside of its window boundary up to the
window boundary of its parent.
Default value: The Default radio button is selected.
saveBits Optimizes the painting of a window by saving the screen image of the
area under the window as a bitmap and then using the bitmap to redraw the
window, when necessary.
Default value: The Default radio button is selected.
synchPaint Synchronously repaints the window. Without this style, painting
only occurs if there are no other events waiting to be processed.
Default value: The Default radio button is selected.
visible Makes the window visible. In general, controls are constructed as
visible, and frame windows are constructed as invisible.
Default value: The default is on, and the Default radio button is selected.
ΓòÉΓòÉΓòÉ <hidden> Handlers Settings - ISlider ΓòÉΓòÉΓòÉ
Handler name Sets the name of the default handler.
Default value: None
Handler list Sets the name of the handler for the MLE control.
Default value: None
Add after Adds the new choice after the selected choice in the list. If no
choice is selected, the new choice is added after the first choice in the
list.
Default value: Highlighted
Add before Adds the new choice before the selected choice in the list. If no
choice is selected, the new choice is added before the first choice in the
list.
Default value: Not highlighted
Move Determines whether a part and its descendants can be moved to a new
location.
Default value: Not highlighted
Remove Removes one item from the part and returns the count of the number of
items that remain.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ <hidden> Color Settings - ISlider ΓòÉΓòÉΓòÉ
Color area Sets the color of the given area. Choices are as follows:
Foreground
Sets the color for foreground text
Background
Sets the color for background text
Border
Sets the color of the border drawn around the children of the
frame window.
Default value: Foreground is selected
Color selection Enables color selection by either color values or RGB values.
Select Colors or RGB. If you select Colors, you can set the Color values. If
you select RGB, you can set the RGB values.
Default value: RGB selected
Color values Sets the color value of the window area, or sets the passed
default if no color for the area has been set.
Default value: None
RGB values Sets the color values for the window area.
Default value: Not set
ΓòÉΓòÉΓòÉ <hidden> Size/Position Settings - ISlider ΓòÉΓòÉΓòÉ
X field Sets the X coordinate of the part.
Default value: The x coordinate of the part currently positioned on the
free-form surface
Y field Sets the Y coordinate of the point.
Default value: The y coordinate of the part currently positioned on the
free-form surface
Width Sets the width of the text.
Default value: None
Height Sets the height of the text.
Default value: None
Minimum size Determines the minimum size of the part.
Select Calculate at execution time or Set value here. If you select
Calculate at execution time, the minimum size is determined dynamically. If
you select Set value here, you can set the Minimum size Width and Height
fields to define a fixed minimum size.
Default value: Calculate at execution time is selected
Width Sets the minimum-allowable width, which is set by the user's class.
Default value: None (calculated at execution time)
Height Sets the minimum-allowable height, which is set by the user's class.
Default value: None (calculated at execution time)
ΓòÉΓòÉΓòÉ <hidden> Font Settings - ISlider ΓòÉΓòÉΓòÉ
Name Sets the name of the font.
Default value: System proportional
Point size Sets the point size of the font.
Default value: 10
Style Sets the style for the part.
Default value: None
Emphasis Gives the part emphasis. If a part is specified, the emphasis is
drawn around the part.
Default value: None
Edit Opens an edit field on a part or setting.
Default value: Highlighted
Default font Sets the current default font style.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ 3.43. ISplitCanvas ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Events
Settings Pages
General
Control
Styles
Handlers
Color
Size/Position
Font
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - ISplitCanvas ΓòÉΓòÉΓòÉ
Title: IBM canvas divided into resizable panes
Class name: ISplitCanvas
Base part: ICanvas
Part type: Visual part
Part file: vbbase.vbb
An ISplitCanvas part is a split window in which view ports or canvases can be
placed. A split bar appears between panes in the split canvas.
The user can move the split bar by pressing mouse button 2 on it and dragging
it.
Use an ISplitCanvas part to provide split windows within a framework, such as
one of the following:
The client area of a frame window
A multicell canvas cell
A notebook page
You can then place another canvas or a view port in each pane of the split
window.
You can also use a split canvas as the base part for a composite part. Then,
you can add the canvas with its controls as a subpart on a canvas in another
composite part.
Alternatively, use one of the following canvases:
ICanvas for a single canvas cell
ISetCanvas for canvas cells in uniform rows or columns
IMultiCellCanvas to provide freely arranged canvas cells
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - ISplitCanvas ΓòÉΓòÉΓòÉ
When building with an ISplitCanvas part, you can do the following:
Assign the split canvas to the client area of a frame window. Do this as
follows:
1. Remove an existing client from the frame window by clicking mouse
button2 on the client area and selecting the Delete choice.
2. Select an ISplitCanvas part from the parts palette and drop it on
the frame window client area. The client area is initially filled
with a primitive part.
Create and fill the panes of the split window. Each pane should be filled
with a canvas or a view port. For example, to create three panes with
view ports in them, do the following:
1. Drop a view port on the primitive part. A split bar and two panes
appear, with the view port in the first pane.
2. Drop a view port on the primitive part or on the split bar. The new
view port replaces the primitive part in the second pane.
3. Drop a view port on the split bar. A second split bar and third pane
appear, with the new view port in the third pane.
Change the window orientation to split horizontally. Do this by selecting
the horizontal setting in the Orientation field on the ISplitCanvas
General settings page. To open the settings view for a split canvas after
panes have been created, click mouse button 2 on a split bar.
Add a handler for all parts on the canvas. Do this as follows:
- Add the handler name and parameters in the Handler list field on the
ISplitCanvas Handlers settings page.
- Type the .hpp file name for the handler in the Class Editor Required
include files field.
ΓòÉΓòÉΓòÉ <hidden> Attributes - ISplitCanvas ΓòÉΓòÉΓòÉ
Attribute S E Data type
activeColor Γûá Γûá IColor
asDebugInfo IString
asString IString
autoDeleteObject Γûá Boolean
autoDestroyWindow Γûá Boolean
backgroundColor Γûá Γûá IColor
bidiSupported Boolean
borderColor Γûá Γûá IColor
characterSize ISize
defaultPushButton IWindowHandle
disabledBackgroundColor Γûá Γûá IColor
disabledForegroundColor Γûá Γûá IColor
enabled Γûá Γûá Boolean
enabledForNotification Γûá Boolean
focus Γûá Boolean
font Γûá Γûá IFont
foregroundColor Γûá Γûá IColor
frameWindow Boolean
group Γûá Boolean
handle IWindowHandle
hiliteBackgroundColor Γûá Γûá IColor
hiliteForegroundColor Γûá Γûá IColor
id Γûá unsigned long
inactiveColor Γûá Γûá IColor
itemProvider Γûá IDMItemProvider*
layoutAdjustment IRectangle
menu
messageQueue IMessageQueueHandle
minimumSize Γûá ISize
nativeRect IRectangle
orientation Γûá Γûá Orientation
origDefaultButtonHandle IWindowHandle
owner Γûá IWindow*
parent Γûá IWindow*
parentSize ISize
pointerCaptured Boolean
position Γûá Γûá IPoint
presSpace IPresSpaceHandle
rect Γûá IRectangle
shadowColor Γûá Γûá IColor
showing Boolean
size Γûá Γûá ISize
splitBarEdgeColor Γûá IColor
splitBarMiddleColor Γûá IColor
tabStop Γûá Boolean
valid Boolean
visible Γûá Γûá Boolean
visibleRectangle IRectangle
ΓòÉΓòÉΓòÉ <hidden> Actions - ISplitCanvas ΓòÉΓòÉΓòÉ
Action Parameters
applyBidiSettings BidiSettings&, Boolean, Boolean
capturePointer Boolean
convertToGUIStyle IBitFlag&, Boolean
disable None
disableGroup None
disableNotification None
disableTabStop None
disableUpdate None
dispatchRemainingHandlers IEvent&, Boolean
enable Boolean
enableUpdate Boolean
handleException IException&, IEvent&
hide None
hideSourceEmphasis None
isLayoutDistorted unsigned long
matchForMnemonic unsigned short
notifyObservers INotificationEvent&
positionBehindSibling IWindowHandle&
positionBehindSiblings None
positionOnSiblings None
postEvent unsigned long, IEventParameter1&,
IEventParameter2&
refresh IRectangle&
releasePointer None
releasePresSpace IPresSpaceHandle&
resetActiveColor None
resetBackgroundColor None
resetBorderColor None
resetDisabledBackgroundColor None
resetDisabledForegroundColor None
resetFont None
resetForegroundColor None
resetHiliteBackgroundColor None
resetHiliteForegroundColor None
resetInactiveColor None
resetMinimumSize None
resetShadowColor None
resetSplitBarEdgeColor None
resetSplitBarMiddleColor None
sendEvent unsigned long, IEventParameter1&,
IEventParameter2&
setFocus None
setLayoutDistorted unsigned long, unsigned long
setSplitBarThickness SplitBarArea, unsigned long
setSplitWindowPercentage IWindow*, unsigned long
show Boolean
showSourceEmphasis Boolean
splitBarThickness SplitBarArea
splitWindowPercentage IWindow*
ΓòÉΓòÉΓòÉ <hidden> Events - ISplitCanvas ΓòÉΓòÉΓòÉ
Event Notification ID
commandEvent commandId
gotFocusEvent FOCUSTRUEID
inputDisabledEvent ENABLEFALSEID
inputEnabledEvent ENABLETRUEID
lostFocusEvent FOCUSFALSEID
systemCommandEvent systemCommandId
visibilityDisabledEvent VISIBLEFALSEID
visibilityEnabledEvent VISIBLETRUEID
ΓòÉΓòÉΓòÉ <hidden> General Settings - ISplitCanvas ΓòÉΓòÉΓòÉ
Name Sets the name of the part.
Default value: The name of the part
Orientation Sets the current orientation of the canvas.
Default value: Vertical
Subpart name Sets the name of the subpart (a part placed on a composite part).
Default value: The name of the part
ΓòÉΓòÉΓòÉ <hidden> Control Settings - ISplitCanvas ΓòÉΓòÉΓòÉ
Fly over short text Specifies the short text for the fly-over text control.
Default value: None
Fly over long text Specifies the long text for the fly-over text control.
Default value: None
Window id Sets the window identifier.
Default value: None
Help panel id Sets the help panel identifier for the part.
Default value: None
Enabled Enables the handler by default.
Default value: Selected
ΓòÉΓòÉΓòÉ <hidden> Styles Settings - ISplitCanvas ΓòÉΓòÉΓòÉ
defaultStyle() Resets the part to the original default style.
Default value: Selected
horizontal Creates a horizontal scroll bar. This style is ignored if it is
used with vertical.
A deck of child windows is arranged in the canvas horizontally in rows from
left to right. Decks of rows are arranged from top to bottom.
Default value: The default is off, and the Default radio button is selected.
vertical Creates a vertical scroll bar. This style is used if both it and
horizontal are specified.
A deck of child windows is arranged in the canvas vertically in columns from
top to bottom. Decks of columns are arranged from left to right.
Default value: The default is on, and the Default radio button is selected.
noSplitBars If specified, the split canvas has no split bars.
Default value: The default is off, and the Default radio button is selected.
clipChildren Excludes the area occupied by the children of the window when
drawing in the window. Child windows are always "clipped" to their parent
window. When a parent window is painted, the clipChildren style controls
whether the invalidated region of the parent window includes the area
occupied by its children, thus preventing a window from painting over its
child windows.
Default value: The Default radio button is selected.
clipSiblings Controls which sibling window is displayed on top when multiple
siblings are displayed. Sibling windows are windows that share the same
parent window. Assign the clipSiblings style to the sibling window that you
want displayed on top of the other siblings, in Z-order.
Default value: The Default radio button is selected.
clipToParent Allows a window to paint outside of its window boundary up to the
window boundary of its parent.
Default value: The Default radio button is selected.
saveBits Optimizes the painting of a window by saving the screen image of the
area under the window as a bitmap and then using the bitmap to redraw the
window, when necessary.
Default value: The Default radio button is selected.
synchPaint Synchronously repaints the window. Without this style, painting
only occurs if there are no other events waiting to be processed.
Default value: The Default radio button is selected.
visible Makes the window visible. In general, controls are constructed as
visible, and frame windows are constructed as invisible.
Default value: The default is on, and the Default radio button is selected.
ΓòÉΓòÉΓòÉ <hidden> Handlers Settings - ISplitCanvas ΓòÉΓòÉΓòÉ
Handler name Sets the name of the default handler.
Default value: None
Handler list Sets the name of the handler for the MLE control.
Default value: None
Add after Adds the new choice after the selected choice in the list. If no
choice is selected, the new choice is added after the first choice in the
list.
Default value: Highlighted
Add before Adds the new choice before the selected choice in the list. If no
choice is selected, the new choice is added before the first choice in the
list.
Default value: Not highlighted
Move Determines whether a part and its descendants can be moved to a new
location.
Default value: Not highlighted
Remove Removes one item from the part and returns the count of the number of
items that remain.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ <hidden> Color Settings - ISplitCanvas ΓòÉΓòÉΓòÉ
Color area Sets the color of the given area. Choices are as follows:
SplitBarEdgeColor
Sets the top and bottom edges of a horizontal split bar or the
left and right edges of a vertical split bar.
SplitBarMiddleColor
Sets the middle of the split bar.
Default value: Background is selected
Color selection Enables color selection by either color values or RGB values.
Select Colors or RGB. If you select Colors, you can set the Color values. If
you select RGB, you can set the RGB values.
Default value: Colors selected
Color values Sets the color value of the window area, or sets the passed
default if no color for the area has been set.
Default value: Dark gray
RGB values Sets the color values for the window area.
Default value: Not set
ΓòÉΓòÉΓòÉ <hidden> Size/Position Settings - ISplitCanvas ΓòÉΓòÉΓòÉ
X field Sets the X coordinate of the part.
Default value: The x coordinate of the part currently positioned on the
free-form surface
Y field Sets the Y coordinate of the point.
Default value: The y coordinate of the part currently positioned on the
free-form surface
Width Sets the width of the text.
Default value: None
Height Sets the height of the text.
Default value: None
Minimum size Determines the minimum size of the part.
Select Calculate at execution time or Set value here. If you select
Calculate at execution time, the minimum size is determined dynamically. If
you select Set value here, you can set the Minimum size Width and Height
fields to define a fixed minimum size.
Default value: Calculate at execution time is selected
Width Sets the minimum-allowable width, which is set by the user's class.
Default value: None (calculated at execution time)
Height Sets the minimum-allowable height, which is set by the user's class.
Default value: None (calculated at execution time)
ΓòÉΓòÉΓòÉ <hidden> Font Settings - ISplitCanvas ΓòÉΓòÉΓòÉ
Name Sets the name of the font.
Default value: System proportional
Point size Sets the point size of the font.
Default value: 10
Style Sets the style for the part.
Default value: None
Emphasis Gives the part emphasis. If a part is specified, the emphasis is
drawn around the part.
Default value: None
Edit Opens an edit field on a part or setting.
Default value: Highlighted
Default font Sets the current default font style.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ 3.44. IStaticText ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Events
Settings Pages
General
Control
Styles
Handlers
Color
Size/Position
Font
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IStaticText ΓòÉΓòÉΓòÉ
Title: IBM static text control
Class name: IStaticText
Base part: ITextControl
Part type: Visual part
Part file: vbbase.vbb
An IStaticText field part is a textual or graphical label. The user cannot
modify a static text field.
Use an IStaticText part to do the following:
Display status information to the user
Provide a label for a control
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - IStaticText ΓòÉΓòÉΓòÉ
When building with an IStaticText part, you can do the following:
Define a label for a control. Do this by entering the label you want in
the Text field on the IStaticText General settings page.
Customize the appearance of a label. Do this by selecting choices on the
IStaticText Color and Font settings pages. If you placed the IStaticText
part on an ISetCanvas part or on an IMultiCellCanvas part, the static
text part is dynamically expanded for font changes if more space is
required.
Provide instructions for a field. Do this by entering the instructions in
the Text field on the IStaticText General settings page. Select the
upper-left choice in the Alignment field and select the Word wrap choice
to extend instructions to multiple lines.
Display a block of color with no text. Do this by clearing the Text field
on the IStaticText General settings page and selecting a fill color on
the IStaticText Color settings page. Set the color by selecting the Fill
Color area choice and either selecting a choice from the Colors list or
specifying the RGB values you want.
Provide changing information, such as the date. Show the date as follows:
1. Add an IDate part to the free-form surface.
2. Press mouse button 2 on the IDate part and select the Tear-Off
Attribute choice.
3. Select the today attribute. A today IVBVariable is added to the
free-form surface and connected to the IDate part.
4. Connect the today variable asString attribute to the IStaticText
text attribute.
ΓòÉΓòÉΓòÉ <hidden> Attributes - IStaticText ΓòÉΓòÉΓòÉ
Attribute S E Data type
activeColor Γûá Γûá IColor
alignment Γûá Alignment
asDebugInfo IString
asString IString
autoDeleteObject Γûá Boolean
autoDestroyWindow Γûá Boolean
backgroundColor Γûá Γûá IColor
bidiSupported Boolean
borderColor Γûá Γûá IColor
characterSize ISize
clipboardHasTextFormat Boolean
defaultPushButton IWindowHandle
disabledBackgroundColor Γûá Γûá IColor
disabledForegroundColor Γûá Γûá IColor
displaySize ISize
enabled Γûá Γûá Boolean
enabledForNotification Γûá Boolean
fillBackground Γûá Γûá Boolean
fillColor Γûá Γûá IColor
focus Γûá Boolean
font Γûá Γûá IFont
foregroundColor Γûá Γûá IColor
frameWindow Boolean
group Γûá Boolean
halftone Γûá Γûá Boolean
handle IWindowHandle
hiliteBackgroundColor Γûá Γûá IColor
hiliteForegroundColor Γûá Γûá IColor
id Γûá unsigned long
inactiveColor Γûá Γûá IColor
isDigits Γûá
itemProvider Γûá IDMItemProvider*
layoutAdjustment IRectangle
limit Γûá Γûá unsigned long
menu
messageQueue IMessageQueueHandle
minimumSize Γûá ISize
nativeRect IRectangle
owner Γûá IWindow*
parent Γûá IWindow*
parentSize ISize
pointerCaptured Boolean
position Γûá Γûá IPoint
presSpace IPresSpaceHandle
rect Γûá IRectangle
shadowColor Γûá Γûá IColor
showing Boolean
size Γûá Γûá ISize
strikeout Γûá Γûá Boolean
tabStop Γûá Boolean
text Γûá Γûá IString
textLength Γûá unsigned long
underscore Γûá Γûá Boolean
valid Boolean
valueAsDouble Γûá Γûá
valueAsInt Γûá Γûá
valueAsUnsigned Γûá Γûá
visible Γûá Γûá Boolean
visibleRectangle IRectangle
ΓòÉΓòÉΓòÉ <hidden> Actions - IStaticText ΓòÉΓòÉΓòÉ
Action Parameters
applyBidiSettings BidiSettings&, Boolean, Boolean
capturePointer Boolean
convertToGUIStyle IBitFlag&, Boolean
disable None
disableFillBackground None
disableGroup None
disableHalftone None
disableNotification None
disableStrikeout None
disableTabStop None
disableUnderscore None
disableUpdate None
dispatchRemainingHandlers IEvent&, Boolean
enable Boolean
enableUpdate Boolean
handleException IException&, IEvent&
hide None
hideSourceEmphasis None
isLayoutDistorted unsigned long
matchForMnemonic unsigned short
notifyObservers INotificationEvent&
positionBehindSibling IWindowHandle&
positionBehindSiblings None
positionOnSiblings None
postEvent unsigned long, IEventParameter1&,
IEventParameter2&
refresh IRectangle&
releasePointer None
releasePresSpace IPresSpaceHandle&
resetActiveColor None
resetBackgroundColor None
resetBorderColor None
resetDisabledBackgroundColor None
resetDisabledForegroundColor None
resetFillColor None
resetFont None
resetForegroundColor None
resetHiliteBackgroundColor None
resetHiliteForegroundColor None
resetInactiveColor None
resetMinimumSize None
resetShadowColor None
sendEvent unsigned long, IEventParameter1&,
IEventParameter2&
setFocus None
setLayoutDistorted unsigned long, unsigned long
show Boolean
showSourceEmphasis Boolean
ΓòÉΓòÉΓòÉ <hidden> Events - IStaticText ΓòÉΓòÉΓòÉ
Event Notification ID
commandEvent commandId
gotFocusEvent FOCUSTRUEID
inputDisabledEvent ENABLEFALSEID
inputEnabledEvent ENABLETRUEID
lostFocusEvent FOCUSFALSEID
systemCommandEvent systemCommandId
visibilityDisabledEvent VISIBLEFALSEID
visibilityEnabledEvent VISIBLETRUEID
ΓòÉΓòÉΓòÉ <hidden> General Settings - IStaticText ΓòÉΓòÉΓòÉ
Subpart name Sets the name of the subpart (a part placed on a composite part).
Default value: The name of the part
Text Sets the text for the part.
Default value: The name of the part
Limit Sets the length (in bytes) of the longest text the part can hold.
Default value: 32
Alignment Changes the alignment of the part.
Default value: Upper left
Word wrap Enables word wrap of text around at the end of a line.
Default value: Not selected
ΓòÉΓòÉΓòÉ <hidden> Control Settings - IStaticText ΓòÉΓòÉΓòÉ
Fly over short text Specifies the short text for the fly-over text control.
Default value: None
Fly over long text Specifies the long text for the fly-over text control.
Default value: None
Window id Sets the window identifier.
Default value: None
Help panel id Sets the help panel identifier for the part.
Default value: None
Enabled Enables the handler by default.
Default value: Selected
ΓòÉΓòÉΓòÉ <hidden> Styles Settings - IStaticText ΓòÉΓòÉΓòÉ
defaultStyle() Resets the part to the original default style.
Default value: Selected
mnemonic Draws the next character with mnemonic emphasis if a mnemonic prefix
character is found.
Default value: The Default radio button is selected.
fillBackground Erases the background, using the currently set fill color
before drawing the text.
Default value: The default is on, and the Default radio button is selected.
halftone Draws the text in halftone color.
Default value: The default is off, and the Default radio button is selected.
underscore Draws the text with underscoring.
Default value: The default is off, and the Default radio button is selected.
group Identifies the control as being the first in a group. No other controls
in the group can have this style. Controls in the group must be siblings
that are constructed following the first control. The group can be cursored
and when the last control in the group is reached, the cursor returns the
first control in the group.
Default value: The default is off, and the Default radio button is selected.
tabStop Identifies the control as one to which the user can tab.
Default value: The default is off, and the Default radio button is selected.
clipChildren Excludes the area occupied by the children of the window when
drawing in the window. Child windows are always "clipped" to their parent
window. When a parent window is painted, the clipChildren style controls
whether the invalidated region of the parent window includes the area
occupied by its children, thus preventing a window from painting over its
child windows.
Default value: The Default radio button is selected.
clipSiblings Controls which sibling window is displayed on top when multiple
siblings are displayed. Sibling windows are windows that share the same
parent window. Assign the clipSiblings style to the sibling window that you
want displayed on top of the other siblings, in Z-order.
Default value: The Default radio button is selected.
clipToParent Allows a window to paint outside of its window boundary up to the
window boundary of its parent.
Default value: The Default radio button is selected.
saveBits Optimizes the painting of a window by saving the screen image of the
area under the window as a bitmap and then using the bitmap to redraw the
window, when necessary.
Default value: The Default radio button is selected.
synchPaint Synchronously repaints the window. Without this style, painting
only occurs if there are no other events waiting to be processed.
Default value: The Default radio button is selected.
visible Makes the window visible. In general, controls are constructed as
visible, and frame windows are constructed as invisible.
Default value: The default is on, and the Default radio button is selected.
ΓòÉΓòÉΓòÉ <hidden> Handlers Settings - IStaticText ΓòÉΓòÉΓòÉ
Handler name Sets the name of the default handler.
Default value: None
Handler list Sets the name of the handler for the MLE control.
Default value: None
Add after Adds the new choice after the selected choice in the list. If no
choice is selected, the new choice is added after the first choice in the
list.
Default value: Highlighted
Add before Adds the new choice before the selected choice in the list. If no
choice is selected, the new choice is added before the first choice in the
list.
Default value: Not highlighted
Move Determines whether a part and its descendants can be moved to a new
location.
Default value: Not highlighted
Remove Removes one item from the part and returns the count of the number of
items that remain.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ <hidden> Color Settings - IStaticText ΓòÉΓòÉΓòÉ
Color area Sets the color of the given area. Choices are as follows:
Foreground
Sets the color for foreground text
Background
Sets the color for background text that surrounds the part
Fill
Sets the color for the area of the part that is not occupied by
text
Default value: Foreground is selected
Color selection Enables color selection by either color values or RGB values.
Select Colors or RGB. If you select Colors, you can set the Color values. If
you select RGB, you can set the RGB values.
Default value: RGB selected
Color values Sets the color value of the window area, or sets the passed
default if no color for the area has been set.
Default value: None
RGB values Sets the color values for the static text.
Default value: Red=0, Green=0, Blue=170
ΓòÉΓòÉΓòÉ <hidden> Size/Position Settings - IStaticText ΓòÉΓòÉΓòÉ
X field Sets the X coordinate of the part.
Default value: The x coordinate of the part currently positioned on the
free-form surface
Y field Sets the Y coordinate of the point.
Default value: The y coordinate of the part currently positioned on the
free-form surface
Width Sets the width of the text.
Default value: None
Height Sets the height of the text.
Default value: None
Minimum size Determines the minimum size of the part.
Select Calculate at execution time or Set value here. If you select
Calculate at execution time, the minimum size is determined dynamically. If
you select Set value here, you can set the Minimum size Width and Height
fields to define a fixed minimum size.
Default value: Calculate at execution time is selected
Width Sets the minimum-allowable width, which is set by the user's class.
Default value: None (calculated at execution time)
Height Sets the minimum-allowable height, which is set by the user's class.
Default value: None (calculated at execution time)
ΓòÉΓòÉΓòÉ <hidden> Font Settings - IStaticText ΓòÉΓòÉΓòÉ
Name Sets the name of the font.
Default value: System proportional
Point size Sets the point size of the font.
Default value: 10
Style Sets the style for the part.
Default value: None
Emphasis Gives the part emphasis. If a part is specified, the emphasis is
drawn around the part.
Default value: None
Edit Opens an edit field on a part or setting.
Default value: Highlighted
Default font Sets the current default font style.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ 3.45. ITextSpinButton ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Events
Settings Pages
General
Control
Styles
Handlers
Color
Size/Position
Font
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - ITextSpinButton ΓòÉΓòÉΓòÉ
Title: IBM text spin-button control
Class name: ITextSpinButton
Base part: IBaseSpinButton
Part type: Visual part
Part file: vbbase.vbb
An ITextSpinButton part is a ring of text choices. One choice is visible at a
time.
The user can spin the ring upward or downward to select another choice.
Use an ITextSpinButton part to provide, in sequence, a ring of related but
mutually exclusive text choices. For example, use a spin button for a
selection list of the months of the year.
Alternatively, use an INumericSpinButton part for a ring of numeric choices.
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - ITextSpinButton ΓòÉΓòÉΓòÉ
When building with an ITextSpinButton part, you can do the following:
Define the initial string choices for the spin button. Do this by
entering the strings in the Contents field on the ITextSpinButton General
settings page.
Define a default selection for the spin button. Do this by entering one
of the strings from the Contents field in the Text field on the
ITextSpinButton General settings page.
Prevent the user from typing a choice. Do this by setting the Read only
field on the ITextSpinButton Styles settings page.
Make the spin button skip values to cycle faster when the user continues
to spin the button. Do this by setting the Fast spin field on the
ITextSpinButton Styles settings page.
Copy the selection from the spin button to a text field. Do this by
connecting the ITextSpinButton text attribute to the target text field.
ΓòÉΓòÉΓòÉ <hidden> Attributes - ITextSpinButton ΓòÉΓòÉΓòÉ
Attribute S E Data type
activeColor Γûá Γûá IColor
alignment Γûá Alignment
asDebugInfo IString
asString IString
autoDeleteObject Γûá Boolean
autoDestroyWindow Γûá Boolean
backgroundColor Γûá Γûá IColor
bidiSupported Boolean
border Boolean
borderColor Γûá Γûá IColor
characterSize ISize
defaultPushButton IWindowHandle
disabledBackgroundColor Γûá Γûá IColor
disabledForegroundColor Γûá Γûá IColor
enabled Γûá Γûá Boolean
enabledForNotification Γûá Boolean
fastSpinEnabled Γûá Boolean
focus Γûá Boolean
font Γûá Γûá IFont
foregroundColor Γûá Γûá IColor
frameWindow Boolean
group Γûá Boolean
handle IWindowHandle
hiliteBackgroundColor Γûá Γûá IColor
hiliteForegroundColor Γûá Γûá IColor
id Γûá unsigned long
inactiveColor Γûá Γûá IColor
isDigits Γûá
itemProvider Γûá IDMItemProvider*
layoutAdjustment IRectangle
limit Γûá unsigned long
master Boolean
menu
messageQueue IMessageQueueHandle
minimumSize Γûá ISize
nativeRect IRectangle
owner Γûá IWindow*
parent Γûá IWindow*
parentSize ISize
pointerCaptured Boolean
position Γûá Γûá IPoint
presSpace IPresSpaceHandle
rect Γûá IRectangle
servant Boolean
shadowColor Γûá Γûá IColor
showing Boolean
size Γûá Γûá ISize
spinFieldValid Boolean
tabStop Γûá Boolean
text Γûá Γûá IString
textLength Γûá
valid Boolean
valueAsDouble Γûá Γûá
valueAsInt Γûá Γûá
valueAsUnsigned Γûá Γûá
visible Γûá Γûá Boolean
visibleRectangle IRectangle
writeable Γûá Boolean
ΓòÉΓòÉΓòÉ <hidden> Actions - ITextSpinButton ΓòÉΓòÉΓòÉ
Action Parameters
add IResourceId&, unsigned long
addAsFirst IResourceId&
addAsLast IResourceId&
addBorder Boolean
applyBidiSettings BidiSettings&, Boolean, Boolean
capturePointer Boolean
convertToGUIStyle IBitFlag&, Boolean
disable None
disableDataUpdate None
disableFastSpin None
disableGroup None
disableNotification None
disableTabStop None
disableUpdate None
dispatchRemainingHandlers IEvent&, Boolean
elementAt unsigned long
enable Boolean
enableUpdate Boolean
handleException IException&, IEvent&
hide None
hideSourceEmphasis None
isLayoutDistorted unsigned long
matchForMnemonic unsigned short
notifyObservers INotificationEvent&
positionBehindSibling IWindowHandle&
positionBehindSiblings None
positionOnSiblings None
postEvent unsigned long, IEventParameter1&,
IEventParameter2&
refresh IRectangle&
releasePointer None
releasePresSpace IPresSpaceHandle&
removeAll None
removeBorder None
resetActiveColor None
resetBackgroundColor None
resetBorderColor None
resetDisabledBackgroundColor None
resetDisabledForegroundColor None
resetFont None
resetForegroundColor None
resetHiliteBackgroundColor None
resetHiliteForegroundColor None
resetInactiveColor None
resetMinimumSize None
resetShadowColor None
sendEvent unsigned long, IEventParameter1&,
IEventParameter2&
setFocus None
setLayoutDistorted unsigned long, unsigned long
setMaster IBaseSpinButton&
show Boolean
showSourceEmphasis Boolean
spinDown unsigned long
spinTo unsigned long
spinUp unsigned long
ΓòÉΓòÉΓòÉ <hidden> Events - ITextSpinButton ΓòÉΓòÉΓòÉ
Event Notification ID
commandEvent commandId
gotFocusEvent FOCUSTRUEID
inputDisabledEvent ENABLEFALSEID
inputEnabledEvent ENABLETRUEID
lostFocusEvent FOCUSFALSEID
systemCommandEvent systemCommandId
textEvent textId
valueEvent valueId
visibilityDisabledEvent VISIBLEFALSEID
visibilityEnabledEvent VISIBLETRUEID
ΓòÉΓòÉΓòÉ <hidden> General Settings - ITextSpinButton ΓòÉΓòÉΓòÉ
Subpart name Sets the name of the subpart (a part placed on a composite part).
Default value: The name of the part
Alignment Changes the text alignment of the part. Left aligns the text to the
left, Center centers the text, and Right aligns the text at the right.
Default value: Left
Text Sets the text for the part.
Default value: The name of the part
Contents Sets initial items for the part.
Default value: None
ΓòÉΓòÉΓòÉ <hidden> Control Settings - ITextSpinButton ΓòÉΓòÉΓòÉ
Fly over short text Specifies the short text for the fly-over text control.
Default value: None
Fly over long text Specifies the long text for the fly-over text control.
Default value: None
Window id Sets the window identifier.
Default value: None
Help panel id Sets the help panel identifier for the part.
Default value: None
Enabled Enables the handler by default.
Default value: Selected
ΓòÉΓòÉΓòÉ <hidden> Styles Settings - ITextSpinButton ΓòÉΓòÉΓòÉ
defaultStyle() Resets the part to the original default style.
Default value: Selected
readOnly Prevents entering input into the field.
Default value: The default is off, and the Default radio button is selected.
noBorder Suppresses the drawing of a border.
Default value: The Default radio button is selected.
Fast spin Increases the spin speed of the part.
Default value: Not selected
master Specifies that the spin button component consists of:
One or more single-line entry fields (SLE) or spin fields
Two arrows-the Up arrow and the Down arrow
When a spin button contains more than one spin field, the master component
contains the spin arrows. If the component contains only one spin field, it
must be the master.
Default value: The default is on, and the Default radio button is selected.
servant Allows the user to create a multiple-field spin button by spinning
servants from the master.
Default value: The default is off, and the Default radio button is selected.
group Identifies the control as being the first in a group. No other controls
in the group can have this style. Controls in the group must be siblings
that are constructed following the first control. The group can be cursored
and when the last control in the group is reached, the cursor returns the
first control in the group.
Default value: The default is off, and the Default radio button is selected.
tabStop Identifies the control as one to which the user can tab.
Default value: The default is off, and the Default radio button is selected.
clipChildren Excludes the area occupied by the children of the window when
drawing in the window. Child windows are always "clipped" to their parent
window. When a parent window is painted, the clipChildren style controls
whether the invalidated region of the parent window includes the area
occupied by its children, thus preventing a window from painting over its
child windows.
Default value: The Default radio button is selected.
clipSiblings Controls which sibling window is displayed on top when multiple
siblings are displayed. Sibling windows are windows that share the same
parent window. Assign the clipSiblings style to the sibling window that you
want displayed on top of the other siblings, in Z-order.
Default value: The Default radio button is selected.
clipToParent Allows a window to paint outside of its window boundary up to the
window boundary of its parent.
Default value: The Default radio button is selected.
saveBits Optimizes the painting of a window by saving the screen image of the
area under the window as a bitmap and then using the bitmap to redraw the
window, when necessary.
Default value: The Default radio button is selected.
synchPaint Synchronously repaints the window. Without this style, painting
only occurs if there are no other events waiting to be processed.
Default value: The Default radio button is selected.
visible Makes the window visible. In general, controls are constructed as
visible, and frame windows are constructed as invisible.
Default value: The default is on, and the Default radio button is selected.
ΓòÉΓòÉΓòÉ <hidden> Handlers Settings - ITextSpinButton ΓòÉΓòÉΓòÉ
Handler name Sets the name of the default handler.
Default value: None
Handler list Sets the name of the handler for the MLE control.
Default value: None
Add after Adds the new choice after the selected choice in the list. If no
choice is selected, the new choice is added after the first choice in the
list.
Default value: Highlighted
Add before Adds the new choice before the selected choice in the list. If no
choice is selected, the new choice is added before the first choice in the
list.
Default value: Not highlighted
Move Determines whether a part and its descendants can be moved to a new
location.
Default value: Not highlighted
Remove Removes one item from the part and returns the count of the number of
items that remain.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ <hidden> Color Settings - ITextSpinButton ΓòÉΓòÉΓòÉ
Color area Sets the color of the given area. Choices are as follows:
Foreground
Sets the color for foreground text
Background
Sets the color for background text
Disabled foreground
Sets the foreground color for disabled text
Border
Sets the color of the border that surrounds the part.
Default value: Foreground is selected
Color selection Enables color selection by either color values or RGB values.
Select Colors or RGB. If you select Colors, you can set the Color values. If
you select RGB, you can set the RGB values.
Default value: RGB selected
Color values Sets the color value of the window area, or sets the passed
default if no color for the area has been set.
Default value: None
RGB values Sets the color values for the window area.
Default value: Not set
ΓòÉΓòÉΓòÉ <hidden> Size/Position Settings - ITextSpinButton ΓòÉΓòÉΓòÉ
X field Sets the X coordinate of the part.
Default value: The x coordinate of the part currently positioned on the
free-form surface
Y field Sets the Y coordinate of the point.
Default value: The y coordinate of the part currently positioned on the
free-form surface
Width Sets the width of the text.
Default value: None
Height Sets the height of the text.
Default value: None
Minimum size Determines the minimum size of the part.
Select Calculate at execution time or Set value here. If you select
Calculate at execution time, the minimum size is determined dynamically. If
you select Set value here, you can set the Minimum size Width and Height
fields to define a fixed minimum size.
Default value: Calculate at execution time is selected
Width Sets the minimum-allowable width, which is set by the user's class.
Default value: None (calculated at execution time)
Height Sets the minimum-allowable height, which is set by the user's class.
Default value: None (calculated at execution time)
ΓòÉΓòÉΓòÉ <hidden> Font Settings - ITextSpinButton ΓòÉΓòÉΓòÉ
Name Sets the name of the font.
Default value: System proportional
Point size Sets the point size of the font.
Default value: 10
Style Sets the style for the part.
Default value: None
Emphasis Gives the part emphasis. If a part is specified, the emphasis is
drawn around the part.
Default value: None
Edit Opens an edit field on a part or setting.
Default value: Highlighted
Default font Sets the current default font style.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ 3.46. ITitle ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Events
Settings Pages
General
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - ITitle ΓòÉΓòÉΓòÉ
Title: IBM window-title text-control
Class name: ITitle
Base part: ITextControl
Part type: Nonvisual part
Part file: vbbase.vbb
An ITitle part is a frame window title control. The title can be changed after
the window is created.
The user can change the title if your application provides the capability
through other controls. Otherwise, the user can only observe title changes
made by your application.
Use an ITitle part to change a frame window title.
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - ITitle ΓòÉΓòÉΓòÉ
When building with an ITitle part, you can do the following:
Add a changeable title to a frame window. Do this by selecting an ITitle
part from the parts palette and dropping it on the free-form surface.
Identify the frame window that the title is related to. If you have only
one frame window in your view, the title is automatically related to that
frame window.
If you want the title for a second frame window in your view, do this by
referencing the frame window Subpart name, which appears on its General
settings page. Enter the frame window subpart name, prefixed with "i," in
the Owner field on the General settings page of the ITitle part.
Define an initial title. Do this by defining title fields on the ITitle
General settings page:
- Enter the object name or desired title in the Object text field.
- Optionally, enter the view name in the View text field.
- Optionally, enter the view number in the View number field.
Change the title when an event occurs. Do this as follows:
- Connect the event to the ITitle setTitleText action.
- Open settings for the connection, press the Set parameters push
button, and enter the title in the objectName parameter. You can
optionally specify viewName and viewNum parameters for the title.
Provide the title from one or more attributes of other parts. Do this as
follows:
- Connect a text attribute to the ITitle objectText attribute.
- Optionally, connect a text attribute to the ITitle viewName
attribute.
- Optionally, connect a numeric attribute to the ITitle viewNumber
attribute.
ΓòÉΓòÉΓòÉ <hidden> Attributes - ITitle ΓòÉΓòÉΓòÉ
Attribute S E Data type
activeColor Γûá Γûá IColor
activeTextBackgroundColor Γûá Γûá IColor
activeTextForegroundColor Γûá Γûá IColor
asDebugInfo IString
asString IString
autoDeleteObject Γûá Boolean
autoDestroyWindow Γûá Boolean
backgroundColor Γûá Γûá IColor
bidiSupported Boolean
borderColor Γûá Γûá IColor
characterSize ISize
clipboardHasTextFormat Boolean
defaultPushButton IWindowHandle
disabledBackgroundColor Γûá Γûá IColor
disabledForegroundColor Γûá Γûá IColor
displaySize ISize
enabled Γûá Γûá Boolean
enabledForNotification Γûá Boolean
focus Γûá Boolean
font Γûá Γûá IFont
foregroundColor Γûá Γûá IColor
frameWindow Boolean
group Γûá Boolean
handle IWindowHandle
hiliteBackgroundColor Γûá Γûá IColor
hiliteForegroundColor Γûá Γûá IColor
id Γûá unsigned long
inactiveColor Γûá Γûá IColor
inactiveTextBackgroundColor Γûá Γûá IColor
inactiveTextForegroundColor Γûá Γûá IColor
isDigits Γûá
itemProvider Γûá IDMItemProvider*
layoutAdjustment IRectangle
menu
messageQueue IMessageQueueHandle
minimumSize Γûá ISize
nativeRect IRectangle
objectText Γûá Γûá IString
owner Γûá IWindow*
parent Γûá IWindow*
parentSize ISize
pointerCaptured Boolean
position Γûá Γûá IPoint
presSpace IPresSpaceHandle
rect Γûá IRectangle
shadowColor Γûá Γûá IColor
showing Boolean
size Γûá Γûá ISize
tabStop Γûá Boolean
text Γûá Γûá IString
textLength Γûá unsigned long
valid Boolean
valueAsDouble Γûá Γûá
valueAsInt Γûá Γûá
valueAsUnsigned Γûá Γûá
viewNum Γûá unsigned long
viewNumber Γûá Γûá unsigned long
viewText Γûá Γûá IString
visible Γûá Γûá Boolean
visibleRectangle IRectangle
ΓòÉΓòÉΓòÉ <hidden> Actions - ITitle ΓòÉΓòÉΓòÉ
Action Parameters
applyBidiSettings BidiSettings&, Boolean, Boolean
capturePointer Boolean
convertToGUIStyle IBitFlag&, Boolean
disable None
disableGroup None
disableNotification None
disableTabStop None
disableUpdate None
dispatchRemainingHandlers IEvent&, Boolean
enable Boolean
enableUpdate Boolean
handleException IException&, IEvent&
hide None
hideSourceEmphasis None
isLayoutDistorted unsigned long
matchForMnemonic unsigned short
notifyObservers INotificationEvent&
positionBehindSibling IWindowHandle&
positionBehindSiblings None
positionOnSiblings None
postEvent unsigned long, IEventParameter1&,
IEventParameter2&
refresh IRectangle&
releasePointer None
releasePresSpace IPresSpaceHandle&
resetActiveColor None
resetActiveTextBackgroundColor None
resetActiveTextForegroundColor None
resetBackgroundColor None
resetBorderColor None
resetDisabledBackgroundColor None
resetDisabledForegroundColor None
resetFont None
resetForegroundColor None
resetHiliteBackgroundColor None
resetHiliteForegroundColor None
resetInactiveColor None
resetInactiveTextBackgroundColor None
resetInactiveTextForegroundColor None
resetMinimumSize None
resetShadowColor None
sendEvent unsigned long, IEventParameter1&,
IEventParameter2&
setFocus None
setLayoutDistorted unsigned long, unsigned long
setTitleText char*, char*, unsigned long
show Boolean
showSourceEmphasis Boolean
ΓòÉΓòÉΓòÉ <hidden> Events - ITitle ΓòÉΓòÉΓòÉ
Event Notification ID
commandEvent commandId
gotFocusEvent FOCUSTRUEID
inputDisabledEvent ENABLEFALSEID
inputEnabledEvent ENABLETRUEID
lostFocusEvent FOCUSFALSEID
systemCommandEvent systemCommandId
visibilityDisabledEvent VISIBLEFALSEID
visibilityEnabledEvent VISIBLETRUEID
ΓòÉΓòÉΓòÉ <hidden> General Settings - ITitle ΓòÉΓòÉΓòÉ
Subpart name Sets the name of the subpart (a part placed on a composite part).
Default value: The name of the part
Owner Sets the window's owner.
Default value: None
Object text Sets the initial title text.
Default value: None
View text Sets the name of the view for the title bar.
Default value: None
View number Sets the number of the view for the title bar.
Default value: None
ΓòÉΓòÉΓòÉ 3.47. IToolBar ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Events
Settings Pages
General
Control
Styles
Handlers
Color
Size/Position
Font
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IToolBar ΓòÉΓòÉΓòÉ
Title: IBM tool-bar control
Class name: IToolBar
Base part: ISetCanvas
Part type: Visual part
Part file: vbbase.vbb
An IToolBar part is a set of tool function buttons. The tool bar is initially
located adjacent to the client area of the frame window it is related to.
The user can click the tool bar buttons to perform the tool functions. The
user can also drag the tool bar away from the frame window.
Use an IToolBar part to give the user a set of tool functions.
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - IToolBar ΓòÉΓòÉΓòÉ
When building with an IToolBar part, you can do the following:
Add a tool bar to a frame window. Do this by selecting an IToolBar part
from the parts palette and dropping it on the frame window. The tool bar
is placed in a frame extension at the top of the client area. One
IToolBarButton part is automatically placed on the tool bar.
Group a second tool bar with one previously added to the frame window. Do
this by selecting the Group with preceding tool bar field on the General
settings page of the second IToolBar part. The tool bar is moved to the
same row or column as the first tool bar and placed after the first tool
bar.
Change the location of the tool bar. Do this by selecting a location
choice from the Location field on the IToolBar General settings page. If
the tool bar is placed above or below the client area, its orientation is
horizontal. If it is placed to the left or right of the client area, its
orientation is vertical.
Hide the tool bar. Do this by selecting the Hidden choice from the
Location field on the IToolBar General settings page.
Define title bar text to be displayed with the tool bar when the user
drags it away from the frame window. Do this by entering text in the
Floating title field on the IToolBar General settings page.
ΓòÉΓòÉΓòÉ <hidden> Attributes - IToolBar ΓòÉΓòÉΓòÉ
Attribute S E Data type
activeColor Γûá Γûá IColor
alignment Γûá Alignment
allowsDragDrop Boolean
asDebugInfo IString
asString IString
autoDeleteObject Γûá Boolean
autoDestroyWindow Γûá Boolean
backgroundColor Γûá Γûá IColor
bidiSupported Boolean
borderColor Γûá Γûá IColor
buttonView Γûá IToolBarButton::View
characterSize ISize
deckCount Γûá unsigned long
deckOrientation Γûá Γûá DeckOrientation
defaultGroupPad Γûá unsigned long
defaultMargin Γûá ISize
defaultMisfitWidth Γûá unsigned long
defaultPad Γûá long
defaultPushButton IWindowHandle
disabledBackgroundColor Γûá Γûá IColor
disabledForegroundColor Γûá Γûá IColor
enabled Γûá Γûá Boolean
enabledForNotification Γûá Boolean
expanded Boolean
floatingFrame IToolBarFrameWindow*
floatingPosition Γûá IPoint
floatingTitle Γûá IString
focus Γûá Boolean
font Γûá Γûá IFont
foregroundColor Γûá Γûá IColor
frameWindow Boolean
group Γûá Boolean
groupPad Γûá unsigned long
handle IWindowHandle
hiliteBackgroundColor Γûá Γûá IColor
hiliteForegroundColor Γûá Γûá IColor
id Γûá unsigned long
inactiveColor Γûá Γûá IColor
itemProvider Γûá IDMItemProvider*
layoutAdjustment IRectangle
location Γûá Location
margin Γûá ISize
menu
messageQueue IMessageQueueHandle
minimumSize Γûá ISize
misfitFilteringEnabled Γûá Boolean
nativeRect IRectangle
origDefaultButtonHandle IWindowHandle
owner Γûá IWindow*
packType Γûá PackType
pad Γûá ISize
parent Γûá IWindow*
parentSize ISize
pointerCaptured Boolean
position Γûá Γûá IPoint
presSpace IPresSpaceHandle
rect Γûá IRectangle
shadowColor Γûá Γûá IColor
showing Boolean
size Γûá Γûá ISize
tabStop Γûá Boolean
text Γûá Γûá IString
toolBarContainer IToolBarContainer*
valid Boolean
visible Γûá Γûá Boolean
visibleRectangle IRectangle
ΓòÉΓòÉΓòÉ <hidden> Actions - IToolBar ΓòÉΓòÉΓòÉ
Action Parameters
addAsFirst IWindow*, Boolean
addAsLast IWindow*, Boolean
addAsNext IWindow*, IWindow*, Boolean
addAsPrevious IWindow*, IWindow*, Boolean
applyBidiSettings BidiSettings&, Boolean, Boolean
capturePointer Boolean
collapse None
convertToGUIStyle IBitFlag&, Boolean
disable None
disableDragDrop None
disableGroup None
disableMisfitFiltering None
disableNotification None
disableTabStop None
disableUpdate None
dispatchRemainingHandlers IEvent&, Boolean
enable Boolean
enableDragDrop Boolean
enableUpdate Boolean
expand Boolean
handleException IException&, IEvent&
hide None
hideSourceEmphasis None
isLayoutDistorted unsigned long
matchForMnemonic unsigned short
moveAfter IWindow*, IWindow*, Boolean
moveBefore IWindow*, IWindow*, Boolean
moveToFirst IWindow*, Boolean
moveToLast IWindow*, Boolean
notifyObservers INotificationEvent&
positionBehindSibling IWindowHandle&
positionBehindSiblings None
positionOnSiblings None
postEvent unsigned long, IEventParameter1&,
IEventParameter2&
refresh IRectangle&
releasePointer None
releasePresSpace IPresSpaceHandle&
remove IWindow*
resetActiveColor None
resetBackgroundColor None
resetBorderColor None
resetDisabledBackgroundColor None
resetDisabledForegroundColor None
resetFont None
resetForegroundColor None
resetHiliteBackgroundColor None
resetHiliteForegroundColor None
resetInactiveColor None
resetMinimumSize None
resetShadowColor None
sendEvent unsigned long, IEventParameter1&,
IEventParameter2&
setFocus None
setLayoutDistorted unsigned long, unsigned long
show Boolean
showSourceEmphasis Boolean
ΓòÉΓòÉΓòÉ <hidden> Events - IToolBar ΓòÉΓòÉΓòÉ
Event Notification ID
commandEvent commandId
gotFocusEvent FOCUSTRUEID
inputDisabledEvent ENABLEFALSEID
inputEnabledEvent ENABLETRUEID
lostFocusEvent FOCUSFALSEID
systemCommandEvent systemCommandId
visibilityDisabledEvent VISIBLEFALSEID
visibilityEnabledEvent VISIBLETRUEID
ΓòÉΓòÉΓòÉ <hidden> General Settings - IToolBar ΓòÉΓòÉΓòÉ
Subpart name Sets the name of the subpart (a part placed on a composite part).
Default value: The name of the part
Floating title Sets the title text of the floating frame window.
Default value: None
Group with preceding tool bar Specifies that the tool bar should be grouped
with the preceding tool bar.
Default value: Not selected
Location Sets the location of the tool bar.
Default value: The first item in the list is selected.
ΓòÉΓòÉΓòÉ <hidden> Control Settings - IToolBar ΓòÉΓòÉΓòÉ
Fly over short text Specifies the short text for the fly-over text control.
Default value: None
Fly over long text Specifies the long text for the fly-over text control.
Default value: None
Window id Sets the window identifier.
Default value: None
Help panel id Sets the help panel identifier for the part.
Default value: None
Enabled Enables the handler by default.
Default value: Selected
ΓòÉΓòÉΓòÉ <hidden> Styles Settings - IToolBar ΓòÉΓòÉΓòÉ
defaultStyle() Resets the part to the original default style.
Default value: Selected
buttonBitmapVisible Sets the the style so that the bitmap is displayed.
Default value: The Default radio button is selected.
buttonTextVisible Sets the the style so that text is displayed.
Default value: The Default radio button is selected.
buttonBitTextVisible Sets the the style so that both the bitmap and text are
displayed.
Default value: The Default radio button is selected.
noDragDrop Disables the dragging of a tool bar, the objects that reside within
the tool bar (such as a tool bar button), and drops on the tool bar buttons.
Default value: The Default radio button is selected.
clipChildren Excludes the area occupied by the children of the window when
drawing in the window. Child windows are always "clipped" to their parent
window. When a parent window is painted, the clipChildren style controls
whether the invalidated region of the parent window includes the area
occupied by its children, thus preventing a window from painting over its
child windows.
Default value: The Default radio button is selected.
clipSiblings Controls which sibling window is displayed on top when multiple
siblings are displayed. Sibling windows are windows that share the same
parent window. Assign the clipSiblings style to the sibling window that you
want displayed on top of the other siblings, in Z-order.
Default value: The Default radio button is selected.
clipToParent Allows a window to paint outside of its window boundary up to the
window boundary of its parent.
Default value: The Default radio button is selected.
saveBits Optimizes the painting of a window by saving the screen image of the
area under the window as a bitmap and then using the bitmap to redraw the
window, when necessary.
Default value: The Default radio button is selected.
synchPaint Synchronously repaints the window. Without this style, painting
only occurs if there are no other events waiting to be processed.
Default value: The Default radio button is selected.
visible Makes the window visible. In general, controls are constructed as
visible, and frame windows are constructed as invisible.
Default value: The default is on, and the Default radio button is selected.
filterMisfits Sets the style so that misfits are filtered in or out based on
the orientation of the tool bar and the current tool bar style.
Default value: The Default radio button is selected.
ΓòÉΓòÉΓòÉ <hidden> Handlers Settings - IToolBar ΓòÉΓòÉΓòÉ
Handler name Sets the name of the default handler.
Default value: None
Handler list Sets the name of the handler for the MLE control.
Default value: None
Add after Adds the new choice after the selected choice in the list. If no
choice is selected, the new choice is added after the first choice in the
list.
Default value: Highlighted
Add before Adds the new choice before the selected choice in the list. If no
choice is selected, the new choice is added before the first choice in the
list.
Default value: Not highlighted
Move Determines whether a part and its descendants can be moved to a new
location.
Default value: Not highlighted
Remove Removes one item from the part and returns the count of the number of
items that remain.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ <hidden> Color Settings - IToolBar ΓòÉΓòÉΓòÉ
Color area Sets the color of the given area. Choices are as follows:
Background
Sets the color for background text
Default value: Background is selected
Color selection Enables color selection by either color values or RGB values.
Select Colors or RGB. If you select Colors, you can set the Color values. If
you select RGB, you can set the RGB values.
Default value: Colors selected
Color values Sets the color value of the window area, or sets the passed
default if no color for the area has been set.
Default value: None
RGB values Sets the color values for the canvas.
Default value: Red=255, Green=255, Blue=255
ΓòÉΓòÉΓòÉ <hidden> Size/Position Settings - IToolBar ΓòÉΓòÉΓòÉ
X field Sets the X coordinate of the part.
Default value: The x coordinate of the part currently positioned on the
free-form surface
Y field Sets the Y coordinate of the point.
Default value: The y coordinate of the part currently positioned on the
free-form surface
Width Sets the width of the text.
Default value: None
Height Sets the height of the text.
Default value: None
Minimum size Determines the minimum size of the part.
Select Calculate at execution time or Set value here. If you select
Calculate at execution time, the minimum size is determined dynamically. If
you select Set value here, you can set the Minimum size Width and Height
fields to define a fixed minimum size.
Default value: Calculate at execution time is selected
Width Sets the minimum-allowable width, which is set by the user's class.
Default value: None (calculated at execution time)
Height Sets the minimum-allowable height, which is set by the user's class.
Default value: None (calculated at execution time)
ΓòÉΓòÉΓòÉ <hidden> Font Settings - IToolBar ΓòÉΓòÉΓòÉ
Name Sets the name of the font.
Default value: System proportional
Point size Sets the point size of the font.
Default value: 10
Style Sets the style for the part.
Default value: None
Emphasis Gives the part emphasis. If a part is specified, the emphasis is
drawn around the part.
Default value: None
Edit Opens an edit field on a part or setting.
Default value: Highlighted
Default font Sets the current default font style.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ 3.48. IToolBarButton ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Events
Settings Pages
General
Control
Styles
Handlers
Color
Size/Position
Font
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IToolBarButton ΓòÉΓòÉΓòÉ
Title: IBM tool-bar button control
Class name: IToolBarButton
Base part: ICustomButton
Part type: Visual part
Part file: vbbase.vbb
An IToolBarButton part is a selection button for a tool bar function. The
choice is identified by a graphic on the tool bar button.
The user can click the tool bar button to perform the indicated function.
Use an IToolBarButton part to give the user a function choice for a tool bar.
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - IToolBarButton ΓòÉΓòÉΓòÉ
When building with an IToolBarButton part, you can do the following:
Use a predefined button. Do this by setting the Select from type list
field and selecting a button identifier from the Type list field for
Predefined button types on the IToolBarButton General settings page. A
predefined bitmap is placed on the button.
Assign a bitmap to the tool bar button. Do this by entering a DLL name
and a Resource ID for the Bitmap field on the IToolBarButton General
settings page.
Give the button the appearance of remaining latched down while it is
active. Do this by setting the latchable field on the IToolBarButton
Styles settings page.
Allow the user to reach the button by using a tab key. Do this by setting
the tabStop field to On on the IToolBarButton Styles settings page.
If the button is the first control in a group, allow the user to use
cursor keys to move between the button and follow controls in the group.
Do this by setting the group field to On on the IToolBarButton Styles
settings page. This field is initially set for the tool bar button
automatically placed on an IToolBar part when it is added to a frame
window.
Start the action represented by the button. Do this by connecting the
IToolBarButton buttonClickEvent feature to the action on the target part.
Enable or disable the tool bar button when an event occurs.
Enable the button as follows:
1. Connect the event to the IToolBarButton enable action.
2. The button is enabled by default. If you have changed this default,
open settings for the connection, press the Set parameters push
button, and check the Enabled setting.
Disable the button by connecting the event to the IToolBarButton disable
action.
ΓòÉΓòÉΓòÉ <hidden> Attributes - IToolBarButton ΓòÉΓòÉΓòÉ
Attribute S E Data type
activeColor Γûá Γûá IColor
allowsDragDelete Boolean
allowsMouseClickFocus Γûá Boolean
asDebugInfo IString
asString IString
autoDeleteObject Γûá Boolean
autoDestroyWindow Γûá Boolean
autoLatchEnabled Γûá Boolean
backgroundColor Γûá Γûá IColor
bidiSupported Boolean
bitmap Γûá IBitmapHandle
bitmapSize ISize
bitmapVisible Boolean
borderColor Γûá Γûá IColor
characterSize ISize
clipboardHasTextFormat Boolean
defaultPushButton IWindowHandle
defaultTransparentColor Γûá IColor
defaultTransparentColorSet Boolean
disabledBackgroundColor Γûá Γûá IColor
disabledForegroundColor Γûá Γûá IColor
displaySize ISize
enabled Γûá Γûá Boolean
enabledForNotification Γûá Boolean
focus Γûá Boolean
font Γûá Γûá IFont
foregroundColor Γûá Γûá IColor
frameWindow Boolean
group Γûá Boolean
handle IWindowHandle
hasTransparentColor Boolean
highlighted Boolean
hiliteBackgroundColor Γûá Γûá IColor
hiliteForegroundColor Γûá Γûá IColor
id Γûá unsigned long
inactiveColor Γûá Γûá IColor
isDigits Γûá
itemProvider Γûá IDMItemProvider*
latched Γûá Γûá Boolean
latchedBackgroundColor Γûá IColor
latchedBackgroundColorHalftone Boolean
latchedBitmap Γûá IBitmapHandle
latchedForegroundColor Γûá IColor
latchingEnabled Γûá Boolean
layoutAdjustment IRectangle
menu
messageQueue IMessageQueueHandle
minimumSize Γûá ISize
nativeRect IRectangle
owner Γûá IWindow*
parent Γûá IWindow*
parentSize ISize
pointerCaptured Boolean
position Γûá Γûá IPoint
presSpace IPresSpaceHandle
rect Γûá IRectangle
shadowColor Γûá Γûá IColor
showing Boolean
size Γûá Γûá ISize
standardBitmapSize Γûá ISize
standardFormat Boolean
standardTextLines Γûá unsigned long
standardTextWidth Γûá unsigned long
tabStop Γûá Boolean
text Γûá Γûá IString
textLength Γûá unsigned long
textVisible Boolean
transparentColor Γûá IColor
userData Γûá unsigned long
valid Boolean
valueAsDouble Γûá Γûá
valueAsInt Γûá Γûá
valueAsUnsigned Γûá Γûá
view Γûá View
visible Γûá Γûá Boolean
visibleRectangle IRectangle
ΓòÉΓòÉΓòÉ <hidden> Actions - IToolBarButton ΓòÉΓòÉΓòÉ
Action Parameters
applyBidiSettings BidiSettings&, Boolean, Boolean
capturePointer Boolean
clearDefaultTransparentColor None
click None
convertToGUIStyle IBitFlag&, Boolean
disable None
disableAutoLatch None
disableDragDelete None
disableGroup None
disableLatching None
disableMouseClickFocus None
disableNotification None
disableTabStop None
disableUpdate None
dispatchRemainingHandlers IEvent&, Boolean
enable Boolean
enableDragDelete Boolean
enableUpdate Boolean
handleException IException&, IEvent&
hide None
hideSourceEmphasis None
highlight Boolean
isLayoutDistorted unsigned long
matchForMnemonic unsigned short
notifyObservers INotificationEvent&
positionBehindSibling IWindowHandle&
positionBehindSiblings None
positionOnSiblings None
postEvent unsigned long, IEventParameter1&,
IEventParameter2&
refresh IRectangle&
releasePointer None
releasePresSpace IPresSpaceHandle&
resetActiveColor None
resetBackgroundColor None
resetBorderColor None
resetDisabledBackgroundColor None
resetDisabledForegroundColor None
resetFont None
resetForegroundColor None
resetHiliteBackgroundColor None
resetHiliteForegroundColor None
resetInactiveColor None
resetLatchedBackgroundColor None
resetLatchedForegroundColor None
resetMinimumSize None
resetShadowColor None
resetTransparentColor None
sendEvent unsigned long, IEventParameter1&,
IEventParameter2&
setFocus None
setLayoutDistorted unsigned long, unsigned long
show Boolean
showSourceEmphasis Boolean
unhighlight None
unlatch None
ΓòÉΓòÉΓòÉ <hidden> Events - IToolBarButton ΓòÉΓòÉΓòÉ
Event Notification ID
buttonClickEvent buttonClickId
commandEvent commandId
gotFocusEvent FOCUSTRUEID
inputDisabledEvent ENABLEFALSEID
inputEnabledEvent ENABLETRUEID
lostFocusEvent FOCUSFALSEID
systemCommandEvent systemCommandId
visibilityDisabledEvent VISIBLEFALSEID
visibilityEnabledEvent VISIBLETRUEID
ΓòÉΓòÉΓòÉ <hidden> General Settings - IToolBarButton ΓòÉΓòÉΓòÉ
Subpart name Sets the name of the subpart (a part placed on a composite part).
Default value: The name of the part
Text Sets the text for the part.
Default value: The name of the part
Latched Sets the part to the latched state.
Default value: Not selected
DLL name Specifies the name of the resource .dll that contains the bitmap.
Default value: None
Resource ID Specifies the resource identifier of the bitmap.
Default value: None
Type list Lists the available predefined actions that you can associate with
the button when it is in the latched state.
Default value: No choice is selected.
Select from type list Enables the Type list so you can select and associate an
available predefined action with the button when it is in the latched state.
Default value: No choice is selected.
ΓòÉΓòÉΓòÉ <hidden> Control Settings - IToolBarButton ΓòÉΓòÉΓòÉ
Fly over short text Specifies the short text for the fly-over text control.
Default value: None
Fly over long text Specifies the long text for the fly-over text control.
Default value: None
Help panel id Sets the help panel identifier for the part.
Default value: None
Enabled Enables the handler by default.
Default value: Selected
ΓòÉΓòÉΓòÉ <hidden> Styles Settings - IToolBarButton ΓòÉΓòÉΓòÉ
defaultStyle() Resets the part to the original default style.
Default value: Selected
latchable Sets the default style to the latchable state.
Default value: The Default radio button is selected.
autoLatch Sets the default style for the part the automatic latch state.
Default value: The Default radio button is selected.
noPointerFocus Allows the cursor stay on a control for which information is
required, rather than moving to the button. Buttons with this style do not
set the focus to themselves when the user clicks on them using the mouse.
This has no effect on keyboard interaction.
Default value: The Default radio button is selected.
group Identifies the control as being the first in a group. No other controls
in the group can have this style. Controls in the group must be siblings
that are constructed following the first control. The group can be cursored
and when the last control in the group is reached, the cursor returns the
first control in the group.
Default value: The default is off, and the Default radio button is selected.
tabStop Identifies the control as one to which the user can tab.
Default value: The default is off, and the Default radio button is selected.
clipChildren Excludes the area occupied by the children of the window when
drawing in the window. Child windows are always "clipped" to their parent
window. When a parent window is painted, the clipChildren style controls
whether the invalidated region of the parent window includes the area
occupied by its children, thus preventing a window from painting over its
child windows.
Default value: The Default radio button is selected.
clipSiblings Controls which sibling window is displayed on top when multiple
siblings are displayed. Sibling windows are windows that share the same
parent window. Assign the clipSiblings style to the sibling window that you
want displayed on top of the other siblings, in Z-order.
Default value: The Default radio button is selected.
clipToParent Allows a window to paint outside of its window boundary up to the
window boundary of its parent.
Default value: The Default radio button is selected.
saveBits Optimizes the painting of a window by saving the screen image of the
area under the window as a bitmap and then using the bitmap to redraw the
window, when necessary.
Default value: The Default radio button is selected.
synchPaint Synchronously repaints the window. Without this style, painting
only occurs if there are no other events waiting to be processed.
Default value: The Default radio button is selected.
visible Makes the window visible. In general, controls are constructed as
visible, and frame windows are constructed as invisible.
Default value: The default is on, and the Default radio button is selected.
ΓòÉΓòÉΓòÉ <hidden> Handlers Settings - IToolBarButton ΓòÉΓòÉΓòÉ
Handler name Sets the name of the default handler.
Default value: None
Handler list Sets the name of the handler for the MLE control.
Default value: None
Add after Adds the new choice after the selected choice in the list. If no
choice is selected, the new choice is added after the first choice in the
list.
Default value: Highlighted
Add before Adds the new choice before the selected choice in the list. If no
choice is selected, the new choice is added before the first choice in the
list.
Default value: Not highlighted
Move Determines whether a part and its descendants can be moved to a new
location.
Default value: Not highlighted
Remove Removes one item from the part and returns the count of the number of
items that remain.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ <hidden> Color Settings - IToolBarButton ΓòÉΓòÉΓòÉ
Color area Sets the color of the given area. Choices are as follows:
Foreground
Sets the color for foreground text
Background
Sets the color for background text
Latched foreground
Sets the foreground color for latched text
Latched background
Sets the background color for latched text
Default value: Foreground is selected
Color selection Enables color selection by either color values or RGB values.
Select Colors or RGB. If you select Colors, you can set the Color values. If
you select RGB, you can set the RGB values.
Default value: RGB selected
Color values Sets the color value of the window area, or sets the passed
default if no color for the area has been set.
Default value: None
RGB values Sets the color values for the window area.
Default value: Not set
ΓòÉΓòÉΓòÉ <hidden> Size/Position Settings - IToolBarButton ΓòÉΓòÉΓòÉ
X field Sets the X coordinate of the part.
Default value: The x coordinate of the part currently positioned on the
free-form surface
Y field Sets the Y coordinate of the point.
Default value: The y coordinate of the part currently positioned on the
free-form surface
Width Sets the width of the text.
Default value: None
Height Sets the height of the text.
Default value: None
Minimum size Determines the minimum size of the part.
Select Calculate at execution time or Set value here. If you select
Calculate at execution time, the minimum size is determined dynamically. If
you select Set value here, you can set the Minimum size Width and Height
fields to define a fixed minimum size.
Default value: Calculate at execution time is selected
Width Sets the minimum-allowable width, which is set by the user's class.
Default value: None (calculated at execution time)
Height Sets the minimum-allowable height, which is set by the user's class.
Default value: None (calculated at execution time)
ΓòÉΓòÉΓòÉ <hidden> Font Settings - IToolBarButton ΓòÉΓòÉΓòÉ
Name Sets the name of the font.
Default value: System proportional
Point size Sets the point size of the font.
Default value: 10
Style Sets the style for the part.
Default value: None
Emphasis Gives the part emphasis. If a part is specified, the emphasis is
drawn around the part.
Default value: None
Edit Opens an edit field on a part or setting.
Default value: Highlighted
Default font Sets the current default font style.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ 3.49. IVBContainerControl ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Events
Settings Pages
General
Control
Styles
Handlers
Size/Position
Font
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IVBContainerControl ΓòÉΓòÉΓòÉ
Title: IVBContainerControl
Class name: IVBContainerControl
Base part: IContainerControl
Part type: Visual part
Part file: vbbase.vbb
An IVBContainerControl part is a window that can contain nonwindow user
interface objects. File objects and program objects are common examples of
objects managed in containers.
The user can open a container in one of the following views to work with the
objects in the container:
View Description
Text and flowed text Lists text representations of objects in a single column.
The text view lists objects in a single column. The flowed
text view lists them in multiple columns.
Name and flowed name Lists text representations of objects, with a small icon
of the object preceding the text. The name view lists
objects in a single column. The flowed name view lists
them in multiple columns.
Icon Represents objects as icons, which can be freely
positioned or arranged in rows within the container.
Tree (text, name, and icon) Represents objects hierarchically. Objects capable
of containing nested objects branch from the root of the
container. The text, name, and icon tree views represent
objects as their corresponding nontree views do.
The user can expand tree branches to view nested objects.
The tree views are often used for folder hierarchies.
Details Provides detailed information about each object in the
container. The information is presented as a table, with a
row for each object and a column for each represented
object attribute.
Use an IVBContainerControl part to let the user work with a set of objects
collected in the container. Containers are useful for presenting collections
of nonvisual model objects.
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - IVBContainerControl ΓòÉΓòÉΓòÉ
When building with an IVBContainerControl part, you can do the following:
Define a title for the container. Do this by setting the Title attributes
fields on the IVBContainerControl General settings page. Enter the title
you want in the Title field and check the Show title setting. If you want
a separator below the title, check the Show title separator setting.
Select the alignment you want in the Alignment field.
Specify objects that the container can hold. Do this by setting the
Container item attributes fields on the IVBContainerControl General
settings page:.
- Designate the object type in the Item type field.
- Select text representation of objects from choices in the Text
field. If you use the asString choice for the Text field, consider
whether you want the default asString result for the object type or
need to provide an asString override function to produce more
meaningful text.
- Specify object icons in the Icon field.
Set the initial view for the container. Do this by selecting a view from
the View type field on the IVBContainerControl General settings page.
Automatically position object icons when objects are added to the
container. Do this by setting the autoPosition field on the
IVBContainerControl Styles settings page:
Define the types of selection to be supported for the container. Do this
by setting one or more selection fields to On on the IVBContainerControl
Styles settings page:
- extendedSelection
- multipleSelection
- singleSelection
Add a pop-up menu for the container and objects it contains. Do this by
selecting an IMenu part from the parts palette and dropping it on the
free-form surface. Then, connect the IMenu this attribute to the
IVBContainerControl menu attribute.
Load the container with a set of objects. Do this by connecting the this
attribute of a collection part containing the choices to the
IVBContainerControl items attribute. A collection part that has one
template argument, such as an IVSequence part, must be used.
Perform an action when the user double-clicks a container object. Do this
by connecting the IVBContainerControl selectDefaultActionEvent feature to
the target action.
ΓòÉΓòÉΓòÉ <hidden> Attributes - IVBContainerControl ΓòÉΓòÉΓòÉ
Attribute S E Data type
activeColor Γûá Γûá IColor
areDetailsViewTitlesVisible Γûá Boolean
asDebugInfo IString
asString IString
autoDeleteObject Γûá Boolean
autoDestroyWindow Γûá Boolean
backgroundColor Γûá Γûá IColor
bidiSupported Boolean
borderColor Γûá Γûá IColor
cachingEnabled Γûá Boolean
characterSize ISize
columnCount unsigned long
currentEditColumn IContainerColumn*
currentEditMLE IMultiLineEdit*
currentEditObject IContainerObject*
cursoredObject IContainerObject*
defaultPushButton IWindowHandle
detailsTitleRectangle IRectangle
detailsView Boolean
detailsViewPortOnWindow IRectangle
detailsViewPortOnWorkspace IRectangle
detailsViewSplit Γûá IContainerColumn*
disabledBackgroundColor Γûá Γûá IColor
disabledForegroundColor Γûá Γûá IColor
drawBackgroundEnabled Γûá Boolean
drawItemEnabled Γûá Boolean
enabled Γûá Γûá Boolean
enabledForNotification Γûá Boolean
extendedSelection Boolean
flowed Boolean
flowedNameView Boolean
flowedTextView Boolean
focus Γûá Boolean
font Γûá Γûá IFont
foregroundColor Γûá Γûá IColor
frameWindow Boolean
group Γûá Boolean
handle IWindowHandle
hiliteBackgroundColor Γûá Γûá IColor
hiliteForegroundColor Γûá Γûá IColor
iconSize Γûá ISize
iconView Boolean
id Γûá unsigned long
inactiveColor Γûá Γûá IColor
itemProvider Γûá IDMItemProvider*
items Γûá Γûá IVSequence < Element >*
layoutAdjustment IRectangle
lineSpacing Γûá long
menu
messageQueue IMessageQueueHandle
minimumSize Γûá ISize
mixedTargetEmphasis Boolean
multipleSelection Boolean
nameView Boolean
nativeRect IRectangle
normalTargetEmphasis Boolean
numberOfColumnChanges unsigned long
numberOfObjectChanges unsigned long
numberOfSelections unsigned long
objectCount unsigned long
objectList ICnrObjectSet
orderedTargetEmphasis Boolean
owner Γûá IWindow*
parent Γûá IWindow*
parentSize ISize
pointerCaptured Boolean
position Γûá Γûá IPoint
presSpace IPresSpaceHandle
rect Γûá IRectangle
refreshOn Γûá Boolean
selectedCnrObjects IVSequence < CnrElement * >*
selectedObjects IVSequence < Element >*
selectionIndices Γûá IVSequence < unsigned long >*
selectionIsValid Boolean
shadowColor Γûá Γûá IColor
showing Boolean
showingMiniIcons Boolean
singleSelection Boolean
size Γûá Γûá ISize
splitBarOffset unsigned long
tabStop Γûá Boolean
textView Boolean
title Γûá Γûá IString
titleRectangle IRectangle
titleSeparatorVisible Γûá Boolean
titleVisible Γûá Γûá Boolean
titleWriteable Γûá Boolean
treeIconView Boolean
treeNameView Boolean
treeTextView Boolean
treeView Boolean
valid Boolean
viewPortOnWindow IRectangle
viewPortOnWorkspace IRectangle
visible Γûá Γûá Boolean
visibleRectangle IRectangle
willDeleteColumnsOnClose Boolean
willDeleteObjectsOnClose Boolean
ΓòÉΓòÉΓòÉ <hidden> Actions - IVBContainerControl ΓòÉΓòÉΓòÉ
Action Parameters
addColumn IContainerColumn*, IContainerColumn*
addItem unsigned long
addObject IContainerObject*, IContainerObject*
addObjectAfter IContainerObject*, IContainerObject*,
IContainerObject*
addObjects ICnrAllocator&, IContainerObject*
addObjectsAfter ICnrAllocator&, IContainerObject*,
IContainerObject*
applyBidiSettings BidiSettings&, Boolean, Boolean
arrangeIconView None
capturePointer Boolean
closeEdit None
collapse IContainerObject*
collapseTree None
columnAt unsigned long
columnUnderPoint IPoint&
containerFromHandle IWindowHandle&
containsObject IContainerObject*
convertToGUIStyle IBitFlag&, Boolean
convertToWorkspace IRectangle&, Boolean
copyObjectTo IContainerObject*, IContainerObject*,
IContainerControl*, IContainerObject*, IPoint&
deleteAllObjects None
deleteItem unsigned long
deleteSelectedObjects None
descendentsOf IContainerObject*
deselectAll None
detailsObjectRectangle IContainerObject*, Boolean
disable None
disableCaching None
disableDataUpdate IContainerObject*
disableDrawBackground None
disableDrawItem None
disableDrop IContainerObject*
disableGroup None
disableNotification None
disableTabStop None
disableTitleUpdate None
disableUpdate None
dispatchRemainingHandlers IEvent&, Boolean
editColumnTitle IContainerColumn*
editContainerTitle None
editObject IContainerObject*, IContainerColumn*
enable Boolean
enableDataUpdate IContainerObject*, Boolean
enableDrop IContainerObject*, Boolean
enableUpdate Boolean
expand IContainerObject*
expandTree None
filter None
handleException IException&, IEvent&
hide None
hideDetailsViewTitles None
hideObject IContainerObject*
hideSourceEmphasis None
hideSplitBar None
hideTitle None
hideTitleSeparator None
hideTreeLine None
iconRectangle IContainerObject*, Boolean
immediateDescendentsOf IContainerObject*
initialize None
isCollapsed IContainerObject*
isColumnRight IContainerColumn*
isCursored IContainerObject*
isDropOnAble IContainerObject*
isExpanded IContainerObject*
isInUse IContainerObject*
isLayoutDistorted unsigned long
isMoveValid IContainerObject*, IContainerObject*,
IContainerControl*, IContainerObject*
isSelected IContainerObject*
isSource IContainerObject*
isTarget IContainerObject*
isWriteable IContainerObject*
matchForMnemonic unsigned short
moveIconTo IContainerObject*, IPoint&
moveObjectTo IContainerObject*, IContainerObject*,
IContainerControl*, IContainerObject*, IPoint&
nlsCompare char*, char*
notifyObservers INotificationEvent&
objectAt unsigned long
objectUnderPoint IPoint&
operator == IContainerControl&
parentObject IContainerObject*
positionBehindSibling IWindowHandle&
positionBehindSiblings None
positionOnSiblings None
postEvent unsigned long, IEventParameter1&,
IEventParameter2&
refresh IRectangle&
refreshAllContainers None
refreshFromList None
releasePointer None
releasePresSpace IPresSpaceHandle&
removeAllObjects None
removeColumn IContainerColumn*
removeInUse IContainerObject*
removeObject IContainerObject*, Boolean
removeSelected IContainerObject*
removeSelectedObjects None
resetActiveColor None
resetBackgroundColor None
resetBorderColor None
resetDisabledBackgroundColor None
resetDisabledForegroundColor None
resetFont None
resetForegroundColor None
resetHiliteBackgroundColor None
resetHiliteForegroundColor None
resetInactiveColor None
resetMinimumSize None
resetShadowColor None
scroll long, long, Boolean
scrollDetailsHorizontally long, Boolean
scrollHorizontally long, Boolean
scrollToObject IContainerObject*
scrollVertically long
selectAll None
sendEvent unsigned long, IEventParameter1&,
IEventParameter2&
setCursor IContainerObject*
setDeleteColumnsOnClose Boolean
setDeleteObjectsOnClose Boolean
setEditColumn IContainerColumn*
setEditMLE IMultiLineEdit*
setEditObject IContainerObject*
setExtendedSelection None
setFocus None
setInUse IContainerObject*, Boolean
setLayoutDistorted unsigned long, unsigned long
setMixedTargetEmphasis None
setMultipleSelection None
setNormalTargetEmphasis None
setOrderedTargetEmphasis None
setRefreshOff None
setSelected IContainerObject*, Boolean
setSingleSelection None
setTitleAlignment TitleAlignment
setTreeExpandIconSize ISize&
setTreeItemIcons IResourceId&, IResourceId&
setTreeViewIndent long
show Boolean
showDetailsView None
showFlowedNameView None
showFlowedTextView None
showIconView None
showMiniIcons Boolean
showNameView None
showObject IContainerObject*, Boolean
showSourceEmphasis Boolean
showSplitBar Boolean
showTextView None
showTreeIconView None
showTreeLine long
showTreeNameView None
showTreeTextView None
sortByIconText Boolean
textRectangle IContainerObject*
ΓòÉΓòÉΓòÉ <hidden> Events - IVBContainerControl ΓòÉΓòÉΓòÉ
Event Notification ID
addEvent addId
commandEvent commandId
detailsViewTitlesEvent detailsViewTitlesId
enterEvent enterId
gotFocusEvent FOCUSTRUEID
inputDisabledEvent ENABLEFALSEID
inputEnabledEvent ENABLETRUEID
lostFocusEvent FOCUSFALSEID
removeEvent removeId
selectEvent selectId
selectionDefaultActionEvent selectionDefaultActionId
selectionIndexChangedEvent selectionIndexChangedId
systemCommandEvent systemCommandId
visibilityDisabledEvent VISIBLEFALSEID
visibilityEnabledEvent VISIBLETRUEID
ΓòÉΓòÉΓòÉ <hidden> General Settings - IVBContainerControl ΓòÉΓòÉΓòÉ
Subpart name Sets the name of the subpart (a part placed on a composite part).
Default value: The name of the part
Title Sets the title to appear on the title bar for the part.
Default value: None
Title attributes Sets the title for the container.
Default value: None
Container item attributes Specifies the objects that the container can hold.
Default value: None
Show title Shows the container's title.
Default value: Not selected
Show title separator Displays a horizontal separator between the title and the
work area of a container part.
Default value: Not selected
Title alignment Sets the alignment attributes for the title.
Default value: Not selected
View type Sets the view type for the part, which can be one of the following:
Details view
Shows the details view of the container.
Flowed name view
Sets the current view to the flowed name view.
Flowed text view
Sets the current view to the flowed name view.
Icon view
Shows the icon view of the container.
Name view
Shows the name view of the container.
Text view
Sets the current view to the nonflowed text view.
Tree icon view
Shows the tree icon view of the container.
Tree name view
Shows the tree name view of the container.
Tree text view
Shows the text name view of the container.
Default value: Not selected
Item type Specifies the part type of objects in the collection.
Default value: None
Text Sets the text for the part.
Default value: The name of the part
Icon Sets the icon handle of the part.
Default value: None
Collection type Specifies the part type of the collection.
Default value: IVSequence*
Line spacing Sets the space between lines, in pixels.
Default value: 2
Refresh the container after changes Refreshes all parts in the container after
updates are made.
Default value: Selected
EnableDrawBackground Enables the background of the container to be redrawn.
Default value: Not selected
EnableDrawItem Enables list box items to be drawn, which are typically used to
display bitmaps.
Default value: Not selected
ΓòÉΓòÉΓòÉ <hidden> Control Settings - IVBContainerControl ΓòÉΓòÉΓòÉ
Fly over short text Specifies the short text for the fly-over text control.
Default value: None
Fly over long text Specifies the long text for the fly-over text control.
Default value: None
Window id Sets the window identifier.
Default value: None
Help panel id Sets the help panel identifier for the part.
Default value: None
Enabled Enables the handler by default.
Default value: Selected
ΓòÉΓòÉΓòÉ <hidden> Styles Settings - IVBContainerControl ΓòÉΓòÉΓòÉ
defaultStyle() Resets the part to the original default style.
Default value: Selected
autoPosition Automatically positions parts that are added to the container in
the icon view.
Default value: The Default radio button is selected.
verifyPointers Validates that container parts exist.
Default value: The Default radio button is selected.
noSharedObjects Disallows sharing objects with other containers.
Default value: The default is off, and the Default radio button is selected.
extendedSelection Specifies that the container use extended selection.
Default value: The default is off, and the Default radio button is selected.
singleSelection Specifies that the container use single selection.
Default value: The default is on, and the Default radio button is selected.
group Identifies the control as being the first in a group. No other controls
in the group can have this style. Controls in the group must be siblings
that are constructed following the first control. The group can be cursored
and when the last control in the group is reached, the cursor returns the
first control in the group.
Default value: The default is off, and the Default radio button is selected.
tabStop Identifies the control as one to which the user can tab.
Default value: The default is off, and the Default radio button is selected.
clipChildren Excludes the area occupied by the children of the window when
drawing in the window. Child windows are always "clipped" to their parent
window. When a parent window is painted, the clipChildren style controls
whether the invalidated region of the parent window includes the area
occupied by its children, thus preventing a window from painting over its
child windows.
Default value: The Default radio button is selected.
clipSiblings Controls which sibling window is displayed on top when multiple
siblings are displayed. Sibling windows are windows that share the same
parent window. Assign the clipSiblings style to the sibling window that you
want displayed on top of the other siblings, in Z-order.
Default value: The Default radio button is selected.
clipToParent Allows a window to paint outside of its window boundary up to the
window boundary of its parent.
Default value: The Default radio button is selected.
saveBits Optimizes the painting of a window by saving the screen image of the
area under the window as a bitmap and then using the bitmap to redraw the
window, when necessary.
Default value: The Default radio button is selected.
synchPaint Synchronously repaints the window. Without this style, painting
only occurs if there are no other events waiting to be processed.
Default value: The Default radio button is selected.
visible Makes the window visible. In general, controls are constructed as
visible, and frame windows are constructed as invisible.
Default value: The default is on, and the Default radio button is selected.
ΓòÉΓòÉΓòÉ <hidden> Handlers Settings - IVBContainerControl ΓòÉΓòÉΓòÉ
Handler name Sets the name of the default handler.
Default value: None
Handler list Sets the name of the handler for the MLE control.
Default value: None
Add after Adds the new choice after the selected choice in the list. If no
choice is selected, the new choice is added after the first choice in the
list.
Default value: Highlighted
Add before Adds the new choice before the selected choice in the list. If no
choice is selected, the new choice is added before the first choice in the
list.
Default value: Not highlighted
Move Determines whether a part and its descendants can be moved to a new
location.
Default value: Not highlighted
Remove Removes one item from the part and returns the count of the number of
items that remain.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ <hidden> Size/Position Settings - IVBContainerControl ΓòÉΓòÉΓòÉ
X field Sets the X coordinate of the part.
Default value: The x coordinate of the part currently positioned on the
free-form surface
Y field Sets the Y coordinate of the point.
Default value: The y coordinate of the part currently positioned on the
free-form surface
Width Sets the width of the text.
Default value: None
Height Sets the height of the text.
Default value: None
Minimum size Determines the minimum size of the part.
Select Calculate at execution time or Set value here. If you select
Calculate at execution time, the minimum size is determined dynamically. If
you select Set value here, you can set the Minimum size Width and Height
fields to define a fixed minimum size.
Default value: Calculate at execution time is selected
Width Sets the minimum-allowable width, which is set by the user's class.
Default value: None (calculated at execution time)
Height Sets the minimum-allowable height, which is set by the user's class.
Default value: None (calculated at execution time)
ΓòÉΓòÉΓòÉ <hidden> Font Settings - IVBContainerControl ΓòÉΓòÉΓòÉ
Name Sets the name of the font.
Default value: System proportional
Point size Sets the point size of the font.
Default value: 10
Style Sets the style for the part.
Default value: None
Emphasis Gives the part emphasis. If a part is specified, the emphasis is
drawn around the part.
Default value: None
Edit Opens an edit field on a part or setting.
Default value: Highlighted
Default font Sets the current default font style.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ 3.50. IVBFactory ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Actions
Events
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IVBFactory ΓòÉΓòÉΓòÉ
Title: IVBFactory
Class name: IVBFactory
Base part: None
Part type: Nonvisual part
Part file: vbbase.vbb
An IVBFactory dynamically creates new parts of a type you specify.
The user interacts with parts created by the object factory but does not have
access to the factory itself.
Use an IVBFactory part to generate dynamic parts.
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - IVBFactory ΓòÉΓòÉΓòÉ
When building with an IVBFactory part, you can do the following:
Define an object factory for a part type. Do this by adding an object
factory to your composite part and specifying the part type the factory
creates. For example, define a frame window factory as follows:
1. Drop an IVBFactory part on the free-form surface.
2. Open the contextual menu of the factory, select the Change Type
choice, and enter the data type you need.
Create an object when an event occurs. Do this by connecting the event to
the IVBFactory new action.
ΓòÉΓòÉΓòÉ <hidden> Actions - IVBFactory ΓòÉΓòÉΓòÉ
Action Parameters
new None
ΓòÉΓòÉΓòÉ <hidden> Events - IVBFactory ΓòÉΓòÉΓòÉ
Event Notification ID
newEvent newObjectCreateId
ΓòÉΓòÉΓòÉ 3.51. IVBFileDialog ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Events
Settings Pages
General
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IVBFileDialog ΓòÉΓòÉΓòÉ
Title: IBM VB file dialog window
Class name: IVBFileDialog
Base part: IStandardNotifier
Part type: Nonvisual part
Part file: vbbase.vbb
An IVBFileDialog part is a placeholder for a file dialog. While building your
application, the placeholder represents a file dialog for connections from
other parts. When your application is built and run, a file dialog replaces
the placeholder. A file dialog provides an input field and other controls for
file identification.
With a file dialog, the user can select a file to work with or specify a file
name for saving current work.
Use an IVBFileDialog part to represent a file dialog during application
building.
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - IVBFileDialog ΓòÉΓòÉΓòÉ
When building with an IVBFileDialog part, you can do the following:
Define a title for the dialog. Do this by entering the title in the Title
field on the IVBFileDialog General settings page.
Provide an initial file name for the dialog. Do this by entering the name
in the File name field on the IVBFileDialog General settings page.
Show only files of a particular extended attribute type in the file list.
Do this by specifying the type in the File type (EA type) field on the
IVBFileDialog General settings page. Leave this field empty to show all
available files in the list.
Define text for the OK push button. For example, you might want the
button text to be Open or Save as. Do this by entering the text in the OK
button text field on the IVBFileDialog General settings page.
Identify the frame window that the file dialog is related to. If you have
only one frame window in your view, the dialog is automatically related
to that frame window.
If you want the file dialog for a second frame window in your view, do
this by referencing the frame window Subpart name, which appears on its
General settings page. Enter the frame window subpart name, prefixed with
"i," in the Owner field on the IVBFileDialog General settings page.
Show the dialog when the user selects a menu choice. Do this by
connecting the IMenuItem commandEvent feature to the IVBFileDialog
showModally action.
Perform the requested file operation for a part that works with files.
For example, to load an IMultiLineEdit part from a file, do this as
follows:
1. Connect the IVBFileDialog pressedOK event to the IMultiLineEdit
importFromFile action.
2. Connect the IVBFileDialog fileName attribute to the fileName
parameter of the pressedOK-to-importFromFile connection.
Perform the requested file operation for a part that does not work with
files. Do this with a member function as follows:
1. Connect the IVBFileDialog pressedOkEvent feature to the free-form
surface.
2. Select the More choice on the connection menu.
3. Enter the signature of a member function to perform the operation.
4. Connect the IVBFileDialog fileName attribute to a file name
parameter on the connection to the member function.
Alternatively, perform the file operation with custom logic as follows:
1. Connect the IVBFileDialog pressedOkEvent feature to the free-form
surface.
2. Select the Custom logic choice on the connection menu.
3. Enter the C++ code to perform the operation. Access the file name in
your custom logic by pressing the Source push button. Enter the get
member function of the fileName attribute after the source pointer
inserted into your code. This is the resulting code segment:
source->fileName()
ΓòÉΓòÉΓòÉ <hidden> Attributes - IVBFileDialog ΓòÉΓòÉΓòÉ
Attribute S E Data type
asDebugInfo IString
asString IString
buttonPressedId long
enabledForNotification Γûá Boolean
fileDialog IFileDialog*
fileDialogSettings IFileDialog::Settings*
fileName Γûá Γûá IString
modeless Boolean
pressedOK Boolean
returnValue long
saveAsEAType IString
selectedFileCount unsigned long
ΓòÉΓòÉΓòÉ <hidden> Actions - IVBFileDialog ΓòÉΓòÉΓòÉ
Action Parameters
addDrive char*
addFileType char*
disableNotification None
notifyObservers INotificationId&
operator = IStandardNotifier&
setDialogTemplate IResourceId&
setInitialDrive char*
setInitialFileType char*
setOKButtonText IResourceId&
setOpenDialog None
setPosition IPoint&
setSaveAsDialog None
setTitle char*
show IWindow*, IFileDialog::Style, IHandler*
showModally IWindow*, IFileDialog::Style, IHandler*
ΓòÉΓòÉΓòÉ <hidden> Events - IVBFileDialog ΓòÉΓòÉΓòÉ
Event Notification ID
createdEvent createdId
dismissedEvent dismissedId
pressedOkEvent pressedOkId
ΓòÉΓòÉΓòÉ <hidden> General Settings - IVBFileDialog ΓòÉΓòÉΓòÉ
Subpart name Sets the name of the subpart (a part placed on a composite part).
Default value: The name of the part
Owner Sets the window's owner.
Default value: None
Title Sets the title to appear on the title bar for the part.
Default value: None
File type (EA type) Sets the file type selected by the user.
Default value: None
File name Sets the fully qualified file name selected by the user.
Default value: None
OK button text Sets the text that appears on the OK button.
Default value: None
Search Lets the user search for the file name.
Default value: The default is off, and the Default radio button is selected.
ΓòÉΓòÉΓòÉ 3.52. IVBFlyText ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Events
Settings Pages
General
Handlers
Font
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IVBFlyText ΓòÉΓòÉΓòÉ
Title: IBM VB fly-over text control
Class name: IVBFlyText
Base part: IFlyText
Part type: Nonvisual part
Part file: vbbase.vbb
An IVBFlyText part displays fly-over text for other parts. Fly-over text is a
brief description of a control that appears when the user places the mouse
pointer on the control. The text generally appears in a small rectangle near
the control.
The user can read help information in the fly-over text without opening
another window for help.
Use an IVBFlyText part to briefly describe controls in your frame window.
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - IVBFlyText ΓòÉΓòÉΓòÉ
When building with an IVBFlyText part, you can do the following:
Associate fly-over text with a frame window. Do this as follows:
1. Drop an IVBFlyText part on the free-form surface in your frame
window view.
2. For your frame window and each control, enter brief fly-over text in
the Fly over short text field on its Control settings page.
Display lengthier fly-over text in an information area. Do this as
follows:
1. Connect the IInfoArea this attribute to the FlyOverHelpHandler
longTextControl attribute.
2. For your frame window and each control, enter the fly-over text in
the Fly over long text field on its Control settings page.
Identify the frame window that the fly-over text is related to. If you
have only one frame window in your view, the fly-over text is
automatically related to that frame window.
If you want fly-over text for a second frame window in your view, do this
by referencing the frame window Subpart name, which appears on its
General settings page. Enter the frame window subpart name, prefixed with
"i," in the Owner field on the General settings page of a second
IVBFlyText part.
ΓòÉΓòÉΓòÉ <hidden> Attributes - IVBFlyText ΓòÉΓòÉΓòÉ
Attribute S E Data type
activeColor Γûá Γûá IColor
asDebugInfo IString
asString IString
autoDeleteObject Γûá Boolean
autoDestroyWindow Γûá Boolean
backgroundColor Γûá Γûá IColor
bidiSupported Boolean
borderColor Γûá Γûá IColor
characterSize ISize
clipboardHasTextFormat Boolean
defaultPushButton IWindowHandle
disabledBackgroundColor Γûá Γûá IColor
disabledForegroundColor Γûá Γûá IColor
displaySize ISize
enabled Γûá Γûá Boolean
enabledForNotification Γûá Boolean
flyOverHelpHandler IFlyOverHelpHandler*
focus Γûá Boolean
font Γûá Γûá IFont
foregroundColor Γûá Γûá IColor
frameWindow Boolean
group Γûá Boolean
handle IWindowHandle
hiliteBackgroundColor Γûá Γûá IColor
hiliteForegroundColor Γûá Γûá IColor
id Γûá unsigned long
inactiveColor Γûá Γûá IColor
isDigits Γûá
itemProvider Γûá IDMItemProvider*
layoutAdjustment IRectangle
longTextControl Γûá ITextControl*
menu
messageQueue IMessageQueueHandle
minimumSize Γûá ISize
nativeRect IRectangle
owner Γûá IWindow*
parent Γûá IWindow*
parentSize ISize
pointerCaptured Boolean
position Γûá Γûá IPoint
presSpace IPresSpaceHandle
rect Γûá IRectangle
relativeWindowRect Γûá IRectangle
shadowColor Γûá Γûá IColor
showing Boolean
size Γûá Γûá ISize
tabStop Γûá Boolean
text Γûá Γûá IString
textLength Γûá unsigned long
valid Boolean
valueAsDouble Γûá Γûá
valueAsInt Γûá Γûá
valueAsUnsigned Γûá Γûá
visible Γûá Γûá Boolean
visibleRectangle IRectangle
ΓòÉΓòÉΓòÉ <hidden> Actions - IVBFlyText ΓòÉΓòÉΓòÉ
Action Parameters
applyBidiSettings BidiSettings&, Boolean, Boolean
capturePointer Boolean
convertToGUIStyle IBitFlag&, Boolean
disable None
disableGroup None
disableNotification None
disableTabStop None
disableUpdate None
dispatchRemainingHandlers IEvent&, Boolean
enable Boolean
enableUpdate Boolean
handleException IException&, IEvent&
hide None
hideSourceEmphasis None
isLayoutDistorted unsigned long
matchForMnemonic unsigned short
notifyObservers INotificationEvent&
positionBehindSibling IWindowHandle&
positionBehindSiblings None
positionOnSiblings None
postEvent unsigned long, IEventParameter1&,
IEventParameter2&
refresh IRectangle&
releasePointer None
releasePresSpace IPresSpaceHandle&
resetActiveColor None
resetBackgroundColor None
resetBorderColor None
resetDisabledBackgroundColor None
resetDisabledForegroundColor None
resetFont None
resetForegroundColor None
resetHiliteBackgroundColor None
resetHiliteForegroundColor None
resetInactiveColor None
resetMinimumSize None
resetShadowColor None
sendEvent unsigned long, IEventParameter1&,
IEventParameter2&
setFocus None
setLayoutDistorted unsigned long, unsigned long
show Boolean
showSourceEmphasis Boolean
ΓòÉΓòÉΓòÉ <hidden> Events - IVBFlyText ΓòÉΓòÉΓòÉ
Event Notification ID
commandEvent commandId
gotFocusEvent FOCUSTRUEID
inputDisabledEvent ENABLEFALSEID
inputEnabledEvent ENABLETRUEID
lostFocusEvent FOCUSFALSEID
systemCommandEvent systemCommandId
visibilityDisabledEvent VISIBLEFALSEID
visibilityEnabledEvent VISIBLETRUEID
ΓòÉΓòÉΓòÉ <hidden> General Settings - IVBFlyText ΓòÉΓòÉΓòÉ
Subpart name Sets the name of the subpart (a part placed on a composite part).
Default value: The name of the part
Owner Sets the window's owner.
Default value: None
ΓòÉΓòÉΓòÉ <hidden> Handlers Settings - IVBFlyText ΓòÉΓòÉΓòÉ
Handler name Sets the name of the default handler.
Default value: None
Handler list Sets the name of the handler for the MLE control.
Default value: None
Add after Adds the new choice after the selected choice in the list. If no
choice is selected, the new choice is added after the first choice in the
list.
Default value: Highlighted
Add before Adds the new choice before the selected choice in the list. If no
choice is selected, the new choice is added before the first choice in the
list.
Default value: Not highlighted
Move Determines whether a part and its descendants can be moved to a new
location.
Default value: Not highlighted
Remove Removes one item from the part and returns the count of the number of
items that remain.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ <hidden> Font Settings - IVBFlyText ΓòÉΓòÉΓòÉ
Name Sets the name of the font.
Default value: System proportional
Point size Sets the point size of the font.
Default value: 10
Style Sets the style for the part.
Default value: None
Emphasis Gives the part emphasis. If a part is specified, the emphasis is
drawn around the part.
Default value: None
Edit Opens an edit field on a part or setting.
Default value: Highlighted
Default font Sets the current default font style.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ 3.53. IVBFontDialog ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Events
Settings Pages
General
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IVBFontDialog ΓòÉΓòÉΓòÉ
Title: IBM VB font dialog window
Class name: IVBFontDialog
Base part: IStandardNotifier
Part type: Nonvisual part
Part file: vbbase.vbb
An IVBFontDialog part is a placeholder for a font dialog. While building your
application, the placeholder represents a font dialog for connections from
other parts. When your application is built and run, a font dialog replaces
the placeholder. A font dialog provides selection fields and other controls
for font specification.
With a font dialog, the user can select a font name, size, and styles to use
with your application.
Use an IVBFontDialog part to represent a font dialog during application
building.
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - IVBFontDialog ΓòÉΓòÉΓòÉ
When building with an IVBFontDialog part, you can do the following:
Define a title for the dialog. Do this by entering the title in the Title
field on the IVBFontDialog General settings page.
Show only fonts in one font family, such as Helvetica or Courier, in the
font list. Do this by specifying the font family in the Font family name
field on the IVBFontDialog General settings page. Leave this field empty
to show all available fonts in the list.
Provide preview text to show font appearance in the dialog. Do this by
entering the text in the Preview text field on the IVBFontDialog General
settings page.
Identify the frame window that the font dialog is related to. If you have
only one frame window in your view, the dialog is automatically related
to that frame window.
If you want the font dialog for a second frame window in your view, do
this by referencing the frame window Subpart name, which appears on its
General settings page. Enter the frame window subpart name, prefixed with
"i," in the Owner field on the IVBFontDialog General settings page.
Show the dialog when the user selects a menu choice. Do this by
connecting the IMenuItem commandEvent feature to the IVBFontDialog
showModally action.
Apply the requested font selection. Do this with a member function as
follows:
1. Connect the IVBFontDialog pressedOkEvent feature to the free-form
surface
2. Select the More choice on the connection menu.
3. Enter the signature of a member function to perform the operation.
4. Connect the IVBFontDialog font attribute to a font parameter on the
connection to the member function.
Alternatively, perform the font operation with custom logic as follows:
1. Connect the IVBFontDialog pressedOkEvent feature to the free-form
surface
2. Select the Custom logic choice on the connection menu.
3. Enter the C++ code to perform the operation. Access the font
selection in your custom logic by pressing the Source push button.
Enter the get member function of the font attribute after the source
pointer inserted into your code. This is the resulting code segment:
source->font()
ΓòÉΓòÉΓòÉ <hidden> Attributes - IVBFontDialog ΓòÉΓòÉΓòÉ
Attribute S E Data type
asDebugInfo IString
asString IString
buttonPressedId unsigned long
emHeight unsigned long
enabledForNotification Γûá Boolean
externalLeading unsigned long
font Γûá Γûá IFont
fontDialog IFontDialog*
fontDialogSettings IFontDialog::Settings*
fontFamily IString
fontWeight unsigned long
fontWidth unsigned long
modeless Boolean
nominalPointSize unsigned long
pointSize Γûá unsigned long
pressedOK Boolean
returnValue long
xHeight unsigned long
ΓòÉΓòÉΓòÉ <hidden> Actions - IVBFontDialog ΓòÉΓòÉΓòÉ
Action Parameters
disableNotification None
notifyObservers INotificationId&
operator = IStandardNotifier&
setDialogTemplate IResourceId&
setDisplayPS IPresSpaceHandle&
setFamily char*
setFontFromFontModally IFont*, IWindow*, IFontDialog::Style,
IHandler*
setFontFromWindowModally IWindow*, IWindow*, IFontDialog::Style,
IHandler*
setPosition IPoint&
setPreviewText char*
setPrinterPS IPresSpaceHandle&
setSizeList char*
setTitle char*
show IWindow*, IFontDialog::Style, IHandler*
showFromFont IFont*, IWindow*, IFontDialog::Style,
IHandler*
showModally IWindow*, IFontDialog::Style, IHandler*
ΓòÉΓòÉΓòÉ <hidden> Events - IVBFontDialog ΓòÉΓòÉΓòÉ
Event Notification ID
createdEvent createdId
dismissedEvent dismissedId
pressedOkEvent pressedOkId
ΓòÉΓòÉΓòÉ <hidden> General Settings - IVBFontDialog ΓòÉΓòÉΓòÉ
Subpart name Sets the name of the subpart (a part placed on a composite part).
Default value: The name of the part
Owner Sets the window's owner.
Default value: None
Title Sets the title to appear on the title bar for the part.
Default value: None
Font family name Sets the family name of the font.
Default value: None
Preview text Sets the text to display in the font sample box.
Default value: None
ΓòÉΓòÉΓòÉ 3.54. IVBNotebookPage ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Settings Pages
General
Styles
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IVBNotebookPage ΓòÉΓòÉΓòÉ
Title: IVBNotebookPage
Class name: IVBNotebookPage
Base part: IStandardNotifier
Part type: Nonvisual part
Part file: vbbase.vbb
An IVBNotebookPage part is a software representation of a physical notebook
page. It presents information that is generally related and can have a tab for
direct user access.
The user can do the following with a notebook page:
View or change information by using other controls
Turn the page by clicking on page buttons
Use an IVBNotebookPage part for settings choices or for related information.
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - IVBNotebookPage ΓòÉΓòÉΓòÉ
When building with an IVBNotebookPage part, you can do the following:
Add a page to a notebook. Do this by clicking mouse button 2 on the
notebook and selecting an add page choice. When there are no pages in the
notebook, your only page choice is Add Initial Page. When the notebook
has one or more pages, select Add Page After or Add Page Before. An
IVBNotebookPage part is placed in the notebook.
Select a tab type for the page. By default, the page has a major tab.
If you want a minor tab on the page, set the minorTab field to On and set
the majorTab field to Off on the IVBNotebookPage Styles settings page.
If you want no tab on the page, set both fields to Off. Do not set both
fields to On.
Define text for a tab. Do this by entering the text you want in the Tab
text field on the IVBNotebookPage General settings page.
Define text for the status area at the bottom of the page. Do this by
entering the text you want in the Status text field on the
IVBNotebookPage General settings page.
Place a part on a notebook page. A notebook page accepts only one part,
so you should place one of the canvases or a view port on the page. If
you use a view port, place a canvas in the view port. After you have a
canvas on the notebook page, you can place controls on the canvas.
Place the part you want on the notebook page by selecting it from the
parts palette and dropping it on the page. Expand the canvas or view port
by selecting it and dragging its corner handle. Leave part of the
notebook page exposed so you can still access the notebook page. If the
autoPageSize field on the Styles settings page is set to On, the part
placed on the notebook page fills the page in generated code. The
autoPageSize field is set to On by default.
ΓòÉΓòÉΓòÉ <hidden> Attributes - IVBNotebookPage ΓòÉΓòÉΓòÉ
Attribute S E Data type
asDebugInfo IString
asString IString
enabledForNotification Γûá Boolean
notebook const IWindow*
pageHandle IPageHandle
statusText Γûá IString
tabBitmap Γûá IBitmapHandle
tabText Γûá IString
window Γûá IWindow*
ΓòÉΓòÉΓòÉ <hidden> Actions - IVBNotebookPage ΓòÉΓòÉΓòÉ
Action Parameters
disableNotification None
notifyObservers INotificationId&
operator = IStandardNotifier&
ΓòÉΓòÉΓòÉ <hidden> General Settings - IVBNotebookPage ΓòÉΓòÉΓòÉ
Subpart name Sets the name of the subpart (a part placed on a composite part).
Default value: The name of the part
Tab text Sets the text for the notebook tab.
Default value: Tab
Status text Sets the text for the status area of the notebook page.
Default value: None
ΓòÉΓòÉΓòÉ <hidden> Styles Settings - IVBNotebookPage ΓòÉΓòÉΓòÉ
statusTextOn Sets the text of the status line associated with this notebook
page.
Default value: The Default radio button is selected.
minorTab Specifies that the tab is associated with a minor tab.
Default value: The Default radio button is selected.
majorTab Specifies that the tab is associated with a major tab.
Default value: The default is on.
noAttribute Restricts the tab from being associated with an attribute.
Default value: The Default radio button is selected.
autoPageSize Automatically sets the size of the notebook page.
Default value: The default is on.
ΓòÉΓòÉΓòÉ 3.55. IVBVariableClass ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IVBVariableClass ΓòÉΓòÉΓòÉ
Title: IBM placeholder for class instance
Class name: IVBVariableClass
Base part: IVBVariableClassBase
Part type: Nonvisual part
Part file: vbbase.vbb
An IVBVariableClass part is a placeholder for class data. Visual Builder uses
IVBVariableClass when you specify a class type, such as IDate, for an
IVBVariable.
The user does not have access to these variables.
Use an IVBVariable to pass data between composite parts.
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - IVBVariableClass ΓòÉΓòÉΓòÉ
Building guidelines for an IVBVariable are provided in documentation of
IVBVariablePart.
ΓòÉΓòÉΓòÉ <hidden> Attributes - IVBVariableClass ΓòÉΓòÉΓòÉ
Attribute S E Data type
asDebugInfo IString
asString IString
autoDeleteTarget Γûá Boolean
enabledForNotification Γûá Boolean
targetPtr Element*
this Γûá Γûá Element
ΓòÉΓòÉΓòÉ <hidden> Actions - IVBVariableClass ΓòÉΓòÉΓòÉ
Action Parameters
disableNotification None
notifyObservers INotificationId&
operator = IStandardNotifier&
ΓòÉΓòÉΓòÉ 3.56. IVBVariableClassPointer ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IVBVariableClassPointer ΓòÉΓòÉΓòÉ
Title: IBM placeholder for class instance
Class name: IVBVariableClassPointer
Base part: IVBVariableClassBase
Part type: Nonvisual part
Part file: vbbase.vbb
An IVBVariableClassPointer part is a placeholder for a pointer to class data.
Visual Builder uses IVBVariableClassPointer when you specify a class pointer
type, such as IDate*, for an IVBVariable.
The user does not have access to these variables.
Use an IVBVariable to pass data between composite parts.
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - IVBVariableClassPointer ΓòÉΓòÉΓòÉ
Building guidelines for an IVBVariable are provided in documentation of
IVBVariablePart.
ΓòÉΓòÉΓòÉ <hidden> Attributes - IVBVariableClassPointer ΓòÉΓòÉΓòÉ
Attribute S E Data type
asDebugInfo IString
asString IString
autoDeleteTarget Γûá Boolean
enabledForNotification Γûá Boolean
targetPtr Element
this Γûá Γûá Element
ΓòÉΓòÉΓòÉ <hidden> Actions - IVBVariableClassPointer ΓòÉΓòÉΓòÉ
Action Parameters
deleteTarget None
disableNotification None
notifyObservers INotificationId&
operator = IStandardNotifier&
ΓòÉΓòÉΓòÉ 3.57. IVBVariablePart ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IVBVariablePart ΓòÉΓòÉΓòÉ
Title: IBM placeholder for part instance
Class name: IVBVariablePart
Base part: IVBVariablePartBase
Part type: Nonvisual part
Part file: vbbase.vbb
An IVBVariablePart part is a placeholder for part data. Visual Builder uses
IVBVariablePart when you specify a part type, such as IEntryField, for an
IVBVariable.
The user does not have access to these variables.
Use an IVBVariable to pass data between composite parts.
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - IVBVariablePart ΓòÉΓòÉΓòÉ
When building with an IVBVariable, you can do the following:
Change the variable type to the part or class type you need. Do this as
follows:
1. If any other part is selected, click on the variable with mouse
button1 to select the variable.
2. Click on the variable with mouse button 2 to open the contextual
menu of the variable.
3. Select the Change Type choice from the menu.
4. Enter the data type you need. You can specify one of the following
types:
- Part type, such as IEntryField. This is implemented as an
IVBVariablePart.
- Part type pointer, such as IEntryField*. This is implemented as
an IVBVariablePartPointer.
- Class type, such as IDate. This is implemented as an
IVBVariableClass.
- Class type pointer, such as IDate*. This is implemented as an
IVBVariableClassPointer.
Change the variable name to something meaningful to your application. Do
this as follows:
1. Open the contextual menu of the variable.
2. Select the Change Name choice from the menu.
3. Enter the name you want.
Add variable features to the interface of the composite part you are
building. Give the variable a meaningful name before you promote
features. This ensures that generated feature names are based on the
meaningful name.
Promote features as follows:
1. Open the contextual menu of the variable.
2. Select the Promote Part Feature choice from the menu.
3. Select or enter the features you want to promote to the part
interface. Each promoted feature is given a name based on the
variable name and the variable feature name. For example, if you
promote the text attribute from an IEntryField variable named
Selection, the promoted feature is named selectionText.
ΓòÉΓòÉΓòÉ <hidden> Attributes - IVBVariablePart ΓòÉΓòÉΓòÉ
Attribute S E Data type
asDebugInfo IString
asString IString
autoDeleteTarget Γûá Boolean
enabledForNotification Γûá Boolean
targetPtr Element*
this Γûá Γûá Element
ΓòÉΓòÉΓòÉ <hidden> Actions - IVBVariablePart ΓòÉΓòÉΓòÉ
Action Parameters
disableNotification None
notifyObservers INotificationId&
operator = IStandardNotifier&
ΓòÉΓòÉΓòÉ 3.58. IVBVariablePartPointer ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IVBVariablePartPointer ΓòÉΓòÉΓòÉ
Title: IBM placeholder for part instance
Class name: IVBVariablePartPointer
Base part: IVBVariablePartBase
Part type: Nonvisual part
Part file: vbbase.vbb
An IVBVariablePartPointer part is a placeholder for a pointer to part data.
Visual Builder uses IVBVariablePartPointer when you specify a part pointer
type, such as IEntryField*, for an IVBVariable.
The user does not have access to these variables.
Use an IVBVariable to pass data between composite parts.
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - IVBVariablePartPointer ΓòÉΓòÉΓòÉ
Building guidelines for an IVBVariable are provided in documentation of
IVBVariablePart.
ΓòÉΓòÉΓòÉ <hidden> Attributes - IVBVariablePartPointer ΓòÉΓòÉΓòÉ
Attribute S E Data type
asDebugInfo IString
asString IString
autoDeleteTarget Γûá Boolean
enabledForNotification Γûá Boolean
targetPtr Element
this Γûá Γûá Element
ΓòÉΓòÉΓòÉ <hidden> Actions - IVBVariablePartPointer ΓòÉΓòÉΓòÉ
Action Parameters
disableNotification None
notifyObservers INotificationId&
operator = IStandardNotifier&
ΓòÉΓòÉΓòÉ 3.59. IViewPort ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Events
Settings Pages
General
Control
Styles
Handlers
Color
Size/Position
Font
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IViewPort ΓòÉΓòÉΓòÉ
Title: IBM view port to scroll nonresizable windows
Class name: IViewPort
Base part: ICanvas
Part type: Visual part
Part file: vbbase.vbb
An IViewPort part is a scrollable framework for the client area of a frame
window.
The user interacts with controls placed within the view port by your
application.
Use an IViewPort part to provide a scrollable view within a framework such as
one of the following:
The client area of a frame window
A cell of a set canvas
A multicell canvas cell
A split canvas pane
A notebook page
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - IViewPort ΓòÉΓòÉΓòÉ
When building with an IViewPort part, you can do the following:
Place one of the following canvases in the view port:
- ICanvas
- IMultiCellCanvas
- ISetCanvas
- ISplitCanvas
Resize the canvas to fill the view port. Do this by selecting the canvas
with mouse button 1 and dragging the corner handle to expand the canvas.
This allows you to see the controls you place in the canvas.
ΓòÉΓòÉΓòÉ <hidden> Attributes - IViewPort ΓòÉΓòÉΓòÉ
Attribute S E Data type
activeColor Γûá Γûá IColor
asDebugInfo IString
asString IString
autoDeleteObject Γûá Boolean
autoDestroyWindow Γûá Boolean
backgroundColor Γûá Γûá IColor
bidiSupported Boolean
borderColor Γûá Γûá IColor
characterSize ISize
defaultPushButton IWindowHandle
disabledBackgroundColor Γûá Γûá IColor
disabledForegroundColor Γûá Γûá IColor
enabled Γûá Γûá Boolean
enabledForNotification Γûá Boolean
focus Γûá Boolean
font Γûá Γûá IFont
foregroundColor Γûá Γûá IColor
frameWindow Boolean
group Γûá Boolean
handle IWindowHandle
hiliteBackgroundColor Γûá Γûá IColor
hiliteForegroundColor Γûá Γûá IColor
horizontalScrollBar IScrollBar*
id Γûá unsigned long
inactiveColor Γûá Γûá IColor
itemProvider Γûá IDMItemProvider*
layoutAdjustment IRectangle
menu
messageQueue IMessageQueueHandle
minimumSize Γûá ISize
nativeRect IRectangle
origDefaultButtonHandle IWindowHandle
owner Γûá IWindow*
parent Γûá IWindow*
parentSize ISize
pointerCaptured Boolean
position Γûá Γûá IPoint
presSpace IPresSpaceHandle
rect Γûá IRectangle
shadowColor Γûá Γûá IColor
showing Boolean
size Γûá Γûá ISize
tabStop Γûá Boolean
valid Boolean
verticalScrollBar IScrollBar*
viewWindow IWindowHandle
viewWindowDrawRectangle IRectangle
viewWindowSize Γûá Γûá ISize
visible Γûá Γûá Boolean
visibleRectangle IRectangle
ΓòÉΓòÉΓòÉ <hidden> Actions - IViewPort ΓòÉΓòÉΓòÉ
Action Parameters
applyBidiSettings BidiSettings&, Boolean, Boolean
capturePointer Boolean
convertToGUIStyle IBitFlag&, Boolean
disable None
disableGroup None
disableNotification None
disableTabStop None
disableUpdate None
dispatchRemainingHandlers IEvent&, Boolean
enable Boolean
enableUpdate Boolean
handleException IException&, IEvent&
hide None
hideSourceEmphasis None
isLayoutDistorted unsigned long
matchForMnemonic unsigned short
notifyObservers INotificationEvent&
positionBehindSibling IWindowHandle&
positionBehindSiblings None
positionOnSiblings None
postEvent unsigned long, IEventParameter1&,
IEventParameter2&
refresh IRectangle&
releasePointer None
releasePresSpace IPresSpaceHandle&
resetActiveColor None
resetBackgroundColor None
resetBorderColor None
resetDisabledBackgroundColor None
resetDisabledForegroundColor None
resetFont None
resetForegroundColor None
resetHiliteBackgroundColor None
resetHiliteForegroundColor None
resetInactiveColor None
resetMinimumSize None
resetShadowColor None
scrollViewHorizontallyTo unsigned long
scrollViewVerticallyTo unsigned long
sendEvent unsigned long, IEventParameter1&,
IEventParameter2&
setFocus None
setLayoutDistorted unsigned long, unsigned long
show Boolean
showSourceEmphasis Boolean
ΓòÉΓòÉΓòÉ <hidden> Events - IViewPort ΓòÉΓòÉΓòÉ
Event Notification ID
commandEvent commandId
gotFocusEvent FOCUSTRUEID
inputDisabledEvent ENABLEFALSEID
inputEnabledEvent ENABLETRUEID
lostFocusEvent FOCUSFALSEID
systemCommandEvent systemCommandId
visibilityDisabledEvent VISIBLEFALSEID
visibilityEnabledEvent VISIBLETRUEID
ΓòÉΓòÉΓòÉ <hidden> General Settings - IViewPort ΓòÉΓòÉΓòÉ
Name Sets the name of the part.
Default value: The name of the part
Width Sets the width of the window.
Default value: 0
Height Sets the height of the window.
Default value: 0
Subpart name Sets the name of the subpart (a part placed on a composite part).
Default value: The name of the part
ΓòÉΓòÉΓòÉ <hidden> Control Settings - IViewPort ΓòÉΓòÉΓòÉ
Fly over short text Specifies the short text for the fly-over text control.
Default value: None
Fly over long text Specifies the long text for the fly-over text control.
Default value: None
Window id Sets the window identifier.
Default value: None
Help panel id Sets the help panel identifier for the part.
Default value: None
Enabled Enables the handler by default.
Default value: Selected
ΓòÉΓòÉΓòÉ <hidden> Styles Settings - IViewPort ΓòÉΓòÉΓòÉ
defaultStyle() Resets the part to the original default style.
Default value: Selected
noViewWindowFill If specified, the view port does not clear out the view
window before redrawing as the window is scrolled. The view window assumes
responsibility to repaint its entire rectangle. This can optimize redrawing
the view window.
Default value: The default is off, and the Default radio button is selected.
clipChildren Excludes the area occupied by the children of the window when
drawing in the window. Child windows are always "clipped" to their parent
window. When a parent window is painted, the clipChildren style controls
whether the invalidated region of the parent window includes the area
occupied by its children, thus preventing a window from painting over its
child windows.
Default value: The Default radio button is selected.
clipSiblings Controls which sibling window is displayed on top when multiple
siblings are displayed. Sibling windows are windows that share the same
parent window. Assign the clipSiblings style to the sibling window that you
want displayed on top of the other siblings, in Z-order.
Default value: The Default radio button is selected.
clipToParent Allows a window to paint outside of its window boundary up to the
window boundary of its parent.
Default value: The Default radio button is selected.
saveBits Optimizes the painting of a window by saving the screen image of the
area under the window as a bitmap and then using the bitmap to redraw the
window, when necessary.
Default value: The Default radio button is selected.
synchPaint Synchronously repaints the window. Without this style, painting
only occurs if there are no other events waiting to be processed.
Default value: The Default radio button is selected.
visible Makes the window visible. In general, controls are constructed as
visible, and frame windows are constructed as invisible.
Default value: The default is on, and the Default radio button is selected.
ΓòÉΓòÉΓòÉ <hidden> Handlers Settings - IViewPort ΓòÉΓòÉΓòÉ
Handler name Sets the name of the default handler.
Default value: None
Handler list Sets the name of the handler for the MLE control.
Default value: None
Add after Adds the new choice after the selected choice in the list. If no
choice is selected, the new choice is added after the first choice in the
list.
Default value: Highlighted
Add before Adds the new choice before the selected choice in the list. If no
choice is selected, the new choice is added before the first choice in the
list.
Default value: Not highlighted
Move Determines whether a part and its descendants can be moved to a new
location.
Default value: Not highlighted
Remove Removes one item from the part and returns the count of the number of
items that remain.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ <hidden> Color Settings - IViewPort ΓòÉΓòÉΓòÉ
Color area Sets the color of the given area. Choices are as follows:
Background
Sets the color for background text
Default value: Background is selected
Color selection Enables color selection by either color values or RGB values.
Select Colors or RGB. If you select Colors, you can set the Color values. If
you select RGB, you can set the RGB values.
Default value: Colors selected
Color values Sets the color value of the window area, or sets the passed
default if no color for the area has been set.
Default value: None
RGB values Sets the color values for the canvas.
Default value: Red=255, Green=255, Blue=255
ΓòÉΓòÉΓòÉ <hidden> Size/Position Settings - IViewPort ΓòÉΓòÉΓòÉ
X field Sets the X coordinate of the part.
Default value: The x coordinate of the part currently positioned on the
free-form surface
Y field Sets the Y coordinate of the point.
Default value: The y coordinate of the part currently positioned on the
free-form surface
Width Sets the width of the text.
Default value: None
Height Sets the height of the text.
Default value: None
Minimum size Determines the minimum size of the part.
Select Calculate at execution time or Set value here. If you select
Calculate at execution time, the minimum size is determined dynamically. If
you select Set value here, you can set the Minimum size Width and Height
fields to define a fixed minimum size.
Default value: Calculate at execution time is selected
Width Sets the minimum-allowable width, which is set by the user's class.
Default value: None (calculated at execution time)
Height Sets the minimum-allowable height, which is set by the user's class.
Default value: None (calculated at execution time)
ΓòÉΓòÉΓòÉ <hidden> Font Settings - IViewPort ΓòÉΓòÉΓòÉ
Name Sets the name of the font.
Default value: System proportional
Point size Sets the point size of the font.
Default value: 10
Style Sets the style for the part.
Default value: None
Emphasis Gives the part emphasis. If a part is specified, the emphasis is
drawn around the part.
Default value: None
Edit Opens an edit field on a part or setting.
Default value: Highlighted
Default font Sets the current default font style.
Default value: Not highlighted
ΓòÉΓòÉΓòÉ 3.60. IVSequence ΓòÉΓòÉΓòÉ
Overview
Part Description
Building Guidelines
Part Interface
Attributes
Actions
Events
Settings Pages
General
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IVSequence ΓòÉΓòÉΓòÉ
Title: IBM VSequence template collection class
Class name: IVSequence
Base part: IVGSequence
Part type: Nonvisual part
Part file: vbbase.vbb
An IVSequence part is an ordered collection of elements.
The user interacts with objects in the collection through other parts, such as
list boxes and combination boxes. The user does not interact directly with an
IVSequence part.
Use an IVSequence part to manage objects in an ordered collection.
ΓòÉΓòÉΓòÉ <hidden> Building Guidelines - IVSequence ΓòÉΓòÉΓòÉ
When building with an IVSequence part, you can do the following:
Define the type of objects in the sequence. Do this by entering a pointer
to the part type (part type and *) in the Item type field on the
IVSequence General settings page.
Identify initial objects in the collection. Do this by entering the
choices in the Contents field on the IVSequence General settings page.
Add a given object to the collection when a push button is pressed. Do
this by connecting the IPushButton buttonClickEvent feature to the
IVSequence add action. Then, connect the this attribute of the object to
the buttonClickEvent-to-add connection, providing the element parameter
for the add action.
Add an object with a known attribute value to the collection when a push
button is pressed. For example, add a key attribute value representing an
object to an ICollectionViewComboBox part when the user enters the
attribute in the combination box entry field and presses an Add push
button. Do this by connecting the IPushButton buttonClickEvent feature to
an add action of a nonvisual object manager part. Then, connect the
object text attribute to the buttonClickEvent-to-add connection,
providing the attribute parameter for the add action.
The nonvisual object manager could either find an existing object with
the key attribute value or create a new object with the key. To add the
object to the sequence, the object manager part could either call the
IVSequence add function or generate an event that you can connect to the
IVSequence add action, passing the object as the element parameter.
Remove an object with a known index from the collection when a push
button is pressed. For example, remove a selected object item from an
ICollectionViewComboBox part when the user presses a Remove push button.
Do this by connecting the IPushButton buttonClickEvent feature to the
IVSequence removeAtPosition action. Then, connect the
ICollectionViewComboBox selection attribute to the
buttonClickEvent-to-removeAtPosition connection, providing the position
parameter for the removeAtPosition action.
ΓòÉΓòÉΓòÉ <hidden> Attributes - IVSequence ΓòÉΓòÉΓòÉ
Attribute S E Data type
anyElement Element const&
base Base&
bounded IBoolean
consistent IBoolean
empty IBoolean
enabledForNotification Γûá Boolean
firstElement Element const&
full IBoolean
lastElement Element const&
maxNumberOfElements INumber
newCursor ICursor*
numberOfElements INumber
ΓòÉΓòÉΓòÉ <hidden> Actions - IVSequence ΓòÉΓòÉΓòÉ
Action Parameters
add Element const&, ICursor&
addAllFrom IACollection < Element > const&
addAsFirst Element const&
addAsLast Element const&, ICursor&
addAtPosition IPosition, Element const&
allElementsDo IBoolean ( * function ) ( Element&, void * ) ,
void*
compare IASequence < Element > const&, long ( *
comparisonFunction )
copy IACollection < Element > const&
disableNotification None
elementAtPosition IPosition
operator = IVSequenceOnBase <, Base > const&
removeAll IBoolean ( * property ) ( Element const&, void
* ) , void*
removeAtPosition IPosition
removeFirst None
removeLast None
sort long ( * comparisonFunction )
ΓòÉΓòÉΓòÉ <hidden> Events - IVSequence ΓòÉΓòÉΓòÉ
Event Notification ID
addedEvent addedId
modifiedEvent modifiedId
removedEvent removedId
replacedEvent replacedId
ΓòÉΓòÉΓòÉ <hidden> General Settings - IVSequence ΓòÉΓòÉΓòÉ
Subpart name Sets the name of the subpart (a part placed on a composite part).
Default value: The name of the part
Item type Specifies the part type of objects in the collection.
Default value: None
Contents Sets initial items for the part.
Default value: None
ΓòÉΓòÉΓòÉ 4. Class Interface Parts ΓòÉΓòÉΓòÉ
The following chapters provide information on all class interface parts except
those on the parts palette. Class interface parts are not fully enabled parts.
ΓòÉΓòÉΓòÉ 4.1. I0String ΓòÉΓòÉΓòÉ
Overview
Part Description
Part Interface
Attributes
Actions
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - I0String ΓòÉΓòÉΓòÉ
Title: IBM string class, indexed starting at 0
Class name: I0String
Base part: IString
Part type: Class interface part
Part file: vbbase.vbb
ΓòÉΓòÉΓòÉ <hidden> Attributes - I0String ΓòÉΓòÉΓòÉ
Attribute S Data type
alphabetic Boolean
alphanumeric Boolean
asDebugInfo IString
asDouble double
asInt long
asString IString
asUnsigned unsigned long
binaryDigits Boolean
control Boolean
digits Boolean
graphics Boolean
hexDigits Boolean
includesDBCS Boolean
includesMBCS Boolean
includesSBCS Boolean
isASCII Boolean
isDBCS Boolean
isLowerCase Boolean
isMBCS Boolean
isSBCS Boolean
isUpperCase Boolean
length unsigned
numWords unsigned
printable Boolean
punctuation Boolean
size unsigned
validDBCS Boolean
validMBCS Boolean
whiteSpace Boolean
ΓòÉΓòÉΓòÉ <hidden> Actions - I0String ΓòÉΓòÉΓòÉ
Action Parameters
b2c IString&
b2d IString&
b2x IString&
c2b None
c2d None
c2x IString&
center IString&, unsigned, char
change IString&, IString&, IString&, unsigned,
unsigned
charType unsigned
copy IString&, unsigned
d2b IString&
d2c None
d2x None
includes IStringTest&
indexOf char*, unsigned
indexOfAnyBut IString&, unsigned
indexOfAnyOf IStringTest&, unsigned
indexOfPhrase IString&, unsigned
indexOfWord unsigned
insert IString&, IString&, unsigned, char
isAbbreviationFor char*, unsigned
isLike char*, unsigned, char, char
lastIndexOf char, unsigned
lastIndexOfAnyBut IStringTest&, unsigned
lastIndexOfAnyOf IString&, unsigned
leftJustify unsigned, char
lengthOfWord unsigned
lineFrom istream&, char
lowerCase IString&
occurrencesOf char*, unsigned, unsigned
operator & IString&
operator &= char*
operator + IString&
operator += char*
operator = IString&
operator char * IString&
operator signed char * IString&
operator unsigned char * IString&
operator [] unsigned
operator ^ IString&
operator ^= char*
operator | IString&
operator |= char*
operator ~ None
overlayWith IString&, char*, unsigned, char
remove IString&, unsigned, unsigned
removeWords unsigned, unsigned
reverse IString&
rightJustify unsigned, char
space unsigned, char
strip IString&, char
stripBlanks IString&
stripLeading IString&, char*
stripLeadingBlanks IString&
stripTrailing IString&, IStringTest&
stripTrailingBlanks IString&
subString unsigned
translate IString&, IString&, char
upperCase IString&
word unsigned
wordIndexOfPhrase IString&, unsigned
words unsigned, unsigned
x2b None
x2c IString&
x2d IString&
ΓòÉΓòÉΓòÉ 4.2. IAccelerator ΓòÉΓòÉΓòÉ
Overview
Part Description
Part Interface
Attributes
Actions
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IAccelerator ΓòÉΓòÉΓòÉ
Title: IBM class to access shortcut-key table
Class name: IAccelerator
Base part: IBase
Part type: Class interface part
Part file: vbbase.vbb
ΓòÉΓòÉΓòÉ <hidden> Attributes - IAccelerator ΓòÉΓòÉΓòÉ
Attribute S Data type
asDebugInfo IString
asString IString
handle IAccelTblHandle
isSet Boolean
owner IWindow*
ΓòÉΓòÉΓòÉ <hidden> Actions - IAccelerator ΓòÉΓòÉΓòÉ
Action Parameters
remove None
reset None
set IAccelTblHandle&
unset None
ΓòÉΓòÉΓòÉ 4.3. ICLibErrorInfo ΓòÉΓòÉΓòÉ
Overview
Part Description
Part Interface
Attributes
Actions
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - ICLibErrorInfo ΓòÉΓòÉΓòÉ
Title: IBM access to CLib error information
Class name: ICLibErrorInfo
Base part: IErrorInfo
Part type: Class interface part
Part file: vbbase.vbb
ΓòÉΓòÉΓòÉ <hidden> Attributes - ICLibErrorInfo ΓòÉΓòÉΓòÉ
Attribute S Data type
asDebugInfo IString
asString IString
available Boolean
errorId unsigned long
text const char*
ΓòÉΓòÉΓòÉ <hidden> Actions - ICLibErrorInfo ΓòÉΓòÉΓòÉ
Action Parameters
operator const char * None
throwCLibError char*, IExceptionLocation&,
IErrorInfo::ExceptionType,
IException::Severity
throwError IExceptionLocation&,
IErrorInfo::ExceptionType,
IException::Severity, IException::Severity
ΓòÉΓòÉΓòÉ 4.4. IClipboard ΓòÉΓòÉΓòÉ
Overview
Part Description
Part Interface
Attributes
Actions
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IClipboard ΓòÉΓòÉΓòÉ
Title: IBM clipboard class
Class name: IClipboard
Base part: IVBase
Part type: Class interface part
Part file: vbbase.vbb
ΓòÉΓòÉΓòÉ <hidden> Attributes - IClipboard ΓòÉΓòÉΓòÉ
Attribute S Data type
asDebugInfo IString
asString IString
bitmap Γûá IBitmapHandle
formatCount unsigned long
hasBitmap Boolean
hasText Boolean
isOpen Boolean
owner IWindowHandle
primaryFormat IString
text Γûá IString
ΓòÉΓòÉΓòÉ <hidden> Actions - IClipboard ΓòÉΓòÉΓòÉ
Action Parameters
close None
data char*
empty None
format Cursor&
formatAsHandle char*
hasData char*
open None
registerFormat char*
setData char*, void*, unsigned long
setHandle const char*, unsigned long
ΓòÉΓòÉΓòÉ 4.5. IColor ΓòÉΓòÉΓòÉ
Overview
Part Description
Part Interface
Attributes
Actions
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IColor ΓòÉΓòÉΓòÉ
Title: IBM color class
Class name: IColor
Base part: IVBase
Part type: Class interface part
Part file: vbbase.vbb
ΓòÉΓòÉΓòÉ <hidden> Attributes - IColor ΓòÉΓòÉΓòÉ
Attribute S Data type
asDebugInfo IString
asRGBLong long
asString IString
blueMix Γûá unsigned char
greenMix Γûá unsigned char
index long
redMix Γûá unsigned char
value Color
ΓòÉΓòÉΓòÉ <hidden> Actions - IColor ΓòÉΓòÉΓòÉ
Action Parameters
operator != IColor&
operator = IColor&
operator == IColor&
ΓòÉΓòÉΓòÉ 4.6. IContainerObject ΓòÉΓòÉΓòÉ
Overview
Part Description
Part Interface
Attributes
Actions
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IContainerObject ΓòÉΓòÉΓòÉ
Title: IBM base class for all container items
Class name: IContainerObject
Base part: IVBase
Part type: Class interface part
Part file: vbbase.vbb
ΓòÉΓòÉΓòÉ <hidden> Attributes - IContainerObject ΓòÉΓòÉΓòÉ
Attribute S Data type
asDebugInfo IString
asString IString
dropOnAble Γûá Boolean
helpId unsigned long
icon Γûá IPointerHandle
iconText Γûá IString
inUse Γûá Boolean
objectCopy IContainerObject*
open Γûá Boolean
refreshOn Γûá Boolean
visible Γûá Boolean
writeable Γûá Boolean
ΓòÉΓòÉΓòÉ <hidden> Actions - IContainerObject ΓòÉΓòÉΓòÉ
Action Parameters
disableDataUpdate IContainerControl*
disableDrop IContainerControl*
handleCursoredChange IContainerControl*, Boolean
handleInuseChange IContainerControl*, Boolean
handleOpen IContainerControl*
handleSelectedChange IContainerControl*, Boolean
handleTreeCollapse IContainerControl*
handleTreeExpand IContainerControl*
hide IContainerControl*
operator == IContainerObject&
operator delete , const char*, size_t
operator new , const char*, size_t
refresh IContainerControl*
removeInUse IContainerControl*
setClosed None
setRefreshOff None
ΓòÉΓòÉΓòÉ 4.7. IDate ΓòÉΓòÉΓòÉ
Overview
Part Description
Part Interface
Attributes
Actions
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IDate ΓòÉΓòÉΓòÉ
Title: IBM date class
Class name: IDate
Base part: IBase
Part type: Class interface part
Part file: vbbase.vbb
ΓòÉΓòÉΓòÉ <hidden> Attributes - IDate ΓòÉΓòÉΓòÉ
Attribute S Data type
asCDATE _CDATE
asDebugInfo IString
asString IString
dayOfMonth int
dayOfWeek DayOfWeek
dayOfYear int
julianDate unsigned long
monthOfYear Month
today IDate
year int
ΓòÉΓòÉΓòÉ <hidden> Actions - IDate ΓòÉΓòÉΓòÉ
Action Parameters
dayName DayOfWeek
daysInMonth Month, int
daysInYear int
isLeapYear int
isValid int, Month, int
monthName Month
operator != IDate&
operator + int
operator += int
operator - IDate&
operator -= int
operator < IDate&
operator <= IDate&
operator == IDate&
operator > IDate&
operator >= IDate&
ΓòÉΓòÉΓòÉ 4.8. IDynamicLinkLibrary ΓòÉΓòÉΓòÉ
Overview
Part Description
Part Interface
Attributes
Actions
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IDynamicLinkLibrary ΓòÉΓòÉΓòÉ
Title: IBM support for linking to DLL
Class name: IDynamicLinkLibrary
Base part: IResourceLibrary
Part type: Class interface part
Part file: vbbase.vbb
ΓòÉΓòÉΓòÉ <hidden> Attributes - IDynamicLinkLibrary ΓòÉΓòÉΓòÉ
Attribute S Data type
asDebugInfo IString
asString IString
fileName IString
handle IModuleHandle
ΓòÉΓòÉΓòÉ <hidden> Actions - IDynamicLinkLibrary ΓòÉΓòÉΓòÉ
Action Parameters
close None
isEntryPoint32Bit unsigned long
loadAccelTable unsigned long
loadBitmap unsigned long, Boolean
loadDialog unsigned long, IWindow*, IWindow*, IWinProc*,
void*
loadHelpTable IWindow*, unsigned long
loadIcon unsigned long, Boolean
loadMenu unsigned long, IWindow*
loadMessage unsigned long
loadPointer unsigned long, Boolean
loadString unsigned long
open None
operator = IResourceLibrary&
procAddress char*
tryToLoadBitmap unsigned long, ISize&, Boolean
tryToLoadIcon unsigned long, Boolean
tryToLoadMessage unsigned long
tryToLoadString unsigned long
ΓòÉΓòÉΓòÉ 4.9. IFlyOverHelpHandler ΓòÉΓòÉΓòÉ
Overview
Part Description
Part Interface
Attributes
Actions
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IFlyOverHelpHandler ΓòÉΓòÉΓòÉ
Title: IBM handler class for fly-over help
Class name: IFlyOverHelpHandler
Base part: IHandler
Part type: Class interface part
Part file: vbbase.vbb
ΓòÉΓòÉΓòÉ <hidden> Attributes - IFlyOverHelpHandler ΓòÉΓòÉΓòÉ
Attribute S Data type
asDebugInfo IString
asString IString
defaultText Γûá IString
delayTime Γûá unsigned long
enabled Γûá Boolean
flyTextControl Γûá IFlyText*
flyTextStringTableOffset Γûá long
longStringTableOffset Γûá long
longTextControl Γûá ITextControl*
resourceLibrary Γûá IResourceLibrary&
ΓòÉΓòÉΓòÉ <hidden> Actions - IFlyOverHelpHandler ΓòÉΓòÉΓòÉ
Action Parameters
disable None
flyHelpText IWindowHandle&
longHelpText IWindowHandle&
removeHelpText IWindowHandle&
setHelpText IWindowHandle&, IString&, IString&
start IWindow*
stop IWindow*
ΓòÉΓòÉΓòÉ 4.10. IFont ΓòÉΓòÉΓòÉ
Overview
Part Description
Part Interface
Attributes
Actions
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IFont ΓòÉΓòÉΓòÉ
Title: IBM class to manage fonts
Class name: IFont
Base part: IVBase
Part type: Class interface part
Part file: vbbase.vbb
ΓòÉΓòÉΓòÉ <hidden> Attributes - IFont ΓòÉΓòÉΓòÉ
Attribute S Data type
asDebugInfo IString
asString IString
avgCharWidth unsigned long
avgLowercase unsigned long
avgUppercase unsigned long
bitmap Boolean
bitmapOnly Boolean
bold Γûá Boolean
externalLeading unsigned long
fattrs const struct _FATTRS*
fixed Boolean
fontmetrics const struct _FONTMETRICS*
internalLeading unsigned long
italic Γûá Boolean
maxAscender unsigned long
maxCharHeight unsigned long
maxDescender unsigned long
maxLowercaseAscender unsigned long
maxLowercaseDescender unsigned long
maxSize ISize
maxUppercaseSize ISize
name Γûá IString
nonPropOnly Boolean
outline Γûá Boolean
pointSize Γûá unsigned long
strikeout Γûá Boolean
subscriptOffset ISize
subscriptSize ISize
superscriptOffset ISize
superscriptSize ISize
underscore Γûá Boolean
vectorOnly Boolean
ΓòÉΓòÉΓòÉ <hidden> Actions - IFont ΓòÉΓòÉΓòÉ
Action Parameters
beginUsingFont IPresSpaceHandle&
charWidth char
endUsingFont IPresSpaceHandle&
minTextWidth char*
operator = IFont&
setAllEmphasis Boolean
setCharHeight unsigned long, IPresSpaceHandle&
setCharSize ISize&, IPresSpaceHandle&
setCharWidth unsigned long, IPresSpaceHandle&
setDirection Direction
setFontAngle IPoint&, IPresSpaceHandle&
setFontShear IPoint&, IPresSpaceHandle&
setWindowFont IWindow*
textLines char*, unsigned long
textWidth char*
useBitmapOnly Boolean, IPresSpaceHandle&
useNonPropOnly Boolean, IPresSpaceHandle&
useVectorOnly Boolean, IPresSpaceHandle&
ΓòÉΓòÉΓòÉ 4.11. IGUIErrorInfo ΓòÉΓòÉΓòÉ
Overview
Part Description
Part Interface
Attributes
Actions
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IGUIErrorInfo ΓòÉΓòÉΓòÉ
Title: IBM access to GUI error information
Class name: IGUIErrorInfo
Base part: IErrorInfo
Part type: Class interface part
Part file: vbbase.vbb
ΓòÉΓòÉΓòÉ <hidden> Attributes - IGUIErrorInfo ΓòÉΓòÉΓòÉ
Attribute S Data type
asDebugInfo IString
asString IString
available Boolean
errorId unsigned long
text const char*
ΓòÉΓòÉΓòÉ <hidden> Actions - IGUIErrorInfo ΓòÉΓòÉΓòÉ
Action Parameters
operator const char * Boolean, IPresSpaceHandle&
throwError IExceptionLocation&,
IErrorInfo::ExceptionType,
IException::Severity, IException::Severity
throwGUIError char*, IExceptionLocation&,
IErrorInfo::ExceptionType,
IException::Severity
ΓòÉΓòÉΓòÉ 4.12. IHandle ΓòÉΓòÉΓòÉ
Overview
Part Description
Part Interface
Attributes
Actions
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IHandle ΓòÉΓòÉΓòÉ
Title: IBM abstract class for all handles
Class name: IHandle
Base part: IBase
Part type: Class interface part
Part file: vbbase.vbb
ΓòÉΓòÉΓòÉ <hidden> Attributes - IHandle ΓòÉΓòÉΓòÉ
Attribute S Data type
asDebugInfo IString
asString IString
asUnsigned unsigned long
ΓòÉΓòÉΓòÉ <hidden> Actions - IHandle ΓòÉΓòÉΓòÉ
Action Parameters
operator Value char*, IExceptionLocation&,
IErrorInfo::ExceptionType,
IException::Severity
ΓòÉΓòÉΓòÉ 4.13. IMM24FramesPerSecondTime ΓòÉΓòÉΓòÉ
Overview
Part Description
Part Interface
Attributes
Actions
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IMM24FramesPerSecondTime ΓòÉΓòÉΓòÉ
Title: IBM support of 24-frames-per-second video
Class name: IMM24FramesPerSecondTime
Base part: IMMHourMinSecFrameTime
Part type: Class interface part
Part file: vbmm.vbb
ΓòÉΓòÉΓòÉ <hidden> Attributes - IMM24FramesPerSecondTime ΓòÉΓòÉΓòÉ
Attribute S Data type
asDebugInfo IString
asMMTime unsigned long
asString IString
frames unsigned long
framesPerSecond unsigned long
hours unsigned long
hundredths unsigned long
minutes unsigned long
ordinal unsigned long
seconds unsigned long
thousandths unsigned long
valid Boolean
ΓòÉΓòÉΓòÉ <hidden> Actions - IMM24FramesPerSecondTime ΓòÉΓòÉΓòÉ
Action Parameters
operator != IMMTime&
operator + IMMTime&
operator += IMMTime&
operator - IMMTime&
operator -= IMMTime&
operator < IMMTime&
operator <= IMMTime&
operator = IMMTime&
operator == IMMTime&
operator > IMMTime&
operator >= IMMTime&
operator unsigned long IMMTime&
setTimeToOrdinal unsigned long
ΓòÉΓòÉΓòÉ 4.14. IMM25FramesPerSecondTime ΓòÉΓòÉΓòÉ
Overview
Part Description
Part Interface
Attributes
Actions
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IMM25FramesPerSecondTime ΓòÉΓòÉΓòÉ
Title: IBM support of 25-frames-per-second video
Class name: IMM25FramesPerSecondTime
Base part: IMMHourMinSecFrameTime
Part type: Class interface part
Part file: vbmm.vbb
ΓòÉΓòÉΓòÉ <hidden> Attributes - IMM25FramesPerSecondTime ΓòÉΓòÉΓòÉ
Attribute S Data type
asDebugInfo IString
asMMTime unsigned long
asString IString
frames unsigned long
framesPerSecond unsigned long
hours unsigned long
hundredths unsigned long
minutes unsigned long
ordinal unsigned long
seconds unsigned long
thousandths unsigned long
valid Boolean
ΓòÉΓòÉΓòÉ <hidden> Actions - IMM25FramesPerSecondTime ΓòÉΓòÉΓòÉ
Action Parameters
operator != IMMTime&
operator + IMMTime&
operator += IMMTime&
operator - IMMTime&
operator -= IMMTime&
operator < IMMTime&
operator <= IMMTime&
operator = IMMTime&
operator == IMMTime&
operator > IMMTime&
operator >= IMMTime&
operator unsigned long IMMTime&
setTimeToOrdinal unsigned long
ΓòÉΓòÉΓòÉ 4.15. IMM30FramesPerSecondTime ΓòÉΓòÉΓòÉ
Overview
Part Description
Part Interface
Attributes
Actions
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IMM30FramesPerSecondTime ΓòÉΓòÉΓòÉ
Title: IBM support of 30-frames-per-second video
Class name: IMM30FramesPerSecondTime
Base part: IMMHourMinSecFrameTime
Part type: Class interface part
Part file: vbmm.vbb
ΓòÉΓòÉΓòÉ <hidden> Attributes - IMM30FramesPerSecondTime ΓòÉΓòÉΓòÉ
Attribute S Data type
asDebugInfo IString
asMMTime unsigned long
asString IString
frames unsigned long
framesPerSecond unsigned long
hours unsigned long
hundredths unsigned long
minutes unsigned long
ordinal unsigned long
seconds unsigned long
thousandths unsigned long
valid Boolean
ΓòÉΓòÉΓòÉ <hidden> Actions - IMM30FramesPerSecondTime ΓòÉΓòÉΓòÉ
Action Parameters
operator != IMMTime&
operator + IMMTime&
operator += IMMTime&
operator - IMMTime&
operator -= IMMTime&
operator < IMMTime&
operator <= IMMTime&
operator = IMMTime&
operator == IMMTime&
operator > IMMTime&
operator >= IMMTime&
operator unsigned long IMMTime&
setTimeToOrdinal unsigned long
ΓòÉΓòÉΓòÉ 4.16. IMMAudioBuffer ΓòÉΓòÉΓòÉ
Overview
Part Description
Part Interface
Attributes
Actions
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IMMAudioBuffer ΓòÉΓòÉΓòÉ
Title: IBM audio buffer
Class name: IMMAudioBuffer
Base part: IBase
Part type: Class interface part
Part file: vbmm.vbb
ΓòÉΓòÉΓòÉ <hidden> Attributes - IMMAudioBuffer ΓòÉΓòÉΓòÉ
Attribute S Data type
asDebugInfo IString
asString IString
bitsPerSample Γûá unsigned long
blockAlignment Γûá unsigned long
bytesPerSecond Γûá unsigned long
channels Γûá unsigned long
contentType Γûá ContentType
data Γûá IString
format Γûá Format
headerData IString
length unsigned long
mediaType Γûá unsigned long
samplesPerSecond Γûá unsigned long
ΓòÉΓòÉΓòÉ <hidden> Actions - IMMAudioBuffer ΓòÉΓòÉΓòÉ
Action Parameters
operator = IMMAudioBuffer&
ΓòÉΓòÉΓòÉ 4.17. IMMAudioCDContents ΓòÉΓòÉΓòÉ
Overview
Part Description
Part Interface
Attributes
Actions
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IMMAudioCDContents ΓòÉΓòÉΓòÉ
Title: IBM table of contents for audio compact disc
Class name: IMMAudioCDContents
Base part: IVBase
Part type: Class interface part
Part file: vbmm.vbb
ΓòÉΓòÉΓòÉ <hidden> Attributes - IMMAudioCDContents ΓòÉΓòÉΓòÉ
Attribute S Data type
asDebugInfo IString
asString IString
discId IString
numberOfEntries unsigned long
numberOfTracks unsigned long
valid Boolean
ΓòÉΓòÉΓòÉ <hidden> Actions - IMMAudioCDContents ΓòÉΓòÉΓòÉ
Action Parameters
addEntryAsFirst unsigned long
operator = IMMAudioCDContents&
ΓòÉΓòÉΓòÉ 4.18. IMMAudioHeader ΓòÉΓòÉΓòÉ
Overview
Part Description
Part Interface
Attributes
Actions
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IMMAudioHeader ΓòÉΓòÉΓòÉ
Title: IBM audio header
Class name: IMMAudioHeader
Base part: IVBase
Part type: Class interface part
Part file: vbmm.vbb
ΓòÉΓòÉΓòÉ <hidden> Attributes - IMMAudioHeader ΓòÉΓòÉΓòÉ
Attribute S Data type
asDebugInfo IString
asString IString
averageBytesPerSecond Γûá unsigned long
bitsPerSample Γûá unsigned long
blockAlign Γûá unsigned long
channels Γûá unsigned long
contentType Γûá ContentType
formatTag Γûá FormatTag
headerData const void*
samplesPerSecond Γûá unsigned long
ΓòÉΓòÉΓòÉ <hidden> Actions - IMMAudioHeader ΓòÉΓòÉΓòÉ
Action Parameters
operator = IMMAudioHeader&
ΓòÉΓòÉΓòÉ 4.19. IMMErrorInfo ΓòÉΓòÉΓòÉ
Overview
Part Description
Part Interface
Attributes
Actions
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IMMErrorInfo ΓòÉΓòÉΓòÉ
Title: IBM multimedia error information
Class name: IMMErrorInfo
Base part: IErrorInfo
Part type: Class interface part
Part file: vbmm.vbb
ΓòÉΓòÉΓòÉ <hidden> Attributes - IMMErrorInfo ΓòÉΓòÉΓòÉ
Attribute S Data type
asDebugInfo IString
asString IString
available Boolean
errorId unsigned long
text const char*
ΓòÉΓòÉΓòÉ <hidden> Actions - IMMErrorInfo ΓòÉΓòÉΓòÉ
Action Parameters
operator const char * IMMAudioHeader&
throwError IExceptionLocation&,
IErrorInfo::ExceptionType,
IException::Severity, IException::Severity
throwMMError unsigned long, char*, IExceptionLocation&,
IErrorInfo::ExceptionType,
IException::Severity
ΓòÉΓòÉΓòÉ 4.20. IMMHourMinSecFrameTime ΓòÉΓòÉΓòÉ
Overview
Part Description
Part Interface
Attributes
Actions
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IMMHourMinSecFrameTime ΓòÉΓòÉΓòÉ
Title: IBM support of hour/minute/second/frame time format
Class name: IMMHourMinSecFrameTime
Base part: IMMTime
Part type: Class interface part
Part file: vbmm.vbb
ΓòÉΓòÉΓòÉ <hidden> Attributes - IMMHourMinSecFrameTime ΓòÉΓòÉΓòÉ
Attribute S Data type
asDebugInfo IString
asMMTime unsigned long
asString IString
frames unsigned long
framesPerSecond unsigned long
hours unsigned long
hundredths unsigned long
minutes unsigned long
ordinal unsigned long
seconds unsigned long
thousandths unsigned long
valid Boolean
ΓòÉΓòÉΓòÉ <hidden> Actions - IMMHourMinSecFrameTime ΓòÉΓòÉΓòÉ
Action Parameters
operator != IMMTime&
operator + IMMTime&
operator += IMMTime&
operator - IMMTime&
operator -= IMMTime&
operator < IMMTime&
operator <= IMMTime&
operator = IMMTime&
operator == IMMTime&
operator > IMMTime&
operator >= IMMTime&
operator unsigned long IMMTime&
setTimeToOrdinal unsigned long
ΓòÉΓòÉΓòÉ 4.21. IMMHourMinSecTime ΓòÉΓòÉΓòÉ
Overview
Part Description
Part Interface
Attributes
Actions
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IMMHourMinSecTime ΓòÉΓòÉΓòÉ
Title: IBM support of hour/minute/second time format
Class name: IMMHourMinSecTime
Base part: IMMTime
Part type: Class interface part
Part file: vbmm.vbb
ΓòÉΓòÉΓòÉ <hidden> Attributes - IMMHourMinSecTime ΓòÉΓòÉΓòÉ
Attribute S Data type
asDebugInfo IString
asMMTime unsigned long
asString IString
hours unsigned long
hundredths unsigned long
minutes unsigned long
ordinal unsigned long
seconds unsigned long
thousandths unsigned long
valid Boolean
ΓòÉΓòÉΓòÉ <hidden> Actions - IMMHourMinSecTime ΓòÉΓòÉΓòÉ
Action Parameters
operator != IMMTime&
operator + IMMTime&
operator += IMMTime&
operator - IMMTime&
operator -= IMMTime&
operator < IMMTime&
operator <= IMMTime&
operator = IMMTime&
operator == IMMTime&
operator > IMMTime&
operator >= IMMTime&
operator unsigned long IMMTime&
setTimeToOrdinal unsigned long
ΓòÉΓòÉΓòÉ 4.22. IMMMillisecondTime ΓòÉΓòÉΓòÉ
Overview
Part Description
Part Interface
Attributes
Actions
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IMMMillisecondTime ΓòÉΓòÉΓòÉ
Title: IBM millisecond time class
Class name: IMMMillisecondTime
Base part: IMMTime
Part type: Class interface part
Part file: vbmm.vbb
ΓòÉΓòÉΓòÉ <hidden> Attributes - IMMMillisecondTime ΓòÉΓòÉΓòÉ
Attribute S Data type
asDebugInfo IString
asMMTime unsigned long
asString IString
hours unsigned long
hundredths unsigned long
minutes unsigned long
ordinal unsigned long
seconds unsigned long
thousandths unsigned long
valid Boolean
ΓòÉΓòÉΓòÉ <hidden> Actions - IMMMillisecondTime ΓòÉΓòÉΓòÉ
Action Parameters
operator != IMMTime&
operator + IMMTime&
operator += IMMTime&
operator - IMMTime&
operator -= IMMTime&
operator < IMMTime&
operator <= IMMTime&
operator = IMMTime&
operator == IMMTime&
operator > IMMTime&
operator >= IMMTime&
operator unsigned long IMMTime&
setTimeToOrdinal unsigned long
ΓòÉΓòÉΓòÉ 4.23. IMMMinSecFrameTime ΓòÉΓòÉΓòÉ
Overview
Part Description
Part Interface
Attributes
Actions
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IMMMinSecFrameTime ΓòÉΓòÉΓòÉ
Title: IBM support of minute/second/frame time format
Class name: IMMMinSecFrameTime
Base part: IMMTime
Part type: Class interface part
Part file: vbmm.vbb
ΓòÉΓòÉΓòÉ <hidden> Attributes - IMMMinSecFrameTime ΓòÉΓòÉΓòÉ
Attribute S Data type
asDebugInfo IString
asMMTime unsigned long
asString IString
frames unsigned long
hours unsigned long
hundredths unsigned long
minutes unsigned long
ordinal unsigned long
seconds unsigned long
thousandths unsigned long
valid Boolean
ΓòÉΓòÉΓòÉ <hidden> Actions - IMMMinSecFrameTime ΓòÉΓòÉΓòÉ
Action Parameters
operator != IMMTime&
operator + IMMTime&
operator += IMMTime&
operator - IMMTime&
operator -= IMMTime&
operator < IMMTime&
operator <= IMMTime&
operator = IMMTime&
operator == IMMTime&
operator > IMMTime&
operator >= IMMTime&
operator unsigned long IMMTime&
setTimeToOrdinal unsigned long
ΓòÉΓòÉΓòÉ 4.24. IMMSpeed ΓòÉΓòÉΓòÉ
Overview
Part Description
Part Interface
Attributes
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IMMSpeed ΓòÉΓòÉΓòÉ
Title: IBM speed class
Class name: IMMSpeed
Base part: IVBase
Part type: Class interface part
Part file: vbmm.vbb
ΓòÉΓòÉΓòÉ <hidden> Attributes - IMMSpeed ΓòÉΓòÉΓòÉ
Attribute S Data type
asDebugInfo IString
asString IString
format Format
speed unsigned long
ΓòÉΓòÉΓòÉ 4.25. IMMTime ΓòÉΓòÉΓòÉ
Overview
Part Description
Part Interface
Attributes
Actions
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IMMTime ΓòÉΓòÉΓòÉ
Title: IBM base class for all multimedia time support
Class name: IMMTime
Base part: IVBase
Part type: Class interface part
Part file: vbmm.vbb
ΓòÉΓòÉΓòÉ <hidden> Attributes - IMMTime ΓòÉΓòÉΓòÉ
Attribute S Data type
asDebugInfo IString
asMMTime unsigned long
asString IString
hours unsigned long
hundredths unsigned long
minutes unsigned long
ordinal unsigned long
seconds unsigned long
thousandths unsigned long
valid Boolean
ΓòÉΓòÉΓòÉ <hidden> Actions - IMMTime ΓòÉΓòÉΓòÉ
Action Parameters
operator != IMMTime&
operator + IMMTime&
operator += IMMTime&
operator - IMMTime&
operator -= IMMTime&
operator < IMMTime&
operator <= IMMTime&
operator = IMMTime&
operator == IMMTime&
operator > IMMTime&
operator >= IMMTime&
operator unsigned long IMMTime&
setTimeToOrdinal unsigned long
ΓòÉΓòÉΓòÉ 4.26. IMMTrackMinSecFrameTime ΓòÉΓòÉΓòÉ
Overview
Part Description
Part Interface
Attributes
Actions
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IMMTrackMinSecFrameTime ΓòÉΓòÉΓòÉ
Title: IBM support of track/minute/second/frame time format
Class name: IMMTrackMinSecFrameTime
Base part: IMMTime
Part type: Class interface part
Part file: vbmm.vbb
ΓòÉΓòÉΓòÉ <hidden> Attributes - IMMTrackMinSecFrameTime ΓòÉΓòÉΓòÉ
Attribute S Data type
asDebugInfo IString
asMMTime unsigned long
asString IString
frames unsigned long
hours unsigned long
hundredths unsigned long
minutes unsigned long
ordinal unsigned long
seconds unsigned long
thousandths unsigned long
track unsigned long
valid Boolean
ΓòÉΓòÉΓòÉ <hidden> Actions - IMMTrackMinSecFrameTime ΓòÉΓòÉΓòÉ
Action Parameters
operator != IMMTime&
operator + IMMTime&
operator += IMMTime&
operator - IMMTime&
operator -= IMMTime&
operator < IMMTime&
operator <= IMMTime&
operator = IMMTime&
operator == IMMTime&
operator > IMMTime&
operator >= IMMTime&
operator unsigned long IMMTime&
setTimeToOrdinal unsigned long
ΓòÉΓòÉΓòÉ 4.27. IPair ΓòÉΓòÉΓòÉ
Overview
Part Description
Part Interface
Attributes
Actions
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IPair ΓòÉΓòÉΓòÉ
Title: IBM ordered pair of coordinates
Class name: IPair
Base part: IBase
Part type: Class interface part
Part file: vbbase.vbb
ΓòÉΓòÉΓòÉ <hidden> Attributes - IPair ΓòÉΓòÉΓòÉ
Attribute S Data type
asDebugInfo IString
asString IString
coord1 Γûá Coord
coord2 Γûá Coord
ΓòÉΓòÉΓòÉ <hidden> Actions - IPair ΓòÉΓòÉΓòÉ
Action Parameters
distanceFrom IPair&
dotProduct IPair&
maximum IPair&
minimum IPair&
operator != IPair&
operator %= long
operator *= double
operator += IPair&
operator - None
operator -= IPair&
operator /= double
operator < IPair&
operator <= IPair&
operator == IPair&
operator > IPair&
operator >= IPair&
scaleBy double, double
scaledBy double, double
transpose None
ΓòÉΓòÉΓòÉ 4.28. IPercentAvailable ΓòÉΓòÉΓòÉ
Overview
Part Description
Part Interface
Attributes
Actions
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IPercentAvailable ΓòÉΓòÉΓòÉ
Title: IPercentAvailable
Class name: IPercentAvailable
Base part: IVBase
Part type: Class interface part
Part file: vbbase.vbb
ΓòÉΓòÉΓòÉ <hidden> Attributes - IPercentAvailable ΓòÉΓòÉΓòÉ
Attribute S Data type
asDebugInfo IString
asString IString
valid Boolean
value Γûá unsigned long
ΓòÉΓòÉΓòÉ <hidden> Actions - IPercentAvailable ΓòÉΓòÉΓòÉ
Action Parameters
operator != unsigned long
operator * unsigned long
operator *= unsigned long
operator + unsigned long
operator += unsigned long
operator - unsigned long
operator -= unsigned long
operator / unsigned long
operator /= unsigned long
operator < unsigned long
operator <= unsigned long
operator = IPercentAvailable&
operator == unsigned long
operator > unsigned long
operator >= unsigned long
operator unsigned long unsigned long
ΓòÉΓòÉΓòÉ 4.29. IPoint ΓòÉΓòÉΓòÉ
Overview
Part Description
Part Interface
Attributes
Actions
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IPoint ΓòÉΓòÉΓòÉ
Title: IBM 2-dimensional mathematical point
Class name: IPoint
Base part: IPair
Part type: Class interface part
Part file: vbbase.vbb
ΓòÉΓòÉΓòÉ <hidden> Attributes - IPoint ΓòÉΓòÉΓòÉ
Attribute S Data type
asDebugInfo IString
asPOINTL struct _POINTL
asString IString
coord1 Γûá Coord
coord2 Γûá Coord
x Γûá Coord
y Γûá Coord
ΓòÉΓòÉΓòÉ <hidden> Actions - IPoint ΓòÉΓòÉΓòÉ
Action Parameters
distanceFrom IPair&
dotProduct IPair&
maximum IPair&
minimum IPair&
operator != IPair&
operator %= long
operator *= double
operator += IPair&
operator - None
operator -= IPair&
operator /= double
operator < IPair&
operator <= IPair&
operator == IPair&
operator > IPair&
operator >= IPair&
scaleBy double, double
scaledBy double, double
transpose None
ΓòÉΓòÉΓòÉ 4.30. IPointArray ΓòÉΓòÉΓòÉ
Overview
Part Description
Part Interface
Attributes
Actions
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IPointArray ΓòÉΓòÉΓòÉ
Title: IBM point array
Class name: IPointArray
Base part: IBase
Part type: Class interface part
Part file: vbbase.vbb
ΓòÉΓòÉΓòÉ <hidden> Attributes - IPointArray ΓòÉΓòÉΓòÉ
Attribute S Data type
asDebugInfo IString
asString IString
reversed IPointArray
size unsigned long
ΓòÉΓòÉΓòÉ <hidden> Actions - IPointArray ΓòÉΓòÉΓòÉ
Action Parameters
add IPoint&
insert unsigned long, IPoint&
operator != IPointArray&
operator = IPointArray&
operator == IPointArray&
operator [] unsigned long
remove unsigned long
resize unsigned long
reverse None
ΓòÉΓòÉΓòÉ 4.31. IProfile ΓòÉΓòÉΓòÉ
Overview
Part Description
Part Interface
Attributes
Actions
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IProfile ΓòÉΓòÉΓòÉ
Title: IBM application-profile file
Class name: IProfile
Base part: IVBase
Part type: Class interface part
Part file: vbbase.vbb
ΓòÉΓòÉΓòÉ <hidden> Attributes - IProfile ΓòÉΓòÉΓòÉ
Attribute S Data type
asDebugInfo IString
asString IString
defaultApplicationName Γûá IString
handle IProfileHandle
name IString
numberOfApplications unsigned long
numberOfKeys unsigned long
systemProfile IProfile
userProfile IProfile
ΓòÉΓòÉΓòÉ <hidden> Actions - IProfile ΓòÉΓòÉΓòÉ
Action Parameters
addOrReplaceElementWithKey char*, IString&, char*
containsApplication char*
containsKeyName char*, char*
deleteElementWithApplication char*
deleteElementWithKey char*, char*
elementWithKey char*, char*
integerWithKey char*, char*
operator = IProfile&
ΓòÉΓòÉΓòÉ 4.32. IRange ΓòÉΓòÉΓòÉ
Overview
Part Description
Part Interface
Attributes
Actions
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IRange ΓòÉΓòÉΓòÉ
Title: IBM range of coordinate values
Class name: IRange
Base part: IPair
Part type: Class interface part
Part file: vbbase.vbb
ΓòÉΓòÉΓòÉ <hidden> Attributes - IRange ΓòÉΓòÉΓòÉ
Attribute S Data type
asDebugInfo IString
asString IString
coord1 Γûá Coord
coord2 Γûá Coord
lowerBound Γûá Coord
upperBound Γûá Coord
ΓòÉΓòÉΓòÉ <hidden> Actions - IRange ΓòÉΓòÉΓòÉ
Action Parameters
distanceFrom IPair&
dotProduct IPair&
includes Coord
maximum IPair&
minimum IPair&
operator != IPair&
operator %= long
operator *= double
operator += IPair&
operator - None
operator -= IPair&
operator /= double
operator < IPair&
operator <= IPair&
operator == IPair&
operator > IPair&
operator >= IPair&
scaleBy double, double
scaledBy double, double
transpose None
ΓòÉΓòÉΓòÉ 4.33. IRectangle ΓòÉΓòÉΓòÉ
Overview
Part Description
Part Interface
Attributes
Actions
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IRectangle ΓòÉΓòÉΓòÉ
Title: IBM rectangle, defined by 2 points
Class name: IRectangle
Base part: IBase
Part type: Class interface part
Part file: vbbase.vbb
ΓòÉΓòÉΓòÉ <hidden> Attributes - IRectangle ΓòÉΓòÉΓòÉ
Attribute S Data type
area Coord
asDebugInfo IString
asRECTL struct _RECTL
asString IString
bottom Coord
bottomCenter IPoint
bottomLeft Γûá IPoint
bottomRight IPoint
center IPoint
centerXCenterY IPoint
centerXMaxY IPoint
centerXMinY IPoint
height Coord
left Coord
leftCenter IPoint
maxX Coord
maxXCenterY IPoint
maxXMaxY IPoint
maxXMinY IPoint
maxY Coord
minX Coord
minXCenterY IPoint
minXMaxY IPoint
minXMinY IPoint
minY Coord
right Coord
rightCenter IPoint
size Γûá ISize
top Coord
topCenter IPoint
topLeft IPoint
topRight IPoint
width Coord
ΓòÉΓòÉΓòÉ <hidden> Actions - IRectangle ΓòÉΓòÉΓòÉ
Action Parameters
centerAt IPoint&
centeredAt IPoint&
contains IPoint&
expandBy IPair&
expandedBy Coord
intersects IRectangle&
moveBy IPair&
movedBy IPair&
movedTo IPoint&
operator != IRectangle&
operator & IRectangle&
operator &= IRectangle&
operator == IRectangle&
operator | IRectangle&
operator |= IRectangle&
scaleBy IPair&
scaledBy double
shrinkBy IPair&
shrunkBy IPair&
sizeBy Coord
sizedBy double
sizedTo IPair&
ΓòÉΓòÉΓòÉ 4.34. IResourceId ΓòÉΓòÉΓòÉ
Overview
Part Description
Part Interface
Attributes
Actions
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IResourceId ΓòÉΓòÉΓòÉ
Title: IBM resource identifier
Class name: IResourceId
Base part: IBase
Part type: Class interface part
Part file: vbbase.vbb
ΓòÉΓòÉΓòÉ <hidden> Attributes - IResourceId ΓòÉΓòÉΓòÉ
Attribute S Data type
asDebugInfo IString
asString IString
id unsigned long
resourceLibrary const IResourceLibrary&
ΓòÉΓòÉΓòÉ <hidden> Actions - IResourceId ΓòÉΓòÉΓòÉ
Action Parameters
operator unsigned long IPair&
operator= const IResourceId&
ΓòÉΓòÉΓòÉ 4.35. IResourceLibrary ΓòÉΓòÉΓòÉ
Overview
Part Description
Part Interface
Attributes
Actions
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IResourceLibrary ΓòÉΓòÉΓòÉ
Title: IBM resource file
Class name: IResourceLibrary
Base part: IVBase
Part type: Class interface part
Part file: vbbase.vbb
ΓòÉΓòÉΓòÉ <hidden> Attributes - IResourceLibrary ΓòÉΓòÉΓòÉ
Attribute S Data type
asDebugInfo IString
asString IString
fileName IString
handle IModuleHandle
open Boolean
ΓòÉΓòÉΓòÉ <hidden> Actions - IResourceLibrary ΓòÉΓòÉΓòÉ
Action Parameters
loadAccelTable unsigned long
loadBitmap unsigned long, Boolean
loadDialog unsigned long, IWindow*, IWindow*, IWinProc*,
void*
loadHelpTable IWindow*, unsigned long
loadIcon unsigned long, Boolean
loadMenu unsigned long, IWindow*
loadMessage unsigned long
loadPointer unsigned long, Boolean
loadString unsigned long
operator = IResourceLibrary&
tryToLoadBitmap unsigned long, ISize&, Boolean
tryToLoadIcon unsigned long, Boolean
tryToLoadMessage unsigned long
tryToLoadString unsigned long
ΓòÉΓòÉΓòÉ 4.36. ISize ΓòÉΓòÉΓòÉ
Overview
Part Description
Part Interface
Attributes
Actions
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - ISize ΓòÉΓòÉΓòÉ
Title: IBM support for size in height and width
Class name: ISize
Base part: IPair
Part type: Class interface part
Part file: vbbase.vbb
ΓòÉΓòÉΓòÉ <hidden> Attributes - ISize ΓòÉΓòÉΓòÉ
Attribute S Data type
asDebugInfo IString
asSIZEL SIZEL
asString IString
coord1 Γûá Coord
coord2 Γûá Coord
height Γûá Coord
width Γûá Coord
ΓòÉΓòÉΓòÉ <hidden> Actions - ISize ΓòÉΓòÉΓòÉ
Action Parameters
distanceFrom IPair&
dotProduct IPair&
maximum IPair&
minimum IPair&
operator != IPair&
operator %= long
operator *= double
operator += IPair&
operator - None
operator -= IPair&
operator /= double
operator < IPair&
operator <= IPair&
operator == IPair&
operator > IPair&
operator >= IPair&
scaleBy double, double
scaledBy double, double
transpose None
ΓòÉΓòÉΓòÉ 4.37. IString ΓòÉΓòÉΓòÉ
Overview
Part Description
Part Interface
Attributes
Actions
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - IString ΓòÉΓòÉΓòÉ
Title: IBM string class, indexed starting at 1
Class name: IString
Base part: IBase
Part type: Class interface part
Part file: vbbase.vbb
ΓòÉΓòÉΓòÉ <hidden> Attributes - IString ΓòÉΓòÉΓòÉ
Attribute S Data type
alphabetic Boolean
alphanumeric Boolean
asDebugInfo IString
asDouble double
asInt long
asString IString
asUnsigned unsigned long
binaryDigits Boolean
control Boolean
digits Boolean
graphics Boolean
hexDigits Boolean
includesDBCS Boolean
includesMBCS Boolean
includesSBCS Boolean
isASCII Boolean
isDBCS Boolean
isLowerCase Boolean
isMBCS Boolean
isSBCS Boolean
isUpperCase Boolean
length unsigned
numWords unsigned
printable Boolean
punctuation Boolean
size unsigned
validDBCS Boolean
validMBCS Boolean
whiteSpace Boolean
ΓòÉΓòÉΓòÉ <hidden> Actions - IString ΓòÉΓòÉΓòÉ
Action Parameters
b2c IString&
b2d IString&
b2x IString&
c2b None
c2d None
c2x IString&
center IString&, unsigned, char
change IString&, char*, char*, unsigned, unsigned
charType unsigned
copy IString&, unsigned
d2b IString&
d2c None
d2x None
includes IStringTest&
indexOf char*, unsigned
indexOfAnyBut IString&, unsigned
indexOfAnyOf IStringTest&, unsigned
indexOfPhrase IString&, unsigned
indexOfWord unsigned
insert IString&, unsigned, char
isAbbreviationFor char*, unsigned
isLike char*, unsigned, char, char
lastIndexOf char, unsigned
lastIndexOfAnyBut IStringTest&, unsigned
lastIndexOfAnyOf IString&, unsigned
leftJustify unsigned, char
lengthOfWord unsigned
lineFrom istream&, char
lowerCase IString&
occurrencesOf char*, unsigned, unsigned
operator & IString&
operator &= char*
operator + IString&
operator += char*
operator = IString&
operator char * IString&
operator signed char * IString&
operator unsigned char * IString&
operator [] unsigned
operator ^ IString&
operator ^= char*
operator | IString&
operator |= char*
operator ~ None
overlayWith IString&, IString&, unsigned, char
remove IString&, unsigned
removeWords unsigned, unsigned
reverse IString&
rightJustify unsigned, char
space unsigned, char
strip IString&, char
stripBlanks IString&
stripLeading IString&, char*
stripLeadingBlanks IString&
stripTrailing IString&, IStringTest&
stripTrailingBlanks IString&
subString unsigned
translate IString&, IString&, char
upperCase IString&
word unsigned
wordIndexOfPhrase IString&, unsigned
words unsigned, unsigned
x2b None
x2c IString&
x2d IString&
ΓòÉΓòÉΓòÉ 4.38. ISystemErrorInfo ΓòÉΓòÉΓòÉ
Overview
Part Description
Part Interface
Attributes
Actions
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - ISystemErrorInfo ΓòÉΓòÉΓòÉ
Title: IBM access to system error information
Class name: ISystemErrorInfo
Base part: IErrorInfo
Part type: Class interface part
Part file: vbbase.vbb
ΓòÉΓòÉΓòÉ <hidden> Attributes - ISystemErrorInfo ΓòÉΓòÉΓòÉ
Attribute S Data type
asDebugInfo IString
asString IString
available Boolean
errorId unsigned long
text const char*
ΓòÉΓòÉΓòÉ <hidden> Actions - ISystemErrorInfo ΓòÉΓòÉΓòÉ
Action Parameters
operator const char * IString&
throwError IExceptionLocation&,
IErrorInfo::ExceptionType,
IException::Severity, IException::Severity
throwSystemError unsigned long, char*, IExceptionLocation&,
IErrorInfo::ExceptionType,
IException::Severity
ΓòÉΓòÉΓòÉ 4.39. ITime ΓòÉΓòÉΓòÉ
Overview
Part Description
Part Interface
Attributes
Actions
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - ITime ΓòÉΓòÉΓòÉ
Title: IBM time class
Class name: ITime
Base part: IBase
Part type: Class interface part
Part file: vbbase.vbb
ΓòÉΓòÉΓòÉ <hidden> Attributes - ITime ΓòÉΓòÉΓòÉ
Attribute S Data type
asCTIME _CTIME
asDebugInfo IString
asSeconds long
asString IString
hours unsigned
minutes unsigned
now ITime
seconds unsigned
ΓòÉΓòÉΓòÉ <hidden> Actions - ITime ΓòÉΓòÉΓòÉ
Action Parameters
operator != ITime&
operator + ITime&
operator += ITime&
operator - ITime&
operator -= ITime&
operator < ITime&
operator <= ITime&
operator == ITime&
operator > ITime&
operator >= ITime&
ΓòÉΓòÉΓòÉ 4.40. ITrace ΓòÉΓòÉΓòÉ
Overview
Part Description
Part Interface
Attributes
Actions
Personal Notes
ΓòÉΓòÉΓòÉ <hidden> Part Description - ITrace ΓòÉΓòÉΓòÉ
Title: IBM support for module tracing
Class name: ITrace
Base part: IVBase
Part type: Class interface part
Part file: vbbase.vbb
ΓòÉΓòÉΓòÉ <hidden> Attributes - ITrace ΓòÉΓòÉΓòÉ
Attribute S Data type
asDebugInfo IString
asString IString
traceDestination ITrace::Destination
traceEnabled Boolean
writeLineNumberEnabled Boolean
writePrefixEnabled Boolean
ΓòÉΓòÉΓòÉ <hidden> Actions - ITrace ΓòÉΓòÉΓòÉ
Action Parameters
disableTrace None
disableWriteLineNumber None
disableWritePrefix None
enableTrace None
enableWriteLineNumber None
enableWritePrefix None
write char*
writeToQueue None
writeToStandardError None
writeToStandardOutput None
ΓòÉΓòÉΓòÉ 5. Glossary ΓòÉΓòÉΓòÉ
ΓòÉΓòÉΓòÉ <hidden> Glossary description ΓòÉΓòÉΓòÉ
This glossary defines terms and abbreviations that are used in this book. If
you do not find the term you are looking for, refer to the IBM Dictionary of
Computing, New York:McGraw-Hill, 1994.
This glossary includes terms and definitions from the American National
Standard Dictionary for Information Systems, ANSI X3.172-1990, copyright 1990
by the American National Standards Institute (ANSI). Copies may be purchased
from the American National Standards Institute, 1430 Broadway, New York, New
York 10018.
ΓòÉΓòÉΓòÉ <hidden> Glossary listing ΓòÉΓòÉΓòÉ
A
abstract class
access
action
argument
attribute
attribute-to-action connection
attribute-to-attribute connection
attribute-to-member function connection
B
base class
behavior
C
caller
category
class
Class Editor
class hierarchy
class library
class member function
client area object
client object
collection
Common User Access (CUA)
composite part
Composition Editor
concrete class
connection
const
construction from parts
constructor
CUA
cursored emphasis
custom logic connection
D
data abstraction
data member
data model
data object
declaration
DEF file
derivation
destructor
DLL
dynamic link library (DLL)
E
encapsulation
event
event-to-action connection
event-to-attribute connection
event-to-member function connection
expansion area
F
feature
full attribute
free-form surface
G
graphical user interface (GUI)
GUI
H
handles
header file
I
inheritance
instance
L
legacy code
loaded
M
main part
member
member function
member function call
member function name
message
model
module definition file
N
nested class
nonvisual part
no-event attribute
no-set attribute
notebook part
O
object
object class
object factory
object-oriented programming
observer
operation
overloading
P
palette
parameter connection
parent class
part
part event
part event ID
part interface
Part Interface Editor
parts palette
preferred features
primary selection
private
process
program
protected
prototype
primitive part
process
property
pure virtual function
R
receiver
resource file
S
selection handles
server
service
settings view
sticky
structure
subpart
superclass
T
tear-off attribute
template
thread
tool bar
U
UI
unloaded
user interface (UI)
V
variable
view
virtual function
visual part
visual programming tool
W
white space
window
ΓòÉΓòÉΓòÉ <hidden> abstract class ΓòÉΓòÉΓòÉ
A class that provides common behavior across a set of subclasses but is not
itself designed to have instances that work. An abstract class represents a
concept; classes derived from it represent implementations of the concept. For
example, IControl is the abstract base class for control view windows; the
ICanvas and IListBox classes are controls derived from IControl. An abstract
class must have at least one pure virtual function.
See also base class.
ΓòÉΓòÉΓòÉ <hidden> access ΓòÉΓòÉΓòÉ
A property of a class that determines whether a class member is accessible in
an expression or declaration.
ΓòÉΓòÉΓòÉ <hidden> action ΓòÉΓòÉΓòÉ
A specification of a function that a part can perform. The visual builder uses
action specifications to generate connections between parts. Actions are
resolved to member function calls in the generated code.
Compare to event and attribute.
ΓòÉΓòÉΓòÉ <hidden> argument ΓòÉΓòÉΓòÉ
A data element, or value, included as part of a member function call. Arguments
provide additional information that the called member function can use to
perform the requested operation.
ΓòÉΓòÉΓòÉ <hidden> attribute ΓòÉΓòÉΓòÉ
A specification of a property of a part. For example, a customer part could
have a name attribute and an address attribute. An attribute can itself be a
part with its own behavior and attributes.
The visual builder uses attribute specifications to generate code to get and
set part properties.
Compare to event and action.
ΓòÉΓòÉΓòÉ <hidden> attribute-to-action connection ΓòÉΓòÉΓòÉ
A connection that starts an action whenever an attribute's value changes. It is
similar to an event-to-action connection because the attribute's event ID is
used to notify the action when the value of the attribute changes.
See also connection. Compare to event-to-action connection.
ΓòÉΓòÉΓòÉ <hidden> attribute-to-attribute connection ΓòÉΓòÉΓòÉ
A connection from an attribute of one part to an attribute of another part.
When one attribute is updated, the other attribute is updated automatically.
See also connection.
ΓòÉΓòÉΓòÉ <hidden> attribute-to-member function connection ΓòÉΓòÉΓòÉ
A connection from an attribute of a part to a member function. The connected
attribute receives its value from the member function, which can make
calculations based on the values of other parts.
See also connection.
ΓòÉΓòÉΓòÉ <hidden> base class ΓòÉΓòÉΓòÉ
A class from which other classes or parts are derived. A base class may itself
be derived from another base class.
See also abstract class.
ΓòÉΓòÉΓòÉ <hidden> behavior ΓòÉΓòÉΓòÉ
The set of external characteristics that an object exhibits.
ΓòÉΓòÉΓòÉ <hidden> caller ΓòÉΓòÉΓòÉ
An object that sends a member function call to another object.
Contrast with receiver.
ΓòÉΓòÉΓòÉ <hidden> category ΓòÉΓòÉΓòÉ
In the Composition Editor, a selectable grouping of parts represented by an
icon in the left-most column. Selecting a category displays the parts belonging
to that category in the next column.
See also parts palette.
ΓòÉΓòÉΓòÉ <hidden> class ΓòÉΓòÉΓòÉ
An aggregate that can contain functions, types, and user-defined operators, in
addition to data. Classes can be defined hierarchically, allowing one class to
be an expansion of another, and can restrict access to its members.
ΓòÉΓòÉΓòÉ <hidden> Class Editor ΓòÉΓòÉΓòÉ
The editor you use to specify the names of files that Visual Builder writes to
when you generate default code. You can also use this editor to do the
following:
Enter a description of the part
Specify a different .vbb file in which to store the part
See the name of the part's base class
Modify the part's default constructor
Enter additional constructor and destructor code
Specify a .lib file for the part
Specify a resource DLL and ID to assign an icon to the part
Specify other files that you want to include when you build your
application
Compare to Composition Editor and Part Interface Editor.
ΓòÉΓòÉΓòÉ <hidden> class hierarchy ΓòÉΓòÉΓòÉ
A tree-like structure showing relationships among object classes. It places one
abstract class at the top (a base class) and one or more layers of less
abstract classes below it.
ΓòÉΓòÉΓòÉ <hidden> class library ΓòÉΓòÉΓòÉ
A collection of classes.
ΓòÉΓòÉΓòÉ <hidden> class member function ΓòÉΓòÉΓòÉ
See member function.
ΓòÉΓòÉΓòÉ <hidden> client area object ΓòÉΓòÉΓòÉ
An intermediate window between a frame window (IFrameWindow) and its controls
and other child windows.
ΓòÉΓòÉΓòÉ <hidden> client object ΓòÉΓòÉΓòÉ
An object that requests services from other objects.
ΓòÉΓòÉΓòÉ <hidden> collection ΓòÉΓòÉΓòÉ
A set of features in which each feature is an object.
ΓòÉΓòÉΓòÉ <hidden> Common User Access (CUA) ΓòÉΓòÉΓòÉ
An IBM architecture for designing graphical user interfaces using a set of
standard components and terminology.
ΓòÉΓòÉΓòÉ <hidden> composite part ΓòÉΓòÉΓòÉ
A part that is composed of a part and one or more subparts. A composite part
can contain visual parts, nonvisual parts, or both.
See also nonvisual part, part, subpart, and visual part.
ΓòÉΓòÉΓòÉ <hidden> Composition Editor ΓòÉΓòÉΓòÉ
A view that is used to build a graphical user interface and to make connections
between parts.
Compare to Class Editor and Part Interface Editor.
ΓòÉΓòÉΓòÉ <hidden> concrete class ΓòÉΓòÉΓòÉ
A subclass of an abstract class that is a specialization of the abstract class.
ΓòÉΓòÉΓòÉ <hidden> connection ΓòÉΓòÉΓòÉ
A formal, explicit relationship between parts. Making connections is the basic
technique for building any visual application because that defines the way in
which parts communicate with one another. The visual builder generates the code
that then implements these connections.
See also attribute-to-action connection, attribute-to-attribute connection,
attribute-to-member function connection, parameter connection, custom logic
connection, event-to-action connection, event-to-attribute connection, and
event-to-member function connection.
ΓòÉΓòÉΓòÉ <hidden> const ΓòÉΓòÉΓòÉ
An attribute of a data object that declares that the object cannot be changed.
ΓòÉΓòÉΓòÉ <hidden> construction from parts ΓòÉΓòÉΓòÉ
A software development technology in which applications are assembled from
existing and reusable software components, known as parts.
ΓòÉΓòÉΓòÉ <hidden> constructor ΓòÉΓòÉΓòÉ
A special class member function that has the same name as the class and is used
to construct and possibly initialize class objects.
ΓòÉΓòÉΓòÉ <hidden> CUA ΓòÉΓòÉΓòÉ
See Common User Access.
ΓòÉΓòÉΓòÉ <hidden> cursored emphasis ΓòÉΓòÉΓòÉ
When the selection cursor is on a choice, that choice has cursored emphasis.
ΓòÉΓòÉΓòÉ <hidden> custom logic connection ΓòÉΓòÉΓòÉ
A connection that causes your customized C or C++ code to be run. This
connection can be triggered either when an attribute's value changes or an
event occurs.
ΓòÉΓòÉΓòÉ <hidden> data abstraction ΓòÉΓòÉΓòÉ
A data type with a private representation and a public set of operations. The
C++ language uses the concept of classes to implement data abstraction.
ΓòÉΓòÉΓòÉ <hidden> data member ΓòÉΓòÉΓòÉ
Private data that belongs to a given object and is hidden from direct access by
all other objects. Data members can only be accessed by the member functions of
the defining class and its subclasses.
ΓòÉΓòÉΓòÉ <hidden> data model ΓòÉΓòÉΓòÉ
A combination of the base classes and parts shipped with the product and the
classes and parts you save and create. They are saved in a file named
vbbase.vbb.
ΓòÉΓòÉΓòÉ <hidden> data object ΓòÉΓòÉΓòÉ
A storage area used to hold a value.
ΓòÉΓòÉΓòÉ <hidden> declaration ΓòÉΓòÉΓòÉ
A description that makes an external object or function available to a function
or a block.
ΓòÉΓòÉΓòÉ <hidden> DEF file ΓòÉΓòÉΓòÉ
See module definition file.
ΓòÉΓòÉΓòÉ <hidden> derivation ΓòÉΓòÉΓòÉ
The creation of a new or abstract class from an existing or base class.
ΓòÉΓòÉΓòÉ <hidden> destructor ΓòÉΓòÉΓòÉ
A special class member function that has the same name as the class and is used
to destruct class objects.
ΓòÉΓòÉΓòÉ <hidden> DLL ΓòÉΓòÉΓòÉ
See dynamic link library.
ΓòÉΓòÉΓòÉ <hidden> dynamic link library (DLL) ΓòÉΓòÉΓòÉ
In OS/2, a library containing data and code objects that can be used by
programs or applications during loading or at run time. Although they are not
part of the program's executable (.exe) file, they are sometimes required for
an .exe file to run properly.
ΓòÉΓòÉΓòÉ <hidden> encapsulation ΓòÉΓòÉΓòÉ
The hiding of a software object's internal representation. The object provides
an interface that queries and manipulates the data without exposing its
underlying structure.
ΓòÉΓòÉΓòÉ <hidden> event ΓòÉΓòÉΓòÉ
A specification of a notification from a part.
Compare to action, attribute, and part event.
ΓòÉΓòÉΓòÉ <hidden> event-to-action connection ΓòÉΓòÉΓòÉ
A connection that causes an action to be performed when an event occurs.
See also connection.
ΓòÉΓòÉΓòÉ <hidden> event-to-attribute connection ΓòÉΓòÉΓòÉ
A connection that changes the value of an attribute when a certain event
occurs.
See also connection.
ΓòÉΓòÉΓòÉ <hidden> event-to-member function connection ΓòÉΓòÉΓòÉ
A connection from an event of a part to a member function. When the connected
event occurs, the member function is executed.
See also connection.
ΓòÉΓòÉΓòÉ <hidden> expansion area ΓòÉΓòÉΓòÉ
The section of a multicell canvas between the current cell grid and the outer
edge of the canvas. Visually, this area is bounded by the rightmost column
gridline and the bottommost row gridline.
ΓòÉΓòÉΓòÉ <hidden> feature ΓòÉΓòÉΓòÉ
A major component of a software product that can be installed separately.
In Visual Builder, an action, attribute, or event that is available from a
part's part interface and that other parts can connect to.
ΓòÉΓòÉΓòÉ <hidden> full attribute ΓòÉΓòÉΓòÉ
An attribute that has all of the behaviors and characteristics that an
attribute can have: a data member, a get member function, a set member
function, and an event identifier.
ΓòÉΓòÉΓòÉ <hidden> free-form surface ΓòÉΓòÉΓòÉ
The large open area of the Composition Editor window. The free-form surface
holds the visual parts contained in the views you build and representations of
the nonvisual parts (models) that your application includes.
ΓòÉΓòÉΓòÉ <hidden> graphical user interface (GUI) ΓòÉΓòÉΓòÉ
A type of interface that enables users to communicate with a program by
manipulating graphical features, rather than by entering commands. Typically, a
graphical user interface includes a combination of graphics, pointing devices,
menu bars and other menus, overlapping windows, and icons.
ΓòÉΓòÉΓòÉ <hidden> GUI ΓòÉΓòÉΓòÉ
See graphical user interface.
ΓòÉΓòÉΓòÉ <hidden> handles ΓòÉΓòÉΓòÉ
Small squares that appear on the corners of a selected visual part in the
visual builder. Handles are used to resize parts.
Compare to primary selection.
ΓòÉΓòÉΓòÉ <hidden> header file ΓòÉΓòÉΓòÉ
A file that contains system-defined control information that precedes user
data.
ΓòÉΓòÉΓòÉ <hidden> inheritance ΓòÉΓòÉΓòÉ
A mechanism by which an object class can use the attributes, relationships, and
member functions defined in more abstract classes related to it (its base
classes).
An object-oriented programming technique that allows you to use existing
classes as bases for creating other classes.
ΓòÉΓòÉΓòÉ <hidden> instance ΓòÉΓòÉΓòÉ
Synonym for object, a particular instantiation of a data type.
ΓòÉΓòÉΓòÉ <hidden> legacy code ΓòÉΓòÉΓòÉ
Existing code that a user might have. Legacy applications often have
character-based, nongraphical user interfaces; usually they are written in a
nonobject-oriented language, such as C or COBOL.
ΓòÉΓòÉΓòÉ <hidden> loaded ΓòÉΓòÉΓòÉ
The state of the mouse pointer between the time you select a part from the
parts palette and deposit the part on the free-form surface.
ΓòÉΓòÉΓòÉ <hidden> main part ΓòÉΓòÉΓòÉ
The part that users see when they start an application. This is the part from
which the main() function C++ code for the application is generated.
The main part is a special kind of composite part.
See also part and subpart.
ΓòÉΓòÉΓòÉ <hidden> member ΓòÉΓòÉΓòÉ
A data object in a structure or a union.
In C++, classes and structures can also contain functions and types as members.
ΓòÉΓòÉΓòÉ <hidden> member function ΓòÉΓòÉΓòÉ
An operator or function that is declared as a member of a class. A member
function has access to the private and protected data members and member
functions of objects of its class.
ΓòÉΓòÉΓòÉ <hidden> member function call ΓòÉΓòÉΓòÉ
A communication from one object to another that requests the receiving object
to execute a member function.
A member function call consists of a member function name that indicates the
requested member function and the arguments to be used in executing the member
function. The member function call always returns some object to the requesting
object as the result of performing the member function.
Synonym for message.
ΓòÉΓòÉΓòÉ <hidden> member function name ΓòÉΓòÉΓòÉ
The component of a member function call that specifies the requested operation.
ΓòÉΓòÉΓòÉ <hidden> message ΓòÉΓòÉΓòÉ
A request from one object that the receiving object implement a member
function. Because data is encapsulated and not directly accessible, a message
is the only way to send data from one object to another. Each message specifies
the name of the receiving object, the member function to be implemented, and
any arguments the member function needs for implementation.
Synonym for member function call.
ΓòÉΓòÉΓòÉ <hidden> model ΓòÉΓòÉΓòÉ
A nonvisual part that represents the state and behavior of a object, such as a
customer or an account.
Contrast with view.
ΓòÉΓòÉΓòÉ <hidden> module definition file ΓòÉΓòÉΓòÉ
A file that describes the code segments within a load module.
Synonym for DEF file.
ΓòÉΓòÉΓòÉ <hidden> nested class ΓòÉΓòÉΓòÉ
A class defined within the scope of another class.
ΓòÉΓòÉΓòÉ <hidden> nonvisual part ΓòÉΓòÉΓòÉ
A part that has no visual representation at run time. A nonvisual part
typically represents some real-world object that exists in the business
environment.
Compare to model. Contrast with view and visual part.
ΓòÉΓòÉΓòÉ <hidden> no-event attribute ΓòÉΓòÉΓòÉ
An attribute that does not have an event identifier.
ΓòÉΓòÉΓòÉ <hidden> no-set attribute ΓòÉΓòÉΓòÉ
An attribute that does not have a set member function.
ΓòÉΓòÉΓòÉ <hidden> notebook part ΓòÉΓòÉΓòÉ
A visual part that resembles a bound notebook containing pages separated into
sections by tabbed divider pages. A user can turn the pages of a notebook or
select the tabs to move from one section to another.
ΓòÉΓòÉΓòÉ <hidden> object ΓòÉΓòÉΓòÉ
A computer representation of something that a user can work with to perform a
task. An object can appear as text or an icon.
A collection of data and member functions that operate on that data, which
together represent a logical entity in the system. In object-oriented
programming, objects are grouped into classes that share common data
definitions and member functions. Each object in the class is said to be an
instance of the class.
An instance of an object class consisting of attributes, a data structure, and
operational member functions. It can represent a person, place, thing, event,
or concept. Each instance has the same properties, attributes, and member
functions as other instances of the object class, though it has unique values
assigned to its attributes.
ΓòÉΓòÉΓòÉ <hidden> object class ΓòÉΓòÉΓòÉ
A template for defining the attributes and member functions of an object. An
object class can contain other object classes. An individual representation of
an object class is called an object.
ΓòÉΓòÉΓòÉ <hidden> object factory ΓòÉΓòÉΓòÉ
A nonvisual part capable of dynamically creating new instances of a specified
part. For example, during the execution of an application, an object factory
can create instances of a new class to collect the data being generated.
ΓòÉΓòÉΓòÉ <hidden> object-oriented programming ΓòÉΓòÉΓòÉ
A programming approach based on the concepts of data abstraction and
inheritance. Unlike procedural programming techniques, object-oriented
programming concentrates on those data objects that comprise the problem and
how they are manipulated, not on how something is accomplished.
ΓòÉΓòÉΓòÉ <hidden> observer ΓòÉΓòÉΓòÉ
An object that receives notification from a notifier object.
ΓòÉΓòÉΓòÉ <hidden> operation ΓòÉΓòÉΓòÉ
A member function or service that can be requested of an object.
ΓòÉΓòÉΓòÉ <hidden> overloading ΓòÉΓòÉΓòÉ
An object-oriented programming technique that allows you to redefine functions
and most standard C++ operators when the functions and operators are used with
class types.
ΓòÉΓòÉΓòÉ <hidden> palette ΓòÉΓòÉΓòÉ
See parts palette.
ΓòÉΓòÉΓòÉ <hidden> parameter connection ΓòÉΓòÉΓòÉ
A connection that satisfies a parameter of an action or member function by
supplying either an attribute's value or the return value of an action, member
function, or custom logic. The parameter is always the source of the
connection.
See also connection.
ΓòÉΓòÉΓòÉ <hidden> parent class ΓòÉΓòÉΓòÉ
The class from which another part or class inherits data, member functions, or
both.
ΓòÉΓòÉΓòÉ <hidden> part ΓòÉΓòÉΓòÉ
A self-contained software object with a standardized public interface,
consisting of a set of external features that allow the part to interact with
other parts. A part is implemented as a class that supports the INotifier
protocol and has a part interface defined.
The parts on the palette can be used as templates to create instances or
objects.
ΓòÉΓòÉΓòÉ <hidden> part event ΓòÉΓòÉΓòÉ
A representation of a change that occurs to a part. The events on a part's
interface enable other interested parts to receive notification when something
about the part changes. For example, a push button generates an event signaling
that it has been clicked, which might cause another part to display a window.
ΓòÉΓòÉΓòÉ <hidden> part event ID ΓòÉΓòÉΓòÉ
The name of a part static-data member used to identify which notification is
being signaled.
ΓòÉΓòÉΓòÉ <hidden> part interface ΓòÉΓòÉΓòÉ
A set of external features that allows a part to interact with other parts. A
part's interface is made up of three characteristics: attributes, actions, and
events.
ΓòÉΓòÉΓòÉ <hidden> Part Interface Editor ΓòÉΓòÉΓòÉ
An editor that the application developer uses to create and modify attributes,
actions, and events, which together make up the interface of a part.
Compare to Class Editor and Composition Editor.
ΓòÉΓòÉΓòÉ <hidden> parts palette ΓòÉΓòÉΓòÉ
The parts palette holds a collection of visual and nonvisual parts used in
building additional parts for an application. The parts palette is organized
into categories. Application developers can add parts to the palette for use in
defining applications or other parts.
ΓòÉΓòÉΓòÉ <hidden> preferred features ΓòÉΓòÉΓòÉ
A subset of the part's features that appear in a pop-up connection menu.
Generally, they are the features used most often.
ΓòÉΓòÉΓòÉ <hidden> primary selection ΓòÉΓòÉΓòÉ
In the Composition Editor, the part used as a base for an action that affects
several parts. For example, an alignment tool will align all selected parts
with the primary selection. Primary selection is indicated by closed (solid)
selection handles, while the other selected parts have open selection handles.
See also selection handles.
ΓòÉΓòÉΓòÉ <hidden> private ΓòÉΓòÉΓòÉ
Pertaining to a class member that is accessible only to member functions and
friends of that class.
ΓòÉΓòÉΓòÉ <hidden> process ΓòÉΓòÉΓòÉ
A program running under OS/2, along with the resources associated with it
(memory, threads, file system resources, and so on).
ΓòÉΓòÉΓòÉ <hidden> program ΓòÉΓòÉΓòÉ
One or more files containing a set of instructions conforming to a particular
programming language syntax.
A self-contained, executable module. Multiple copies of the same program can be
run in different processes.
ΓòÉΓòÉΓòÉ <hidden> protected ΓòÉΓòÉΓòÉ
Pertaining to a class member that is only accessible to member functions and
friends of that class, or to member functions and friends of classes derived
from that class.
ΓòÉΓòÉΓòÉ <hidden> prototype ΓòÉΓòÉΓòÉ
A function declaration or definition that includes both the return type of the
function and the types of its arguments.
ΓòÉΓòÉΓòÉ <hidden> primitive part ΓòÉΓòÉΓòÉ
A basic building block of other parts. A primitive part can be relatively
complex in terms of the function it provides.
ΓòÉΓòÉΓòÉ <hidden> process ΓòÉΓòÉΓòÉ
A collection of code, data, and other system resources, including at least one
thread of execution, that performs a data processing task.
ΓòÉΓòÉΓòÉ <hidden> property ΓòÉΓòÉΓòÉ
A unique characteristic of a part.
ΓòÉΓòÉΓòÉ <hidden> pure virtual function ΓòÉΓòÉΓòÉ
A virtual function that has a function definition of = 0;.
ΓòÉΓòÉΓòÉ <hidden> receiver ΓòÉΓòÉΓòÉ
The object that receives a member function call.
Contrast with caller.
ΓòÉΓòÉΓòÉ <hidden> resource file ΓòÉΓòÉΓòÉ
A file that contains data used by an application, such as text strings and
icons.
ΓòÉΓòÉΓòÉ <hidden> selection handles ΓòÉΓòÉΓòÉ
In the Composition Editor, small squares that appear on the corners of a
selected visual part. Selection handles are used to resize parts.
See also primary selection.
ΓòÉΓòÉΓòÉ <hidden> server ΓòÉΓòÉΓòÉ
A computer that provides services to multiple users or workstations in a
network; for example, a file server, a print server, or a mail server.
ΓòÉΓòÉΓòÉ <hidden> service ΓòÉΓòÉΓòÉ
A specific behavior that an object is responsible for exhibiting.
ΓòÉΓòÉΓòÉ <hidden> settings view ΓòÉΓòÉΓòÉ
A view of a part that provides a way to display and set the attributes and
options associated with the part.
ΓòÉΓòÉΓòÉ <hidden> sticky ΓòÉΓòÉΓòÉ
In the Composition Editor, the mode that enables you to add multiple parts of
the same class (for example, three push buttons) without going back and forth
between the parts palette and the free-form surface.
ΓòÉΓòÉΓòÉ <hidden> structure ΓòÉΓòÉΓòÉ
A construct that contains an ordered group of data objects. Unlike an array,
the data objects within a structure can have varied data types.
ΓòÉΓòÉΓòÉ <hidden> subpart ΓòÉΓòÉΓòÉ
A part that is used to create another part.
See also nonvisual part, part, and visual part.
ΓòÉΓòÉΓòÉ <hidden> superclass ΓòÉΓòÉΓòÉ
See abstract class and base class.
ΓòÉΓòÉΓòÉ <hidden> tear-off attribute ΓòÉΓòÉΓòÉ
An attribute that an application developer has exposed to work with as though
it were a stand-alone part.
ΓòÉΓòÉΓòÉ <hidden> template ΓòÉΓòÉΓòÉ
A family of classes or functions with variable types.
ΓòÉΓòÉΓòÉ <hidden> thread ΓòÉΓòÉΓòÉ
A unit of execution within a process.
ΓòÉΓòÉΓòÉ <hidden> tool bar ΓòÉΓòÉΓòÉ
The strip of icons along the top of the free-form surface. The tool bar
contains tools to help you construct composite parts.
ΓòÉΓòÉΓòÉ <hidden> UI ΓòÉΓòÉΓòÉ
See user interface.
ΓòÉΓòÉΓòÉ <hidden> unloaded ΓòÉΓòÉΓòÉ
The state of the mouse pointer before you select a part from the parts palette
and after you deposit a part on the free-form surface. In addition, you can
unload the mouse pointer by pressing the Esc key.
ΓòÉΓòÉΓòÉ <hidden> user interface (UI) ΓòÉΓòÉΓòÉ
The hardware, software, or both that enable a user to interact with a computer.
The term user interface normally refers to the visual presentation and its
underlying software with which a user interacts.
ΓòÉΓòÉΓòÉ <hidden> variable ΓòÉΓòÉΓòÉ
A storage place within an object for a data feature. The data feature is an
object, such as number or date, stored as an attribute of the containing
object.
A part that receives an identity at run time. A variable by itself contains no
data or program logic; it must be connected such that it receives runtime
identity from a part elsewhere in the application.
ΓòÉΓòÉΓòÉ <hidden> view ΓòÉΓòÉΓòÉ
A visual part, such as a window, push button, or entry field.
A visual representation that can display and change the underlying model
objects of an application. Views are both the end result of developing an
application and the basic unit of composition of user interfaces.
Compare to visual part. Contrast with model.
ΓòÉΓòÉΓòÉ <hidden> virtual function ΓòÉΓòÉΓòÉ
A function of a class that is declared with the keyword virtual. The
implementation that is executed when you make a call to a virtual function
depends on the type of the object for which it is called. This is determined at
run time.
ΓòÉΓòÉΓòÉ <hidden> visual part ΓòÉΓòÉΓòÉ
A part that has a visual representation at run time. Visual parts, such as
windows, push buttons, and entry fields, make up the user interface of an
application.
Compare to view. Contrast with nonvisual part.
ΓòÉΓòÉΓòÉ <hidden> visual programming tool ΓòÉΓòÉΓòÉ
A tool that provides a means for specifying programs graphically. Application
programmers write applications by manipulating graphical representations of
components.
ΓòÉΓòÉΓòÉ <hidden> white space ΓòÉΓòÉΓòÉ
Space characters, tab characters, form-feed characters, and new-line
characters.
ΓòÉΓòÉΓòÉ <hidden> window ΓòÉΓòÉΓòÉ
A rectangular area of the screen with visible boundaries in which information
is displayed. Windows can overlap on the screen, giving it the appearance of
one window being on top of another.
In the Composition Editor, a window is a part that can be used as a container
for other visual parts, such as push buttons.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
The S column heading represents Set. If an attribute can be set, a Γûá appears in
this column.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
The E column heading represents Event. If an attribute can send a value change
event on a connection, a Γûá appears in this column.