home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
OS/2 Shareware BBS: 10 Tools
/
10-Tools.zip
/
VSCPPv4.zip
/
VACPP
/
IBMCPP
/
HELP
/
WPS1.INF
(
.txt
)
< prev
next >
Wrap
OS/2 Help File
|
1995-03-14
|
311KB
|
11,981 lines
ΓòÉΓòÉΓòÉ 1. Notices ΓòÉΓòÉΓòÉ
First Edition (December 1994)
The following paragraph does not apply to the United Kingdom or any country
where such provisions are inconsistent with local law: INTERNATIONAL BUSINESS
MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY
KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states
do not allow disclaimer of express or implied warranties in certain
transactions, therefore, this statement may not apply to you.
This publication could include technical inaccuracies or typographical errors.
Changes are periodically made to the information herein; these changes will be
incorporated in new editions of the publication. IBM may make improvements
and/or changes in the product(s) and/or the program(s) described in this
publication at any time.
It is possible that this publication may contain reference to, or information
about, IBM products (machines and programs), programming, or services that are
not announced in your country. Such references or information must not be
construed to mean that IBM intends to announce such IBM products, programming,
or services in your country.
Requests for technical information about IBM products should be made to your
IBM authorized reseller or IBM marketing representative.
ΓòÉΓòÉΓòÉ 1.1. Copyright Notices ΓòÉΓòÉΓòÉ
COPYRIGHT LICENSE: This publication contains printed sample application
programs in source language, which illustrate OS/2 programming techniques. You
may copy, modify, and distribute these sample programs in any form without
payment to IBM, for the purposes of developing, using, marketing or
distributing application programs conforming to the OS/2 application
programming interface.
Each copy of any portion of these sample programs or any derivative work, which
is distributed to others, must include a copyright notice as follows: "(C)
(your company name) (year). All rights reserved."
(C) Copyright International Business Machines Corporation 1994. All rights
reserved.
Note to U.S. Government Users - Documentation related to restricted rights -
Use, duplication or disclosure is subject to restrictions set forth in GSA ADP
Schedule Contract with IBM Corp.
ΓòÉΓòÉΓòÉ 1.2. Disclaimers ΓòÉΓòÉΓòÉ
References in this publication to IBM products, programs, or services do not
imply that IBM intends to make these available in all countries in which IBM
operates. Any reference to an IBM product, program or service is not intended
to state or imply that only IBM's product, program, or service may be used. Any
functionally equivalent product, program, or service that does not infringe any
of IBM's intellectual property rights or other legally protectable rights may
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, are the user's
responsibility.
IBM may 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 the IBM Director
of Licensing, IBM Corporation, 500 Columbus Avenue, Thornwood NY 10594, U.S.A.
ΓòÉΓòÉΓòÉ 1.3. Trademarks ΓòÉΓòÉΓòÉ
The following terms are trademarks of the IBM Corporation in the United States
or other countries:
AIX Common User Access
CUA IBM
Operating System/2 OS/2
PM Presentation Manager
Proprinter SAA
SOMobjects System Application Architecture
WIN-OS/2 Workplace Shell
The following terms are trademarks of other companies:
C++ American Telephone and Telegraph Company
CORBA Object Management Group, Inc.
Helvetica Linotype Company
Novell Novell, Inc.
PCMCIA Personal Computer Memory Card International
Association
Windows Microsoft Corporation
ΓòÉΓòÉΓòÉ 2. How to Use the Workplace Shell Reference ΓòÉΓòÉΓòÉ
This reference is a detailed technical guide and reference for application
programmers. It gives reference information and code examples to enable you to
write source code using Workplace classes and methods.
Before you begin to use this information, it would be helpful to understand how
you can:
o Expand the Contents to see all available topics
o Obtain additional information for a highlighted word or phrase
o Use action bar choices
o Use the programming information.
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, Code Pages 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).
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. You will notice that certain words and phrases are highlighted in
green letters, or in white letters on a black background. 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.
How to Use Action Bar Choices
Several choices are available for managing information presented in the
Workplace Shell Programming Reference. There are three pull-down 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:
Bookmark
Allows you to set a placeholder so you can retrieve information of interest
to you.
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, choose the Bookmark option from the Services
pull-down.
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.
Search
Allows you to find occurrences of a word or phrase in the current topic,
selected topics, or all topics.
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. Choose the Search option from the Services pull-down.
2. Type the word or words for which to search.
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.
Print
Allows you to print one or more topics. You can also print a set of topics
by first marking the topics in the Contents list.
To print the document Contents list, do the following:
1. Choose Print from the Services pull-down.
2. Click on Contents (or press the Up or Down Arrow key to select it).
3. Click on Print (or select it and press Enter).
4. The Contents list is printed on your printer.
Copy
Allows you to copy a topic that you are viewing to the System Clipboard or
to a file that you can edit. You will find this particularly useful for
copying syntax definitions and program samples into the application that
you are developing.
You can copy a topic that you are viewing in two ways:
o Copy copies the topic that you are viewing into the System Clipboard. If
you are using a Presentation Manager* editor (for example, the System
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.
o 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. You
will find TEXT.TMP 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, choose Copy to file from the Services
pull-down.
3. The system puts the text pertaining to that topic into the temporary
file named TEXT.TMP.
For information on one of the other choices in the Services pull-down,
highlight the choice and press the F1 key.
The actions that are selectable from the Options menu allow you to 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. For information on one of the other
choices in the Options pull-down, highlight the choice and press the F1 key.
The actions that are selectable from the Help menu allow you to select
different types of help information. You can also press the F1 key for help
information about the Information Presentation Facility (IPF).
How to Use the Programming Information
This document consists of guide and reference information that provides a
detailed description of each function, message, constant, and data type. It
provides language-dependent information about the functions which enable the
user to generate call statements in the C Language.
Workplace Shell programming information is presented by component, such as
Workplace Classes, Instance Methods, and Class Methods, for example:
ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ
Γöé Contents Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé Γöé
Γöé + Workplace Classes Γöé
Γöé + Instance Methods Γöé
Γöé + Class Methods Γöé
Γöé Γöé
ΓööΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÿ
By clicking on the plus sign beside "Instance Methods", you see an alphabetic
list of the Workplace Shell instance methods. Selecting an instance method
takes you directly into the reference information for that method.
Units of reference information are presented in selectable multiple windows or
viewports. A viewport is a Presentation Manager window that can be sized,
moved, minimized, maximized, or closed. By selecting a unit (in this case, an
entry on the Contents list), you will see two windows displayed:
ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ
Γöé Unit Title Γöé Selection Title Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé Select an item Γöé Γöé
Γöé Γöé Γöé
Γöé Syntax Γöé Γöé
Γöé Returns Γöé Γöé
Γöé Notes Γöé Γöé
Γöé Related Methods Γöé Γöé
Γöé Override Γöé Γöé
Γöé Glossary Γöé Γöé
Γöé Γöé Γöé
ΓööΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö┤ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÿ
The window on the left is the primary window. It contains a list of items that
are always available to you. The window on the right is the secondary window.
It contains a "snapshot" of the unit information. For reference units (that
is, function descriptions), this window contains the Function Syntax.
All of the information needed to understand a reference unit (or topic) is
readily available to you through the primary window. The information is
divided into discrete information groups, and only the appropriate information
group appears for the topic that you are viewing.
The information groups for a reference unit (that is, a function description)
can include all or some of the following:
o Syntax
o Parameters
o Returns
o Notes
o Related Methods
o Usage
o Override
o Glossary
This list may vary. Some topics may be omitted when they do not apply.
Information groups are displayed in separate viewports that are stacked in a
third window location that overlaps the secondary window. By selecting an item
(information group) in the primary window, the item is displayed in the third
window location, as follows:
ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ
Γöé Unit Title Γöé Selection Γöé Glossary Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé Select an item Γöé Γöé Select a startingΓöé
Γöé Γöé Γöé letter of Γöé
Γöé . Γöé Γöé glossary terms Γöé
Γöé . Γöé Γöé Γöé
Γöé . Γöé Γöé A N Γöé
Γöé . Γöé Γöé B O Γöé
Γöé . Γöé Γöé C P Γöé
Γöé Glossary Γöé Γöé . . Γöé
Γöé Γöé Γöé . . Γöé
Γöé Γöé Γöé . . Γöé
Γöé Γöé Γöé M Z Γöé
ΓööΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö┤ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö┤ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÿ
By selecting successive items from the primary window, additional windows are
displayed on top of the previous windows displayed in the third window
location. For example, in a function description, Parameters and Return Values
are items listed in the primary window. When selected, they appear one on top
of the other in the third window location. Because of this, you may move the
first selected (topmost) window to the left before selecting the next item.
This allows simultaneous display of two related pieces of information from the
"stack" of windows in the third window location, as follows:
ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ
Γöé Unit Title Γöé Parameters Γöé Return Values Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé Select an item Γöé Γöé Γöé
Γöé . Γöé Γöé Γöé
Γöé . Γöé Γöé Γöé
Γöé . Γöé Γöé Γöé
Γöé Returns Γöé Γöé Γöé
Γöé Errors Γöé Γöé Γöé
Γöé . Γöé Γöé Γöé
Γöé . Γöé Γöé Γöé
Γöé . Γöé Γöé Γöé
Γöé Γöé Γöé Γöé
ΓööΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö┤ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö┤ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÿ
Each window can be individually closed from its system menu. All windows are
closed when you close the primary window.
Some secondary windows may have the appearance of a split screen. For example,
an illustration may appear in the left half of the window, and scrollable,
explanatory information may appear in the right half of the window. Because
illustrations may not necessarily fit into the small window size on your
screen, you may maximize the secondary window for better readability.
ΓòÉΓòÉΓòÉ 2.1. Conventions Used in this Reference ΓòÉΓòÉΓòÉ
The purpose of this reference is to give information about classes, methods,
constants, and data types. It provides information about the methods which
enables the user to call functions in the C programming language.
The following information is provided:
o The syntax and parameters for each method.
o The syntax of each data type and structure.
ΓòÉΓòÉΓòÉ 2.2. Notation Conventions ΓòÉΓòÉΓòÉ
The following notation conventions are used in this reference:
NULL The term NULL applied to a parameter is used to indicate
the presence of the pointer parameter, but with no
value.
NULLHANDLE The term NULLHANDLE applied to a parameter is used to
indicate the presence of the handle parameter, but with
no value.
Implicit Pointer If no entry for a data type "Pxxxxxxx" is found in Data
Types, then it is implicitly a pointer to the data type
"xxxxxxx". See Implicit Pointer Data Types for more
information about implicit pointers.
CONSTANT NAMES All constants are written in uppercase to match the
header files. Where applicable, constant names have a
prefix derived from the name of a function, message, or
idea associated with the constant.
For example:
WM_CREATE Window message
SV_CXICON System value
CF_TEXT Clipboard format.
In this book, references to a complete set of constants
with a given prefix is written as shown in the following
examples:
Window message WM_*
System value SV_*
Parameters and Fields Function parameters and data structure fields are shown
in italics.
ΓòÉΓòÉΓòÉ 2.3. Conventions Used in Method Descriptions ΓòÉΓòÉΓòÉ
The documentation of each function contains these sections:
Syntax
The method syntax describes the C-language calling syntax of the function
and gives a brief description.
Programming Note
The methods in this book are spelled in mixed-case for
readability but are known to the system as uppercase
character strings. For example, the function
"WinCreateObject" is actually the external name
"WINCREATEOBJECT".
If you are using a compiler that generates a mixed-case external name,
you should code the functions in uppercase.
Parameters
Each parameter is listed with its C-language data type, parameter type,
and a brief description.
o All data types are written in uppercase to match the header files. A data
type of "Pxxxxxxx" implicitly defines a pointer to the data type
"xxxxxxx".
The term NULL applied to a parameter indicates the presence of the
parameter, with no value.
Refer to Data Types for a complete list of all data types and their
descriptions.
o There are three parameter types:
Input Specified by the programmer.
Output Returned by the method.
Input/Output Specified by the programmer and modified by the
method.
o A brief description is provided with each parameter. Where appropriate,
restrictions are also included. In some cases, the parameter points to a
structure.
Returns
A list of possible return codes is included in this section.
Remarks
This section contains additional information about the method, when
required.
Related Methods
This list shows the methods (if any) that are related to the method being
described.
Usage
This section describes any restrictions for using the method.
Override
This section describes when the method can be overridden.
ΓòÉΓòÉΓòÉ 2.4. Error Severities ΓòÉΓòÉΓòÉ
Each of the error conditions given in the list of errors for each function
falls into one of these areas:
Warning
The function detected a problem, but took some remedial action that enabled
the function to complete successfully. The return code in this case
indicates that the function completed successfully.
Error
The function detected a problem for which it could not take any sensible
remedial action. The system has recovered from the problem, and the state
of the system, with respect to the application, remains the same as at the
time when the function was requested. The system has not even partially
executed the function (other than reporting the error).
Severe Error
The function detected a problem from which the system could not reestablish
its state, with respect to the application, at the time when that function
was requested; that is, the system partially executed the function. This,
therefore, necessitates the application performing some corrective activity
to restore the system to some known state.
Unrecoverable Error
The function detected some problem from which the system could not
reestablish its state, with respect to the application, at the time when
that call was issued. It is possible that the application cannot perform
some corrective action to restore the system to some known state.
ΓòÉΓòÉΓòÉ 2.5. Header Files ΓòÉΓòÉΓòÉ
All functions require an "#include" statement for the system header file OS2.H:
#include <OS2.H>
Most functions also require a "#define" statement to select an appropriate
(conditional) section of the header file, and hence, the required prototype.
Where this is necessary, it is shown at the head of the function definition in
the form:
#define INCL_name
Note: These "#define" statements must precede the "#include <OS2.H>"
statement.
ΓòÉΓòÉΓòÉ 2.6. Addressing Elements in Arrays ΓòÉΓòÉΓòÉ
Constants defining array elements are given values that are zero-based in C;
that is, the numbering of the array elements starts at zero, not one.
For example, in the DevQueryCaps function, the sixth element of the alArray
parameter is CAPS_HEIGHT, which is equated to 5.
Count parameters related to such arrays always mean the actual number of
elements available; therefore, again using the DevQueryCaps function as an
example, if all elements up to and including CAPS_HEIGHT are provided for,
lCount could be set to (CAPS_HEIGHT+1).
In functions for which the starting array element can be specified, this is
always zero-based, and so the C element number constants can be used directly.
For example, to start with the CAPS_HEIGHT element, the lStart parameter can be
set to CAPS_HEIGHT.
ΓòÉΓòÉΓòÉ 2.7. Implicit Pointer Data Types ΓòÉΓòÉΓòÉ
A data type name beginning with "P" (for example, PERRORCODE) is likely to be a
pointer to another data type (in this instance, ERRORCODE).
In the data type summary, Data Types, no explicit "typedefs" are shown for
pointers; therefore, if no data type definition can be found in the summary for
a data type name "Pxxxxxx", it represents a pointer to the data type "xxxxxx",
for which a definition should be found in the reference.
The implicit type definition needed for such a pointer "Pxxxxxx" is:
typedef xxxxxx *Pxxxxxx;
Such definitions are provided in the header files.
ΓòÉΓòÉΓòÉ 2.8. Storage Mapping of Data Types ΓòÉΓòÉΓòÉ
The storage mapping of the data types is dependent on the machine architecture.
To be portable, applications must access the data types using the definitions
supplied for the environment in which they will execute.
ΓòÉΓòÉΓòÉ 2.9. Double-Byte Character Set (DBCS) ΓòÉΓòÉΓòÉ
Throughout this publication, you will see references to specific value for
character strings. The values are for single-byte character set (SBCS). If you
use the double-byte character set (DBCS), note that one DBCS character equals
two SBCS characters.
ΓòÉΓòÉΓòÉ 2.10. Message Queues ΓòÉΓòÉΓòÉ
Usually when an application thread uses a PM function, a message queue must be
available for that thread. This means that before calling the function,
WinCreateMsgQueue must be called by the same thread.
It is recommended that you create a message queue for every thread that calls
any method, since a PM function might be used by the methods you are calling.
ΓòÉΓòÉΓòÉ 2.11. Terminology ΓòÉΓòÉΓòÉ
The following is some terminology used in these sections:
class A way of categorizing objects based on their behavior. A
class is, in effect, an abstract definition of an object.
In SOM, a class is a special kind of object that can
manufacture other objects that exhibit similar behavior
(more precisely, all of the objects of a given class have
the same memory layout and share a common set of methods).
New classes can be defined in terms of existing classes
through a technique known as inheritance.
class method A class method of class X is a method provided by the
metaclass of class X. Class methods are executed without
requiring any instances of class X to exist, and are
frequently used to create instances.
inheritance The technique of specifying the behavior of one class
(called a subclass) in terms of incremental differences
from another class (called the parent class or
superclass). The subclass inherits the superclass' data
elements and methods, and can provide additional data
elements and methods. The subclass also can provide new
methods with the same names used by the superclass. Such a
subclass method is said to override the superclass method,
and will be selected automatically by method resolution on
subclass instances. An overriding method can elect to call
on the superclass' method as part of its own
implementation.
instance (Or object instance). A specific object, as distinguished
from a class which is an abstract definition of an object.
instance method A method valid for a particular instance of an object.
metaclass A class whose instances are all classes. In SOM, any class
descended from SOMClass is a metaclass. The methods of a
metaclass are sometimes called class methods.
method One of the units that makes up the behavior of an object.
A method is a combination of a function and a name, such
that many different functions can have the same name.
Which function the name refers to at any point in time
depends on the object that is to execute the method and is
the subject of method resolution.
object The elements of data and function that programs create,
manipulate, pass as arguments, and so forth. An object is
a way of associating specific data values with a specific
set of named functions (called methods) for a period of
time (referred to as the lifetime of the object). The data
values of an object are referred to as its state. In SOM,
objects are created by other objects called classes. The
specification of what comprises the set of functions and
data elements that make up an object is referred to as the
definition of a class.
SOM objects offer a high degree of encapsulation. This
property permits many aspects of the implementation of an
object to change without affecting client programs that
depend on the object's behavior.
object definition See class.
object instance See instance.
subclass A class that inherits from another class. See inheritance.
superclass A class from which another class inherits. See
inheritance.
ΓòÉΓòÉΓòÉ 2.12. Programming Considerations ΓòÉΓòÉΓòÉ
This section provides information you need to consider before you begin
programming with Workplace Shell methods.
ΓòÉΓòÉΓòÉ 2.12.1. Method Considerations ΓòÉΓòÉΓòÉ
When including the "OBJECTID=<...>" keyname/value pair in a setup string, it
must be specified as the last entry in the string.
ΓòÉΓòÉΓòÉ 2.12.2. Stack Size ΓòÉΓòÉΓòÉ
Existing 16-bit applications (small and tiny models) must have a 4KB stack
available when they enter system calls; otherwise, the stack can overflow into
the data area.
ΓòÉΓòÉΓòÉ 2.12.3. C++ Considerations ΓòÉΓòÉΓòÉ
This section contains several topics you should take into consideration if you
are using C++ **.
ΓòÉΓòÉΓòÉ 2.12.3.1. C++ Header Files ΓòÉΓòÉΓòÉ
OS/2 functions that used to take a PSZ as a parameter, and that do not modify
the contents of the passed string, have been updated in the C++ header files to
take a PCSZ data type parameter. The use of PCSZ allows for better optimization
by the compiler and is more semantically compatible with C++. Existing code
that calls functions that use PSZ will continue to work correctly.
Several of the typedefs have been changed in the C++ header files. For example,
many items that are unsigned char in the C header files are char in the C++
header files. For instance,
typedef unsigned char BYTE;
has changed to
typedef char BYTE;
The existing samples that are included in the IBM Developer's Toolkit for OS/2
Warp, Version 3 can be used with either set of the header files.
ΓòÉΓòÉΓòÉ 2.12.3.2. PCSZ Data Type ΓòÉΓòÉΓòÉ
Note: The PCSZ data type is defined in the C++ header files included with this
product. The use of the "const" keyword is not necessarily specific to
C++. Certain C compilers support it as well.
If a function takes as a parameter a string that is not changed by the
function, the string parameter can be declared as a "const" string, or a PCSZ.
PCSZ is defined in the C++ header files as a "const" pointer to a
NULL-delimited string. The "const" means that the function will not change the
contents of the string.
Declaring the parameter as PCSZ informs the C++ compiler that the function
will not change the string. Therefore, the compiler simply passes a pointer to
the string in the function parameter list. If the parameter is declared as a
normal PSZ (not "const"), the compiler assumes that the function might change
the string. Under these circumstances the compiler will add code to make a
copy of the string then pass a pointer to the copy, rather than pass a pointer
to the original string.
A smaller, faster executable is often produced if the data item passed in a
parameter list is declared as "const".
If the data item is declared as "const" then it must not be changed by the
function.
ΓòÉΓòÉΓòÉ 2.12.3.3. LINK386 ΓòÉΓòÉΓòÉ
The C++ compiler will provide a dynamic link library which is be used by
LINK386 when generating error messages. This DLL will convert a compiler
generated mangled name into the function prototype. If the DLL is not present,
an error message will be displayed and LINK386 will display the
compiler-generated mangled name in error messages.
ΓòÉΓòÉΓòÉ 3. Workplace Object Classes ΓòÉΓòÉΓòÉ
This chapter contains an alphabetic listing of the Workplace object classes.
These sections contain technical reference information. See the Workplace Shell
Programming Guide for Workplace guide information. For information on the
System Object Model (SOM), see the System Object Model Guide and Reference.
The following is some terminology used in these sections:
class A way of categorizing objects based on their behavior and
shape. A class is, in effect, a definition of a generic
object. In SOM, a class is a special kind of object that
can manufacture other objects that all have a common shape
and exhibit similar behavior (more precisely, all of the
objects manufactured by a class have the same memory
layout and share a common set of methods). New classes can
be defined in terms of existing classes through a
technique known as inheritance.
class method A class method of class <X> is a method provided by the
metaclass of class <X>. Class methods are executed without
requiring any instances of class <X> to exist, and are
frequently used to create instances.
inheritance The technique of specifying the shape and behavior of one
class (called a subclass) as incremental differences from
another class (called the parent class or superclass). The
subclass inherits the superclass' state representation and
methods, and can provide additional data elements and
methods. The subclass also can provide new functions with
the same method names used by the superclass. Such a
subclass method is said to override the superclass method,
and will be selected automatically by method resolution on
subclass instances. An overriding method can elect to call
upon the superclass' method as part of its own
implementation.
instance (Or object instance). A specific object, as distinguished
from the abstract definition of an object referred to as
its class.
instance method A method valid for a particular object.
metaclass A class whose instances are all classes. In SOM, any class
descended from SOMClass is a metaclass. The methods of a
metaclass are sometimes called "class" methods.
method One of the units that makes up the behavior of an object.
A method is a combination of a function and a name, such
that many different functions can have the same name.
Which function the name refers to at any point in time
depends on the object that is to execute the method and is
the subject of method resolution.
object The elements of data and function that programs create,
manipulate, pass as arguments, and so forth. An object is
a way of associating specific data values with a specific
set of named functions (called methods) for a period of
time (referred to as the lifetime of the object). The data
values of an object are referred to as its state. In SOM,
objects are created by other objects called classes. The
specification of what comprises the set of functions and
data elements that make up an object is referred to as the
definition of a class.
SOM objects offer a high degree of encapsulation. This
property permits many aspects of the implementation of an
object to change without affecting client programs that
depend on the object's behavior.
object definition See class.
object instance See instance.
parent class See inheritance.
subclass A class that inherits from another class. See inheritance.
superclass A class from which another class inherits. See
inheritance.
Workplace objects are icons representative of physical objects which users
deal with in the Workplace. A Workplace object is implemented as an instance
of a Workplace object class. Workplace object classes are System Object Model
(SOM) object classes which are descendants of the predefined Workplace object
class, WPObject. For more information about SOM object classes, see System
Object Model Guide and Reference.
All Workplace objects are descendants of a Workplace object storage class.
Workplace storage object classes are responsible primarily for storing and
retrieving object class data for instances of objects which are descendants
(subclasses) of that storage class.
The three predefined Workplace object storage classes are:
WPAbstract Storage class for objects stored in the user profile (OS2.INI)
WPFileSystem Storage class for objects stored as files in the file system
WPTransient Storage class for non-persistent objects.
ΓòÉΓòÉΓòÉ 3.1. Workplace Object Class Hierarchy ΓòÉΓòÉΓòÉ
The following figure lists the predefined Workplace object classes in a
hierarchical order. Each branch in the tree represents an immediate descendant
(subclass) of a Workplace object class. The predefined SOM object class,
SOMObject, is the root class for all SOM object classes, including all
Workplace object classes.
CLASS NAME CLASS DEFINITION FILE
SOMObject somobj.idl
Γö£ΓöÇΓöÇ SOMClass somcls.idl
Γö£ΓöÇΓöÇ SOMClassMgr somcm.idl
ΓööΓöÇΓöÇ WPObject wpobject.idl
Γö£ΓöÇΓöÇ WPAbstract wpabs.idl
Γöé Γö£ΓöÇΓöÇ WPClock wpclock.idl
Γöé Γö£ΓöÇΓöÇ WPCountry wpctry.idl
Γöé Γö£ΓöÇΓöÇ WPDisk wpdisk.idl
Γöé Γö£ΓöÇΓöÇ WPKeyboard wpkeybd.idl
Γöé Γö£ΓöÇΓöÇ WPLaunchPad wplnchpd.idl
Γöé Γö£ΓöÇΓöÇ WPMouse wpmouse.idl
Γöé Γö£ΓöÇΓöÇ WPPalette wppalet.idl
Γöé Γöé Γö£ΓöÇΓöÇ WPColorPalette wpclrpal.idl
Γöé Γöé Γö£ΓöÇΓöÇ WPFontPalette wpfntpal.idl
Γöé Γöé ΓööΓöÇΓöÇ WPSchemePalette wpscheme.idl
Γöé Γö£ΓöÇΓöÇ WPPower wppower.idl
Γöé Γö£ΓöÇΓöÇ WPPrinter wpprint.idl
Γöé Γöé ΓööΓöÇΓöÇ WPRPrinter wprprint.idl
Γöé Γö£ΓöÇΓöÇ WPProgram wppgm.idl
Γöé Γö£ΓöÇΓöÇ WPShadow wpshadow.idl
Γöé Γöé ΓööΓöÇΓöÇ WPNetLink wpnetlnk.idl
Γöé Γö£ΓöÇΓöÇ WPShredder wpshred.idl
Γöé Γö£ΓöÇΓöÇ WPSound wpsound.idl
Γöé Γö£ΓöÇΓöÇ WPSpecialNeeds wpspneed.idl
Γöé Γö£ΓöÇΓöÇ WPSpool wpspool.idl
Γöé Γö£ΓöÇΓöÇ WPSystem wpsystem.idl
Γöé ΓööΓöÇΓöÇ WPWinConfig wincfg.idl
Γö£ΓöÇΓöÇ WPFileSystem wpfsys.idl
Γöé Γö£ΓöÇΓöÇ WPDataFile wpdataf.idl
Γöé Γöé Γö£ΓöÇΓöÇ WPBitmap wpbitmap.idl
Γöé Γöé Γö£ΓöÇΓöÇ WPIcon wpicon.idl
Γöé Γöé Γö£ΓöÇΓöÇ WPMet wpmet.idl
Γöé Γöé Γö£ΓöÇΓöÇ WPPif wppif.idl
Γöé Γöé Γö£ΓöÇΓöÇ WPPointer wpptr.idl
Γöé Γöé ΓööΓöÇΓöÇ WPProgramFile wppgmf.idl
Γöé Γöé ΓööΓöÇΓöÇ WPCommandFile wpcmdf.idl
Γöé ΓööΓöÇΓöÇ WPFolder wpfolder.idl
Γöé Γö£ΓöÇΓöÇ WPDesktop wpdesk.idl
Γöé Γö£ΓöÇΓöÇ WPDrives wpdrives.idl
Γöé Γö£ΓöÇΓöÇ WPMinWinViewer wpmwv.idl
Γöé Γö£ΓöÇΓöÇ WPNetgrp wpnetgrp.idl
Γöé Γö£ΓöÇΓöÇ WPNetwork wpnetwrk.idl
Γöé Γö£ΓöÇΓöÇ WPRootFolder wprootf.idl
Γöé Γö£ΓöÇΓöÇ WPServer wpserver.idl
Γöé Γö£ΓöÇΓöÇ WPSharedDir wpshdir.idl
Γöé Γö£ΓöÇΓöÇ WPStartup wpstart.idl
Γöé ΓööΓöÇΓöÇ WPTemplates wptemps.idl
ΓööΓöÇΓöÇ WPTransient wptrans.idl
Γö£ΓöÇΓöÇ WPJob wpjob.idl
Γö£ΓöÇΓöÇ WPPdr wppdr.idl
Γö£ΓöÇΓöÇ WPPort wpport.idl
ΓööΓöÇΓöÇ WPQdr wpqdr.idl
Instances of some Workplace object classes cannot be created as a Workplace
object. These classes are provided as base classes which provide support for
descendant classes that can have instances created. Other classes are SOM
classes and are described in better detail in the System Object Model Guide and
Reference.
These classes include:
SOMObject This is the SOM root class. All SOM classes must be descended
from SOMObject. A Workplace object of this class cannot be
created.
SOMClass This is the SOM metaclass, that is, the instances of this class
are class objects. A Workplace object of this class cannot be
created.
SOMClassMgr This is the SOM class manager class. A Workplace object of this
class cannot be created.
ΓòÉΓòÉΓòÉ 3.2. WPAbstract ΓòÉΓòÉΓòÉ
Class definition file: wpabs.idl
Class hierarchy
SOMObject
WPObject
WPAbstract
Description
This is the abstract object storage class. The storage medium for objects that
are descendants of the WPAbstract class is the INI file. In other words, any
object class derived from WPAbstract will have persistent storage for its
instance variables in the INI file. Note that an abstract object does not have
a file name, just a numeric handle that can be used to identify it. It can
optionally be assigned an object id to uniquely identify it. An instance of
this class can be created as a Workplace object. No instances of this class are
initially created by the system.
Instance methods
There are currently no methods defined for the WPAbstract Workplace object
class.
WPObject instance methods
The following list shows all the methods overridden by the WPAbstract class.
These methods are overridden in order to modify the behavior defined by an
ancestor class.
o wpCopyObject
o wpDragOver
o wpMoveObject
o wpQueryHandle
o wpQueryIcon
o wpQueryIconData
o wpQueryNameClashOptions
o wpRestoreState
o wpSaveImmediate
o wpSaveState
o wpSetIconData
o wpSetTitle
Class methods
There following list shows the WPAbstract class methods.
o wpclsQuerySetting
o wpclsSetSetting
WPObject class methods.
The following shows the class methods overridden by the WPAbstract class.
These methods are overridden to modify the behavior defined by an ancestor
class.
o wpclsQueryTitle
ΓòÉΓòÉΓòÉ 3.3. WPBitmap ΓòÉΓòÉΓòÉ
Class definition file: wpbitmap.idl
Class hierarchy
SOMObject
WPObject
WPFileSystem
WPDataFile
WPBitmap
Description
This is the WPBitmap object class. All bit maps are of this class. These bit
map files are templatable. An instance of this class can be created as a
Workplace object. Instances of this class are created initially by the system
for each bit map in the system.
Instance methods
There are currently no methods defined for the WPBitmap Workplace object class.
WPObject instance methods
The following list shows all the methods overridden by the WPBitmap class.
These methods are overridden in order to modify the behavior defined by an
ancestor class.
o wpSetupOnce
Class methods
There are currently no class methods defined for the WPBitmap Workplace object
class.
WPObject class methods.
The following list shows all the class methods overridden by the WPBitmap
class. These methods are overridden to modify the behavior defined by an
ancestor class.
o wpclsInitData
o wpclsQueryDefaultHelp
o wpclsQueryTitle
WPFileSystem class methods.
The following list shows all the class methods overridden by the WPBitmap
class. These methods are overridden to modify the behavior defined by an
ancestor class.
o wpclsQueryInstanceFilter
o wpclsQueryInstanceType
ΓòÉΓòÉΓòÉ 3.4. WPClock ΓòÉΓòÉΓòÉ
Class definition file: wpclock.idl
Class hierarchy
SOMObject
WPObject
WPAbstract
WPClock
Description
This is the system clock object class. An instance of this class can be created
as a Workplace object. An instance of this class is created initially by the
system. It has the title "System Clock" and resides in the "System Setup"
folder.
Instance methods
The following list shows all the WPClock instance methods:
o wpAddClockAlarmPage
o wpAddClockDateTimePage
o wpAddClockView1Page
o wpAddClockView2Page
WPObject instance methods
The following list shows all the methods overridden by the WPClock class.
These methods are overridden in order to modify the behavior defined by an
ancestor class.
o wpAddObjectWindowPage
o wpAddSettingsPages
o wpFilterPopupMenu
o wpMenuItemHelpSelected
o wpMenuItemSelected
o wpModifyPopupMenu
o wpOpen
o wpRestoreState
o wpSaveState
Class methods
There are currently no class methods defined for the WPClock Workplace object
class.
WPObject class methods.
The following list shows all the class methods overridden by the WPClock
class. These methods are overridden to modify the behavior defined by an
ancestor class.
o wpclsQueryDefaultHelp
o wpclsQueryDefaultView
o wpclsQueryIconData
o wpclsQueryStyle
o wpclsQueryTitle
ΓòÉΓòÉΓòÉ 3.5. WPColorPalette ΓòÉΓòÉΓòÉ
Class definition file: wpclrpal.idl
Class hierarchy
SOMObject
WPObject
WPAbstract
WPPalette
WPColorPalette
Description
This is the color palette object class. An instance of this class can be
created as a Workplace object. Two instances of this class are created
initially by the system, with the titles "Mixed Color Palette" and "Solid Color
Palette", both residing in the "System Setup" folder.
Instance methods
There are currently no methods defined for the WPColorPalette Workplace object
class.
WPObject instance methods
The following list shows all the methods overridden by the WPColorPalette
class. These methods are overridden in order to modify the behavior defined by
an ancestor class.
o wpInitData
o wpMenuItemHelpSelected
o wpSetup
wpSetup override by WPColorPalette
The following table shows the keyname-value pairs added by the WPColorPalette
class.
ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ
ΓöéKEYNAME ΓöéVALUE ΓöéDESCRIPTION Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéCOLORS ΓöéRGB valuesΓöéThese are the initial color values of Γöé
Γöé Γöé Γöéeach cell in the color palette. The Γöé
Γöé Γöé Γöévalues for each cell are separated by Γöé
Γöé Γöé Γöécommas. This is equivalent to calling Γöé
Γöé Γöé Γöéthe wpSetupCell method. The RGB value Γöé
Γöé Γöé Γöémust be presented as a 6-digit hex valueΓöé
Γöé Γöé Γöéin the format 0xRRGGBB where RR, GG, andΓöé
Γöé Γöé ΓöéBB are the red, green, and blue, values Γöé
Γöé Γöé Γöéranging between 0x00 and 0xFF (0-255). Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéXCELLCOUNTΓöécolumns ΓöéNumber of X cells as decimal digits. Γöé
Γöé Γöé ΓöéFor Solid Color Palette, AUTOSETUP=LORESΓöé
Γöé Γöé Γöémust be specified, and the default valueΓöé
Γöé Γöé Γöéis 8. Γöé
Γöé Γöé ΓöéFor Mixed Color Palette, AUTOSETUP=HIRESΓöé
Γöé Γöé Γöémust be specified, and the default valueΓöé
Γöé Γöé Γöéis 16. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéYCELLCOUNTΓöérows ΓöéNumber of Y cells as decimal digits. Γöé
Γöé Γöé ΓöéFor Solid Color Palette, AUTOSETUP=LORESΓöé
Γöé Γöé Γöémust be specified, and the default valueΓöé
Γöé Γöé Γöéis 2. Γöé
Γöé Γöé ΓöéFor Mixed Color Palette, AUTOSETUP=HIRESΓöé
Γöé Γöé Γöémust be specified, and the default valueΓöé
Γöé Γöé Γöéis 16. Γöé
ΓööΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö┤ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö┤ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÿ
Example
pszSetupString="COLORS=0x000000,0xFFFFFF,0xFF23B4
0x505050,0x00FFFF,0xA0A0A0"
WPPalette methods
The following list shows all the methods overridden by the WPColorPalette
class. These methods are overridden in order to modify the behavior defined by
an ancestor class.
o wpDragCell
o wpEditCell
o wpPaintCell
o wpQueryPaletteHelp
Class methods
There are currently no class methods defined for the WPColorPalette Workplace
object class.
WPObject class methods.
The following list shows all the class methods overridden by the
WPColorPalette class. These methods are overridden to modify the behavior
defined by an ancestor class.
o wpclsCreateDefaultTemplates
o wpclsQueryDefaultHelp
o wpclsQueryIconData
o wpclsQueryStyle
o wpclsQueryTitle
WPPalette class methods.
The following list shows all the class methods overridden by the
WPColorPalette class. These methods are overridden to modify the behavior
defined by an ancestor class.
o wpclsQueryEditString
ΓòÉΓòÉΓòÉ 3.6. WPCommandFile ΓòÉΓòÉΓòÉ
Class definition file: wpcmdf.idl
Class hierarchy
SOMObject
WPObject
WPFileSystem
WPDataFile
WPProgramFile
WPCommandFile
Description
This is the command file object class. All DOS and OS/2 command/batch files are
of this class. These program files are templatable. An instance of this class
can be created as a Workplace object. Instances of this class are created
initially by the system for each command file in the system. Each instance has
a title corresponding to the file name of the command file it represents and
resides in a folder corresponding to the physical directory in which the
program file resides.
Instance methods
There are currently no methods defined for the WPCommandFile Workplace object
class.
WPObject instance methods
The following list shows all the methods overridden by the WPCommandFile class.
These methods are overridden in order to modify the behavior defined by an
ancestor class.
o wpPrintObject
Class methods
There are currently no class methods defined for the WPCommandFile Workplace
object class.
WPObject class methods.
The following list shows all the class methods overridden by the WPCommandFile
class. These methods are overridden to modify the behavior defined by an
ancestor class.
o wpclsQueryStyle
o wpclsQueryTitle
WPFileSystem class methods.
The following list shows all the class methods overridden by the WPCommandFile
class. These methods are overridden to modify the behavior defined by an
ancestor class.
o wpclsQueryInstanceFilter
o wpclsQueryInstanceType
ΓòÉΓòÉΓòÉ 3.7. WPCountry ΓòÉΓòÉΓòÉ
Class definition file: wpctry.idl
Class hierarchy
SOMObject
WPObject
WPAbstract
WPCountry
Description
This is the country object class. An instance of this class can be created as a
Workplace object. An instance of this class is created initially by the system.
It has the title, "Country" and resides in the "System Setup" folder.
Instance methods
The following list shows all the WPCountry instance methods:
o wpAddCountryDatePage
o wpAddCountryNumbersPage
o wpAddCountryPage
o wpAddCountryTimePage
WPObject instance methods
The following list shows all the methods overridden by the WPCountry class.
These methods are overridden in order to modify the behavior defined by an
ancestor class.
o wpAddObjectWindowPage
o wpAddSettingsPages
o wpFilterPopupMenu
o wpInitData
Class methods
There are currently no class methods defined for the WPCountry Workplace
object class.
WPObject class methods.
The following list shows all the class methods overridden by the WPCountry
class. These methods are overridden to modify the behavior defined by an
ancestor class.
o wpclsQueryDefaultHelp
o wpclsQueryDefaultView
o wpclsQueryIconData
o wpclsQueryStyle
o wpclsQueryTitle
ΓòÉΓòÉΓòÉ 3.8. WPDataFile ΓòÉΓòÉΓòÉ
Class definition file: wpdataf.idl
Class hierarchy
SOMObject
WPObject
WPFileSystem
WPDataFile
Description
This is the data file object class. An instance of this class can be created as
a Workplace object and is created initially by the system in its template form.
The template form of this class has the title "Data file" and resides in the
"Templates" folder.
Instance methods
The following list shows all the WPDataFile methods:
o wpAddFileTypePage
o wpPrintMetaFile
o wpPrintPifFile
o wpPrintPrinterSpecificFile
o wpPrintUnknownFile
o wpQueryAssociatedFileIcon
o wpQueryAssociatedProgram
o wpSetAssociatedFileIcon
WPObject instance methods
The following list shows all the methods overridden by the WPDataFile class.
These methods are overridden in order to modify the behavior defined by an
ancestor class.
o wpAddObjectWindowPage
o wpAddSettingsPages
o wpDragOver
o wpFormatDragItem
o wpMenuItemHelpSelected
o wpMenuItemSelected
o wpModifyPopupMenu
o wpOpen
o wpPrintObject
o wpQueryDefaultHelp
o wpQueryIcon
o wpRestoreState
o wpSetDefaultView
o wpSetRealName
WPFileSystem instance methods
The following list shows all the methods overridden by the WPDataFile class.
These methods are overridden in order to modify the behavior defined by an
ancestor class.
o wpSetType
Class methods
There are currently no class methods defined for the WPDataFile Workplace
object class.
WPObject class methods.
The following list shows all the class methods overridden by the WPDataFile
class. These methods are overridden to modify the behavior defined by an
ancestor class.
o wpclsQueryDefaultHelp
o wpclsQueryDefaultView
o wpclsQueryIconData
o wpclsQueryStyle
o wpclsQueryTitle
ΓòÉΓòÉΓòÉ 3.9. WPDesktop ΓòÉΓòÉΓòÉ
Class definition file: wpdesk.idl
Class hierarchy
SOMObject
WPObject
WPFileSystem
WPFolder
WPDesktop
Description
This is the Workplace desktop object class. An instance of this class can be
created as a Workplace object. An instance of this class is created initially
by the system. It has the title "Desktop" and initially resides in the root
directory of the drive containing the user profile.
Instance methods
The following list shows all the WPDesktop methods:
o wpAddDesktopArcRest1Page
o wpAddDesktopDefDT1Page
o wpAddDesktopLockup1Page
o wpAddDesktopLockup2Page
o wpAddDesktopLockup3Page
o wpIsCurrentDesktop
WPObject instance methods
The following list shows all the methods overridden by the WPDesktop class.
These methods are overridden in order to modify the behavior defined by an
ancestor class.
o wpAddSettingsPages
o wpFilterPopupMenu
o wpInitData
o wpMenuItemSelected
o wpModifyPopupMenu
o wpRestoreState
o wpSaveState
Class methods
The following list shows the WPDesktop class methods.
o wpclsQueryActiveDesktop
o wpclsQueryActiveDesktopHWND
o wpclsQueryObjectFromFrame
WPObject class methods.
The following list shows all the class methods overridden by the WPDesktop
class. These methods are overridden to modify the behavior defined by an
ancestor class.
o wpclsQueryDefaultHelp
o wpclsQueryDefaultView
o wpclsQueryIconData
o wpclsQueryStyle
o wpclsQueryTitle
ΓòÉΓòÉΓòÉ 3.10. WPDisk ΓòÉΓòÉΓòÉ
Class definition file: wpdisk.idl
Class hierarchy
SOMObject
WPObject
WPAbstract
WPDisk
Description
This is the file-system device object class. It is used to represent all types
of file-system devices including:
o CD ROM drives
o Fixed disk drives
o Floppy diskette drives
o Magnetic tape drives
o Network drives
o PCMCIA** devices
o Ram drives
An instance of this class can be created as a Workplace object. Shadow
instances of this class are created initially by the system for each
file-system device available. Each instance has a title corresponding to a
file-system device and resides in the Drives folder. If a primary, local,
removable, media file-system device such as a floppy drive exists, an instance
of this class will also be created on the desktop, and will represent this
drive. These instances actually appear as WPShadow objects which are shadows
of WPDisk objects.
Instance methods
The following list shows the WPDisk methods:
o wpAddDiskDetailsPage
o wpEjectDisk
o wpLockDrive
o wpQueryDriveLockStatus
o wpQueryLogicalDrive
o wpQueryRootFolder
o wpSetCorrectDiskIcon
WPObject instance methods
The following list shows all the methods overridden by the WPDisk class. These
methods are overridden in order to modify the behavior defined by an ancestor
class.
o wpAddObjectWindowPage
o wpAddSettingsPages
o wpDragOver
o wpDrop
o wpFilterPopupMenu
o wpMenuItemHelpSelected
o wpMenuItemSelected
o wpModifyPopupMenu
o wpOpen
o wpQueryDefaultHelp
o wpQueryIconData
o wpRestoreState
o wpSaveState
o wpSetIconData
o wpSetTitle
o wpSetup
o wpUnInitData
o wpViewObject
The following list shows all the methods overridden by the WPDisk class. These
methods are overridden in order to modify the behavior defined by an ancestor
class.
o wpFilterPopupMenu
o wpMenuItemHelpSelected
o wpMenuItemSelected
o wpModifyPopupMenu
wpSetup override by WPDisk
The following table shows the keyname-value pairs added by the WPDisk class.
ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ
ΓöéKEYNAME ΓöéVALUE ΓöéDESCRIPTION Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéDRIVENUM ΓöéDRIVENUM=dd ΓöéLogical drive number (1-26). Γöé
ΓööΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö┤ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö┤ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÿ
Class methods
There are currently no class methods defined for the WPDisk Workplace object
class.
WPObject class methods.
The following list shows all the class methods overridden by the WPDisk class.
These methods are overridden to modify the behavior defined by an ancestor
class.
o wpclsQueryDefaultHelp
o wpclsQueryDefaultView
o wpclsQueryIconData
o wpclsQueryStyle
o wpclsQueryTitle
ΓòÉΓòÉΓòÉ 3.11. WPDrives ΓòÉΓòÉΓòÉ
Class definition file: wpdrives.idl
Class hierarchy
SOMObject
WPObject
WPFileSystem
WPFolder
WPDrives
Description
This is the file-system device folder object class. An instance of this class
can be created as a Workplace object. An instance of this class is created
initially by the system. It has the title "Drives" and resides in the "OS/2
System" folder.
Instance methods
There are currently no methods defined for the WPDrives Workplace object class.
WPObject methods
The following list shows all the methods overridden by the WPDrives class.
These methods are overridden in order to modify the behavior defined by an
ancestor class.
o wpFilterPopupMenu
o wpMenuItemHelpSelected
o wpMenuItemSelected
o wpModifyPopupMenu
WPFolder methods
The following list shows all the methods overridden by the WPDrives class.
These methods are overridden in order to modify the behavior defined by an
ancestor class.
o wpPopulate
Class methods
There are currently no class methods defined for the WPDrives Workplace object
class.
WPObject class methods.
The following list shows all the class methods overridden by the WPDrives
class. These methods are overridden to modify the behavior defined by an
ancestor class.
o wpclsQueryDefaultHelp
o wpclsQueryIconData
o wpclsQueryStyle
o wpclsQueryTitle
ΓòÉΓòÉΓòÉ 3.12. WPFileSystem ΓòÉΓòÉΓòÉ
Class definition file: wpfsys.idl
Class hierarchy
SOMObject
WPObject
WPFileSystem
Description
This is the file-system object storage class. WPFileSystem is the storage class
that represents all file-system objects including directory (folder), data
file, executable file, and root directory (drive) objects. This class also
provides persistent storage of instance variables for all classes derived from
it. Persistent data for instances of WPFileSystem subclasses are stored in the
Extended Attributes (EAs) of the file or directory.
This is a base storage class; it is not intended for instances of this class to
be created.
Instance methods
The following list shows all the WPFileSystem class methods:
o wpAddFileMenuPage
o wpAddFile1Page
o wpAddFile2Page
o wpAddFile3Page
o wpConfirmKeepAssoc
o wpConfirmRenameFileWithExt
o wpIsDiskSwapped
o wpPrintPlainTextFile
o wpQueryAttr
o wpQueryCreation
o wpQueryDateInfo
o wpQueryDisk
o wpQueryEASize
o wpQueryFilename
o wpQueryFileSize
o wpQueryLastAccess
o wpQueryLastWrite
o wpQueryRealName
o wpQueryType
o wpRefresh
o wpSetAttr
o wpSetDateInfo
o wpSetFileSizeInfo
o wpSetRealName
o wpSetTitleAndRenameFile
o wpSetType
o wpVerifyUpdateAccess
WPObject instance methods
The following list shows all the methods overridden by the WPFileSystem class.
These methods are overridden in order to modify the behavior defined by an
ancestor class.
o wpAddSettingsPages
o wpCopyObject
o wpCreateFromTemplate
o wpDoesObjectMatch
o wpDraggedOverObject
o wpDroppedOnObject
o wpFilterPopupMenu
o wpFormatDragItem
o wpMenuItemSelected
o wpModifyPopupMenu
o wpMoveObject
o wpOpen
o wpQueryDetailsData
o wpQueryHandle
o wpQueryIcon
o wpQueryIconData
o wpQueryNameClashOptions
o wpQueryStyle
o wpRestoreState
o wpSaveImmediate
o wpSaveState
o wpSetIconData
o wpSetStyle
o wpSetTitle
o wpSwitchTo
o wpUnInitData
o wpViewObject
Class methods
The following list shows the WPFileSystem class methods:
o wpclsFileSysExists
o wpclsQueryAwakeObject
o wpclsQueryInstanceFilter
o wpclsQueryInstanceType
o wpclsQueryObjectFromPath
WPObject class methods.
The following list shows all the class methods overridden by the WPFileSystem
class. These methods are overridden to modify the behavior defined by an
ancestor class.
o wpclsInitData
o wpclsQueryDetailsInfo
o wpclsQueryExtendedCriteria
o wpclsNew
o wpclsQuerySearchInfo
o wpclsQueryTitle
ΓòÉΓòÉΓòÉ 3.13. WPFolder ΓòÉΓòÉΓòÉ
Class definition file: wpfolder.idl
Class hierarchy
SOMObject
WPObject
WPFileSystem
WPFolder
Description
This is the folder object class. An instance of this class can be created as a
Workplace object. An instance of this class is created initially by the system
in its template form. It has the title "Folder" and resides in the "Templates"
folder. Every directory in the system is represented by a WPFolder object.
Instance methods
The following list shows how all the WPFolder methods are related within
functional areas:
Settings notebook methods
o wpAddFolderBackgroundPage
o wpAddFolderIncludePage
o wpAddFolderSelfClosePage
o wpAddFolderSortPage
o wpAddFolderView1Page
o wpAddFolderView2Page
o wpAddFolderView3Page
Object position methods
o wpQueryIconViewPos
o wpQueryNextIconPos
o wpSetNextIconPos
Folder attributes methods
o wpIsDetailsColumnVisible
o wpIsSortAttribAvailable
o wpModifyFldrFlags
o wpQueryFldrAttr
o wpQueryFldrDetailsClass
o wpQueryFldrFlags
o wpQueryFldrFont
o wpQueryFldrSort
o wpQueryFldrSortClass
o wpSetDetailsColumnVisibility
o wpSetFldrAttr
o wpSetFldrDetailsClass
o wpSetFldrFlags
o wpSetFldrFont
o wpSetFldrSort
o wpSetFldrSortClass
o wpSetSortAttribAvailable
Folder state methods
o wpHideFldrRunObjs
Folder content methods
o wpAddFirstChild
o wpAddToContent
o wpContainsFolders
o wpDeleteContents
o wpDeleteFromContent
o wpPopulate
o wpQueryContent
WPObject instance methods
The following list shows all the methods overridden by the WPFolder class.
These methods are overridden in order to modify the behavior defined by an
ancestor class.
o wpAddObjectWindowPage
o wpAddSettingsPages
o wpConfirmDelete
o wpDelete
o wpDragOver
o wpDrop
o wpFilterPopupMenu
o wpFormatDragItem
o wpFree
o wpInitData
o wpMenuItemHelpSelected
o wpMenuItemSelected
o wpModifyPopupMenu
o wpMoveObject
o wpObjectReady
o wpOpen
o wpQueryDefaultHelp
o wpQueryDefaultView
o wpRender
o wpRenderComplete
o wpRestoreState
o wpSaveState
o wpSetIconData
o wpSetup
o wpUnInitData
WPFileSystem instance methods
The following list shows all the methods overridden by the WPFolder class.
These methods are overridden in order to modify the behavior defined by an
ancestor class.
o wpAddFile2Page
o wpAddFile3Page
wpSetup override by WPFolder
The following table shows the keyname-value pairs supported by the WPFolder
class.
ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ
ΓöéKEYNAME ΓöéVALUE ΓöéDESCRIPTION Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéALWAYSSORT ΓöéYES ΓöéSort order is always Γöé
Γöé Γöé Γöémaintained. Opening and addingΓöé
Γöé Γöé Γöéan object to a folder may takeΓöé
Γöé Γöé Γöélonger if the sort order is Γöé
Γöé Γöé Γöébeing maintained. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéNO ΓöéSort order is not maintained. Γöé
Γöé Γöé ΓöéThis is the default value. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéBACKGROUND ΓöéN,M,S,B,C ΓöéThis sets the folder Γöé
Γöé Γöé Γöébackground, where: Γöé
Γöé Γöé ΓöéN = Image file name. This Γöé
Γöé Γöé Γöé name must be the fully- Γöé
Γöé Γöé Γöé qualified path of the Γöé
Γöé Γöé Γöé image file. "?:\" is Γöé
Γöé Γöé Γöé permitted to indicate the Γöé
Γöé Γöé Γöé boot drive. Γöé
Γöé Γöé Γöé Γöé
Γöé Γöé ΓöéM = Image mode. This mode can Γöé
Γöé Γöé Γöé be one of the following: Γöé
Γöé Γöé Γöé N = Normal image Γöé
Γöé Γöé Γöé T = Titled image Γöé
Γöé Γöé Γöé S = Scaled image Γöé
Γöé Γöé Γöé Γöé
Γöé Γöé ΓöéS = Scaling factor. Γöé
Γöé Γöé Γöé Γöé
Γöé Γöé ΓöéB = Background type. This can Γöé
Γöé Γöé Γöé be one of the following: Γöé
Γöé Γöé Γöé I = Image Γöé
Γöé Γöé Γöé C = Color only Γöé
Γöé Γöé Γöé Γöé
Γöé Γöé ΓöéC = Background color. This Γöé
Γöé Γöé Γöé color can be 3 numbers re-Γöé
Γöé Γöé Γöé presenting RGB values or Γöé
Γöé Γöé Γöé the default, in the Γöé
Γöé Γöé Γöé following format: Γöé
Γöé Γöé Γöé Γöé
Γöé Γöé Γöé {R-value G-value B-value} Γöé
Γöé Γöé Γöé Γöé
Γöé Γöé ΓöéFor example: Γöé
Γöé Γöé Γöé"BACKGROUND= Γöé
Γöé Γöé ΓöéC:\OS2\BITMAP\OS2LOGO.BMP,S, Γöé
Γöé Γöé Γöé3,I" Γöé
Γöé Γöé Γöéor Γöé
Γöé Γöé Γöé"BACKGROUND= Γöé
Γöé Γöé Γöé(none),,,C,0 128 128" Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéDEFAULTVIEW ΓöéICON ΓöéThis sets the default open Γöé
Γöé Γöé Γöéview to the ICON (or CONTENTS)Γöé
Γöé Γöé Γöéview. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéTREE ΓöéThis sets the default open Γöé
Γöé Γöé Γöéview to the TREE view. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéDETAILS ΓöéThis sets the default open Γöé
Γöé Γöé Γöéview to the DETAILS view. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé Γöé ΓöéThe default view of the Γöé
Γöé Γöé Γöécontaining folder. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéDETAILSCLASS Γöéclassname ΓöéThis sets the object class forΓöé
Γöé Γöé Γöéwhich the details are Γöé
Γöé Γöé Γöédisplayed in details view. Γöé
Γöé Γöé ΓöéThe default object class is Γöé
Γöé Γöé ΓöéWPFileSystem. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéDETAILSFONT Γöéfont name.size ΓöéSetup string used to change Γöé
Γöé Γöéstring Γöéthe font used for a details Γöé
Γöé Γöé Γöéview. For example: 10.Helv Γöé
Γöé Γöé ΓöéThe default value is 8.Helv. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéDETAILSVIEW Γöés1[,s2,...sn] ΓöéThis set details view to the Γöé
Γöé Γöé Γöéspecified styles. Possible Γöé
Γöé Γöé Γöévalues are: Γöé
Γöé Γöé ΓöéMINI small icon; this is Γöé
Γöé Γöé Γöé the default. Γöé
Γöé Γöé ΓöéNORMAL normal-size icon. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéICONFONT Γöéfont size.facenameΓöéSetup string used to change Γöé
Γöé Γöé Γöéthe font used for an icon Γöé
Γöé Γöé Γöéview. For example: 10.Helv Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéICONNFILE Γöéindex,filename ΓöéThis sets the file name of theΓöé
Γöé Γöé Γöéanimation (open folder) icon. Γöé
Γöé Γöé ΓöéThe "index" value must be set Γöé
Γöé Γöé Γöéto 1. The specified file Γöé
Γöé Γöé Γöécontains the folder's open Γöé
Γöé Γöé Γöéfolder icon. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéICONNRESOURCE Γöéindex,id,modname ΓöéThis sets the resource of the Γöé
Γöé Γöé Γöéanimation (open folder) icon. Γöé
Γöé Γöé ΓöéThe "index" value must be set Γöé
Γöé Γöé Γöéto 1. The "id" is the identityΓöé
Γöé Γöé Γöéof an icon resource in the Γöé
Γöé Γöé Γöé"module" dynamic link library Γöé
Γöé Γöé Γöé(DLL). The specified resource Γöé
Γöé Γöé Γöéis the folder's open folder Γöé
Γöé Γöé Γöéicon. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéICONVIEW Γöés1[,s2,...sn] ΓöéThis sets icon view to the Γöé
Γöé Γöé Γöéspecified styles. Possible Γöé
Γöé Γöé Γöévalues are: Γöé
Γöé Γöé ΓöéFLOWED NOGRID Γöé
Γöé Γöé ΓöéINVISIBLE NONFLOWED Γöé
Γöé Γöé ΓöéMINI NORMAL Γöé
Γöé Γöé Γöé Γöé
Γöé Γöé ΓöéThe default value is Γöé
Γöé Γöé ΓöéNOGRID,NORMAL Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéICONVIEWPOS Γöéx,y,cx,cy ΓöéThis sets the initial icon Γöé
Γöé Γöé Γöéview position and size of the Γöé
Γöé Γöé Γöéfolder on the screen. These Γöé
Γöé Γöé Γöévalues are percentages (0-100)Γöé
Γöé Γöé Γöéof the screen size. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéOPEN ΓöéICON ΓöéThis opens the icon view when Γöé
Γöé Γöé Γöéobject is created or when Γöé
Γöé Γöé ΓöéWinSetObjectData is called. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéTREE ΓöéThis opens the tree view when Γöé
Γöé Γöé Γöéobject is created or when Γöé
Γöé Γöé ΓöéWinSetObjectData is called. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéDETAILS ΓöéThis opens the details view Γöé
Γöé Γöé Γöéwhen object is created or whenΓöé
Γöé Γöé ΓöéWinSetObjectData is called. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé Γöé ΓöéThe default is to not Γöé
Γöé Γöé Γöéautomatically open a view. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéREMOVEFONTS ΓöéYES ΓöéThis removes all instance Γöé
Γöé Γöé Γöéfonts from the folder. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéNO ΓöéThis does not remove instance Γöé
Γöé Γöé Γöéfonts from the folder. Γöé
Γöé Γöé ΓöéThis is the default value. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéSORTCLASS Γöéclassname ΓöéThis sets the class object to Γöé
Γöé Γöé Γöésort by. Γöé
Γöé Γöé ΓöéThe default class object is Γöé
Γöé Γöé ΓöéWPFileSystem. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéTREEFONT Γöéfont size.facenameΓöéThis changes the font used forΓöé
Γöé Γöé Γöéa tree view. For example: Γöé
Γöé Γöé Γöé10.System Proportional Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéTREEVIEW Γöés1[,s2,...sn] ΓöéThis sets the tree view to theΓöé
Γöé Γöé Γöéspecified styles. Possible Γöé
Γöé Γöé Γöévalues are: Γöé
Γöé Γöé ΓöéINVISIBLE LINES Γöé
Γöé Γöé ΓöéMINI NOLINES Γöé
Γöé Γöé ΓöéNORMAL Γöé
Γöé Γöé Γöé Γöé
Γöé Γöé ΓöéThe default value is LINES, Γöé
Γöé Γöé ΓöéNORMAL. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöéview styles ΓöéFLOWED ΓöéFlowed list items. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéNONFLOWED ΓöéNon-flowed list items. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéNONGRID ΓöéNon-gridded icon view. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéNORMAL ΓöéNormal size icons. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéMINI ΓöéSmall icons. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéINVISIBLE ΓöéNo icons. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéLINES ΓöéLines in tree view. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéNOLINES ΓöéNo lines in tree view. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéWORKAREA ΓöéYES ΓöéThis sets the folder so it is Γöé
Γöé Γöé Γöéa workarea. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéNO ΓöéThis sets the folder so it is Γöé
Γöé Γöé Γöénot a workarea. This is the Γöé
Γöé Γöé Γöédefault value. Γöé
ΓööΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö┤ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö┤ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÿ
WPFileSystem instance methods
The following list shows all the methods overridden by the WPFolder class.
These methods are overridden in order to modify the behavior defined by an
ancestor class.
o wpRefresh
Class methods
The following list shows all the WPFolder class methods:
o wpclsQueryIconDataN
o wpclsQueryIconN
o wpclsQueryOpenFolders
WPObject class methods.
The following list shows all the class methods overridden by the WPFolder
class. These methods are overridden to modify the behavior defined by an
ancestor class.
o wpclsInitData
o wpclsQueryDefaultHelp
o wpclsQueryDefaultView
o wpclsQueryIconData
o wpclsQueryStyle
o wpclsQueryTitle
ΓòÉΓòÉΓòÉ 3.14. WPFontPalette ΓòÉΓòÉΓòÉ
Class definition file: wpfntpal.idl
Class hierarchy
SOMObject
WPObject
WPAbstract
WPPalette
WPFontPalette
Description
This is the font palette object class. An instance of this class can be created
as a Workplace object. An instance of this class is created initially by the
system. It has the title "Font Palette" and resides in the "System Setup"
folder.
Instance methods
The following list shows all the WPFontPalette instance methods.
o wpGetFattrsFromPsz
WPObject instance methods
The following list shows all the methods overridden by the WPFontPalette
class. These methods are overridden in order to modify the behavior defined by
an ancestor class.
o wpMenuItemHelpSelected
o wpSetup
wpSetup override by WPFontPalette
The following table shows the keyname-value pairs supported by the
WPFontPalette class.
ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ
ΓöéKEYNAME ΓöéVALUE ΓöéDESCRIPTION Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéFONTS Γöéfonttype ΓöéThese are the initial fonts for each Γöé
Γöé Γöé Γöécell in the font palette. The values Γöé
Γöé Γöé Γöéfor each cell are separated by commas. Γöé
Γöé Γöé ΓöéThis is equivalent to calling the Γöé
Γöé Γöé ΓöéwpSetupCell method. The fonttype value Γöé
Γöé Γöé Γöéis presented as the point size followed Γöé
Γöé Γöé Γöéby a period which is then followed by Γöé
Γöé Γöé Γöéthe face name. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéXCELLCOUNTΓöécolumns ΓöéNumber of X cells as decimal digits. IfΓöé
Γöé Γöé Γöénot specified, defaults to 2. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéYCELLCOUNTΓöérows ΓöéNumber of Y cells as decimal digits. IfΓöé
Γöé Γöé Γöénot specified, defaults to 4. Γöé
ΓööΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö┤ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö┤ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÿ
Example
pszSetupString="FONTS=10.Helvetica,8.Helvetica,10.Courier,
12.Courier,24.Courier,10.System"
WPPalette instance methods
The following list shows all the methods overridden by the WPFontPalette
class. These methods are overridden in order to modify the behavior defined by
an ancestor class.
o wpDragCell
o wpEditCell
o wpPaintCell
o wpQueryPaletteHelp
o wpSetupCell
Class methods
There are currently no class methods defined for the WPFontPalette Workplace
object class.
WPObject class methods.
The following list shows all the class methods overridden by the WPFontPalette
class. These methods are overridden to modify the behavior defined by an
ancestor class.
o wpclsQueryDefaultHelp
o wpclsQueryIconData
o wpclsQueryStyle
o wpclsQueryTitle
WPPalette class methods.
The following list shows all the class methods overridden by the WPFontPalette
class. These methods are overridden to modify the behavior defined by an
ancestor class.
o wpclsQueryEditString
ΓòÉΓòÉΓòÉ 3.15. WPIcon ΓòÉΓòÉΓòÉ
Class definition file: wpicon.idl
Class hierarchy
SOMObject
WPObject
WPFileSystem
WPDataFile
WPIcon
Description
This is the WPIcon object class. All icons are of this class. These icon files
are templatable. An instance of this class can be created as a Workplace
object. Instances of this class are created initially by the system for each
icon in the system.
Instance methods
There are currently no methods defined for the WPIcon Workplace class object.
WPObject instance methods
The following list shows all the methods overridden by the WPIcon class. These
methods are overridden in order to modify the behavior defined by an ancestor
class.
o wpSetupOnce
Class methods
There are currently no class methods defined for the WPIcon Workplace class
object.
WPObject class methods.
The following list shows all the class methods overridden by the WPIcon class.
These methods are overridden to modify the behavior defined by an ancestor
class.
o wpclsInitData
o wpclsQueryDefaultHelp
o wpclsQueryTitle
WPFileSystem class methods.
The following list shows all the class methods overridden by the WPIcon class.
These methods are overridden to modify the behavior defined by an ancestor
class.
o wpclsQueryInstanceFilter
o wpclsQueryInstanceType
ΓòÉΓòÉΓòÉ 3.16. WPJob ΓòÉΓòÉΓòÉ
Class definition file: wpjob.idl Class hierarchy
SOMObject
WPObject
WPTransient
WPJob
Description
This is the job object class. An instance of this class is created by the
printer object in its icon or detail view.
Instance methods
The following list shows all the WPJob methods:
o wpDeleteJob
o wpHoldJob
o wpPrintJobNext
o wpQueryJobFile
o wpQueryJobId
o wpQueryJobType
o wpQueryPrintObject
o wpReleaseJob
o wpStartJobAgain
WPObject instance methods
The following list shows all the methods overridden by the WPJob class. These
methods are overridden in order to modify the behavior defined by an ancestor
class.
o wpAddObjectGeneralPage
o wpAddSettingsPages
o wpDragOver
o wpDrop
o wpFilterPopupMenu
o wpFree
o wpInitData
o wpMenuItemHelpSelected
o wpMenuItemSelected
o wpModifyPopupMenu
o wpOpen
o wpQueryDetailsData
o wpQueryIcon
o wpQueryTitle
o wpSetTitle
o wpUnInitData
Class methods
WPObject class methods.
There are currently no class methods defined for the WPJob Workplace class
object.
The following list shows all the class methods overridden by the WPJob class.
These methods are overridden to modify the behavior defined by an ancestor
class.
o wpclsQueryDefaultHelp
o wpclsQueryDefaultView
o wpclsQueryDetailsInfo
o wpclsQueryIcon
o wpclsQueryStyle
o wpclsQueryTitle
ΓòÉΓòÉΓòÉ 3.17. WPKeyboard ΓòÉΓòÉΓòÉ
Class definition file: wpkeybd.idl
Class hierarchy
SOMObject
WPObject
WPAbstract
WPKeyboard
Description
This is the keyboard object class. An instance of this class can be created as
a Workplace object. An instance of this class is created initially by the
system. It has the title "Keyboard" and resides in the "System Setup" folder.
Instance methods
The following list shows all the WPKeyboard methods:
o wpAddKeyboardMappingsPage
o wpAddKeyboardSpecialNeedsPage
o wpAddKeyboardTimingPage
WPObject instance methods
The following list shows all the methods overridden by the WPKeyboard class.
These methods are overridden in order to modify the behavior defined by an
ancestor class.
o wpAddObjectWindowPage
o wpAddSettingsPages
o wpFilterPopupMenu
Class methods
There are currently no class methods defined for the WPKeyboard Workplace
class object.
WPObject class methods.
The following list shows all the class methods overridden by the WPKeyboard
class. These methods are overridden to modify the behavior defined by an
ancestor class.
o wpclsQueryDefaultHelp
o wpclsQueryDefaultView
o wpclsQueryIconData
o wpclsQueryStyle
o wpclsQueryTitle
WPAbstract class methods.
The following list shows all the class methods overridden by the WPKeyboard
class. These methods are overridden to modify the behavior defined by an
ancestor class.
o wpclsQuerySetting
o wpclsSetSetting
wpclsSetSettings override by wpKeyboard
The defaults can be specified on a wpclsSetSetting invocation to request that
the setting be set to its default value. wpclsQuerySetting, however, never
returns an xxxx_DEFAULT value.
ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ
ΓöéSetting ΓöéValue ΓöéDescription Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéCursorBlinkRate Γöérate ΓöéSets the rate at which the Γöé
Γöé Γöé Γöécursor blinks. Γöé
Γöé Γöé ΓöéThis value must be in the Γöé
Γöé Γöé Γöérange CURSORBLINK_MIN to Γöé
Γöé Γöé ΓöéCURSORBLINK_MAX. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéCURSORBLINK_DEFAULT ΓöéSets the default rate at Γöé
Γöé Γöé Γöéwhich the cursor blinks. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéEditTitleTextKey ΓöéAF_VIRTUALKEY ΓöéHigh word. Sets the key usedΓöé
Γöé ΓöéAF_KBDCOMMAND Γöéwith another key to edit Γöé
Γöé Γöé Γöébutton text. Γöé
Γöé Γöé ΓöéBoth of these values are Γöé
Γöé Γöé Γöérequired if the default is Γöé
Γöé Γöé Γöénot set. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéAF_ALT ΓöéHigh word. Sets the key usedΓöé
Γöé ΓöéAF_SHIFT Γöéwith another key to edit Γöé
Γöé ΓöéAF_CONTROL Γöébutton text. Γöé
Γöé Γöé ΓöéThese are optional values. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéVK_F1 through VK_F12 ΓöéLow word. Sets the key used Γöé
Γöé ΓöéVK_PAGEUP Γöéto edit button text. Γöé
Γöé ΓöéVK_PAGEDOWN ΓöéOne of these values is Γöé
Γöé ΓöéVK_HOME Γöérequired if the default is Γöé
Γöé ΓöéVK_END Γöénot set. Γöé
Γöé ΓöéVK_INSERT Γöé Γöé
Γöé ΓöéVK_TAB Γöé Γöé
Γöé ΓöéVK_ENTER Γöé Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéTEXTEDITKEY_DEFAULT ΓöéSets the default text edit Γöé
Γöé Γöé Γöékey. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéKeyRepeatDelay Γöérate ΓöéSets the time before the keyΓöé
Γöé Γöé Γöéstarts repeating. This valueΓöé
Γöé Γöé Γöémust be in the range Γöé
Γöé Γöé ΓöéREPEATDELAY_MIN to Γöé
Γöé Γöé ΓöéREPEATDELAY_MAX. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéREPEATDELAY_DEFAULT ΓöéSets the default time beforeΓöé
Γöé Γöé Γöéthe key starts repeating. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéKeyRepeatRate Γöérate ΓöéSets the rate at which a keyΓöé
Γöé Γöé Γöérepeats. This value must be Γöé
Γöé Γöé Γöéin the range REPEATRATE_MIN Γöé
Γöé Γöé Γöéto REPEATRATE_MAX. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéREPEATRATE_DEFAULT ΓöéSets the default rate at Γöé
Γöé Γöé Γöéwhich a key repeats. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéPopupMenuKey ΓöéAF_VIRTUALKEY ΓöéHigh word. Sets the key usedΓöé
Γöé ΓöéAF_KBDCOMMAND Γöéwith another key to display Γöé
Γöé Γöé Γöéthe pop-up menu. Γöé
Γöé Γöé ΓöéBoth of these values are Γöé
Γöé Γöé Γöérequired if the default is Γöé
Γöé Γöé Γöénot set. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéAF_ALT ΓöéHigh word. Sets the key usedΓöé
Γöé ΓöéAF_SHIFT Γöéwith another key to display Γöé
Γöé ΓöéAF_CONTROL Γöéthe pop-up menu. Γöé
Γöé Γöé ΓöéThese are optional values. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéVK_F1 through VK_F12 ΓöéLow word. Sets the key used Γöé
Γöé ΓöéVK_PAGEUP Γöéto display the pop-up menu. Γöé
Γöé ΓöéVK_PAGEDOWN ΓöéOne of these values is Γöé
Γöé ΓöéVK_HOME Γöérequired if the default is Γöé
Γöé ΓöéVK_END Γöénot set. Γöé
Γöé ΓöéVK_INSERT Γöé Γöé
Γöé ΓöéVK_TAB Γöé Γöé
Γöé ΓöéVK_ENTER Γöé Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéPOPUPKEY_DEFAULT ΓöéSets the default popup menu Γöé
Γöé Γöé Γöékey. Γöé
ΓööΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö┤ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö┤ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÿ
ΓòÉΓòÉΓòÉ 3.18. WPLaunchPad ΓòÉΓòÉΓòÉ
Class definition file: wplnchpd.idl
Class hierarchy
SOMObject
WPObject
WPAbstract
WPLaunchPad
Description
This class is specific to version 3, or higher, of the OS/2 operating system.
This is the front panel object class.
The Launch Pad is a convenience for users that provides fast access to
frequently used objects and Desktop actions. Objects may be placed on the
Launch Pad or in drawers, which are represented by a small button above objects
on the Launch Pad. There is no limit to the number of Launch Pads that may
exist in the system. The system Launch Pad is defined as the one with an
OBJECTID of <WP_LAUNCHPAD>.
An instance of this class can be created as a Workplace object. An instance of
this class is created initially by the system. It has the title, "Launch Pad"
and resides in the "System Startup" folder.
Instance methods
The following list shows all the WPLaunchPad methods.
o wpAddLaunchPadPage1
o wpAddLaunchPadPage2
o wpQueryActionButtons
o wpQueryActionButtonStyle
o wpQueryCloseDrawer
o wpQueryDisplaySmallIcons
o wpQueryDisplayText
o wpQueryDisplayTextInDrawers
o wpQueryDisplayVertical
o wpQueryDrawerHWND
o wpQueryFloatOnTop
o wpQueryHideLaunchPadFrameCtls
o wpQueryObjectList
o wpRefreshDrawer
o wpSetActionButtonStyle
o wpSetCloseDrawer
o wpSetDisplaySmallIcons
o wpSetDisplayText
o wpSetDisplayTextInDrawers
o wpSetDisplayVertical
o wpSetDrawerHWND
o wpSetFloatOnTop
o wpSetHideLaunchPadFrameCtls
o wpSetObjectListFromHObjects
o wpSetObjectListFromObjects
o wpSetObjectListFromStrings
WPObject instance methods
The following list shows all the methods overridden by the WPLaunchPad class.
These methods are overridden in order to modify the behavior defined by an
ancestor class.
o wpAddObjectWindowPage
o wpAddSettingsPages
o wpInitData
o wpMenuItemHelpSelected
o wpMenuItemSelected
o wpModifyPopupMenu
o wpOpen
o wpQueryConcurrentView
o wpRestoreState
o wpSaveState
o wpSetup
o wpUnInitData
wpSetup override by WPLaunchPad
Following are keyname-value pairs added by the WPLaunchPad class. The
following table contains setup strings that can be used with WinCreateObject
and WinSetObjectData to customize Launch Pads:
ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ
ΓöéKEYNAME ΓöéVALUE ΓöéDESCRIPTION Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéFPOBJECTS Γöéobject IDs or ΓöéAdds objects to the end of theΓöé
Γöé Γöépath and file ΓöéLaunch Pad. If multiple Γöé
Γöé Γöénames Γöéobjects exist, the objects areΓöé
Γöé Γöé Γöéseparated by a comma. For Γöé
Γöé Γöé Γöéexample: Γöé
Γöé Γöé Γöé<WP_OS2WIN>,<WP_OS2EO> Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéDRAWEROBJECTS Γöédrawer number, ΓöéAdds the objects to the end ofΓöé
Γöé Γöéobject IDs or Γöéthe numbered Launch Pad Γöé
Γöé Γöépath and file Γöédrawer. The drawer number is Γöé
Γöé Γöénames Γöéfollowed by a comma-delimited Γöé
Γöé Γöé Γöéset of object IDs or path and Γöé
Γöé Γöé Γöéfile names. The drawer number Γöé
Γöé Γöé Γöéand first object must be Γöé
Γöé Γöé Γöéseparated by a comma. ExamplesΓöé
Γöé Γöé Γöéof drawer numbers : 0=Launch Γöé
Γöé Γöé ΓöéPad, 1=Left-most drawer, etc. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéLPCLOSEDRAWER ΓöéYES ΓöéThe Launch Pad drawers will Γöé
Γöé Γöé Γöéclose after an object in the Γöé
Γöé Γöé Γöédrawer is opened. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéNO ΓöéThe Launch Pad drawers will Γöé
Γöé Γöé Γöéstay open after an object in Γöé
Γöé Γöé Γöéthe drawer is opened. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéLPACTIONSTYLE ΓöéTEXT ΓöéDisplay the action buttons as Γöé
Γöé Γöé Γöétext (the default). Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéOFF ΓöéTurns off the display of Γöé
Γöé Γöé Γöéaction buttons. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéMINI ΓöéDisplays the action buttons asΓöé
Γöé Γöé Γöémini-icons. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéNORMAL ΓöéDisplays the action buttons asΓöé
Γöé Γöé Γöénormal (large) icons. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéLPVERTICAL ΓöéYES ΓöéThe Launch Pad will be Γöé
Γöé Γöé Γöédisplayed vertically. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéNO ΓöéThe Launch Pad will be Γöé
Γöé Γöé Γöédisplayed horizontally (the Γöé
Γöé Γöé Γöédefault). Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéLPTEXT ΓöéYES ΓöéThe object titles will appear Γöé
Γöé Γöé Γöéon the Launch Pad. This has Γöé
Γöé Γöé Γöéno effect on the objects in Γöé
Γöé Γöé Γöéthe drawers. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéNO ΓöéThe object titles will be Γöé
Γöé Γöé Γöéhidden. This has no effect onΓöé
Γöé Γöé Γöéthe objects in the drawers. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéLPDRAWERTEXT ΓöéYES ΓöéThe object titles will appear Γöé
Γöé Γöé Γöéon the objects in the drawers.Γöé
Γöé Γöé ΓöéThis has no effect on the Γöé
Γöé Γöé Γöéobjects on the Launch Pad. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéNO Γöé.The object titles will be Γöé
Γöé Γöé Γöéhidden. This has no effect onΓöé
Γöé Γöé Γöéthe objects on the Launch Pad.Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéLPSMALLICONS ΓöéYES ΓöéObjects are displayed using Γöé
Γöé Γöé Γöésmall icons. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéNO ΓöéObjects are displayed using Γöé
Γöé Γöé Γöélarge (normal) icons. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéLPHIDECTLS ΓöéYES ΓöéThe frame controls (title bar Γöé
Γöé Γöé Γöéand system menu) are hidden Γöé
Γöé Γöé Γöé(the default). Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéNO ΓöéThe frame controls are Γöé
Γöé Γöé Γöédisplayed. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéLPFLOAT ΓöéYES ΓöéThe Launch Pad will float on Γöé
Γöé Γöé Γöétop of all other windows. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéNO ΓöéThe Launch Pad will not float Γöé
Γöé Γöé Γöéon top of all other windows. Γöé
ΓööΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö┤ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö┤ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÿ
Class methods
There are currently no class methods defined for the WPLaunchPad Workplace
class object.
WPObject class methods.
The following list shows all the class methods overridden by the WPLaunchPad
class. These methods are overridden to modify the behavior defined by an
ancestor class.
o wpclsQueryDefaultHelp
o wpclsQueryDefaultView
o wpclsQueryIconData
o wpclsQueryStyle
o wpclsQueryTitle
ΓòÉΓòÉΓòÉ 3.19. WPMet ΓòÉΓòÉΓòÉ
Class definition file: wpmet.idl
Class hierarchy
SOMObject
WPObject
WPFileSystem
WPDataFile
WPMet
Description
This is the metafile class object. All MET files are of this class. These MET
files are templatable. An instance of this class can be created as a Workplace
object. Instances of this class are created initially by the system for each
MET file in the system.
Instance methods
There are currently no methods defined for the WPMet Workplace class object.
WPObject instance methods
The following list shows all the methods overridden by the WPMet class. These
methods are overridden in order to modify the behavior defined by an ancestor
class.
o wpSetupOnce
Class methods
There are currently no class methods defined for the WPMet Workplace class
object.
WPObject class methods.
The following list shows all the class methods overridden by the WPMet class.
These methods are overridden to modify the behavior defined by an ancestor
class.
o wpclsInitData
o wpclsQueryDefaultHelp
o wpclsQueryTitle
WPFileSystem class methods.
The following list shows all the class methods overridden by the WPMet class.
These methods are overridden to modify the behavior defined by an ancestor
class.
o wpclsQueryInstanceFilter
o wpclsQueryInstanceType
ΓòÉΓòÉΓòÉ 3.20. WPMinWinViewer ΓòÉΓòÉΓòÉ
Class definition file: wpmwv.idl
Class hierarchy
SOMObject
WPObject
WPFileSystem
WPFolder
WPMinWinViewer
Description This class is specific to version 3, or higher, of the OS/2
operating system.
This is the minimized window viewer object class. This is a special folder that
contains only minimized window objects. An instance of this class can be
created as a Workplace object. An instance of this class is created by the
system during initialization.
Instance methods
The following list shows all the WPMinWinViewer methods.
o wpFindMinWindow
WPFileSystem instance methods
The following list shows all the methods overridden by the WPMinWinViewer
class. These methods are overridden in order to modify the behavior defined by
an ancestor class.
o wpAddFileMenuPage
WPFolder instance methods
The following list shows all the methods overridden by the WPMinWinViewer
class. These methods are overridden in order to modify the behavior defined by
an ancestor class.
o wpAddFolderIncludePage
o wpAddFolderView2Page
o wpAddFolderView3Page
WPObject instance methods
The following list shows all the methods overridden by the WPMinWinViewer
class. These methods are overridden in order to modify the behavior defined by
an ancestor class.
o wpAddObjectWindowPage
o wpDragOver
o wpFilterPopupMenu
o wpMenuItemSelected
o wpModifyPopupMenu
o wpOpen
Class methods
There are currently no class methods defined for the WPMinWinViewer Workplace
class object.
WPObject class methods.
The following list shows all the class methods overridden by the
WPMinWinViewer class. These methods are overridden to modify the behavior
defined by an ancestor class.
o wpclsQueryDefaultHelp
o wpclsQueryDefaultView
o wpclsQueryIconData
o wpclsQueryStyle
o wpclsQueryTitle
ΓòÉΓòÉΓòÉ 3.21. WPMouse ΓòÉΓòÉΓòÉ
Class definition file: wpmouse.idl
Class hierarchy
SOMObject
WPObject
WPAbstract
WPMouse
Description
This is the mouse object class. An instance of this class can be created as a
Workplace object. An instance of this class is created initially by the system.
It has the title "Mouse" and resides in the "System Setup" folder.
Instance methods
The following list shows all the WPMouse methods:
o wpAddMouseCometPage
o wpAddMouseMappingsPage
o wpAddMousePtrPage
o wpAddMouseTimingPage
o wpAddMouseTypePage
WPObject instance methods
The following list shows all the methods overridden by the WPMouse class.
These methods are overridden in order to modify the behavior defined by an
ancestor class.
o wpAddObjectWindowPage
o wpAddSettingsPages
o wpFilterPopupMenu
Class methods
There are currently no class methods defined for the WPMouse Workplace class
object.
WPObject class methods.
The following list shows all the class methods overridden by the WPMouse
class. These methods are overridden to modify the behavior defined by an
ancestor class.
o wpclsQueryDefaultHelp
o wpclsQueryDefaultView
o wpclsQueryIconData
o wpclsQueryStyle
o wpclsQueryTitle
WPAbstract class methods.
The following list shows all the class methods overridden by the WPMouse
class. These methods are overridden to modify the behavior defined by an
ancestor class.
o wpclsQuerySetting
o wpclsSetSetting
wpclsSetSettings override by wpMouse
The defaults can be specified on a wpclsSetSetting invocation to request that
the setting be set to its default value. wpclsQuerySetting, however, never
returns an xxxx_DEFAULT value.
ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ
ΓöéSetting ΓöéValue ΓöéDescription Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéButtonSetup ΓöéBUTTONS_LEFTHANDED ΓöéSets the mouse Γöé
Γöé Γöé Γöébuttons for a Γöé
Γöé Γöé Γöéleft-handed Γöé
Γöé Γöé Γöéperson. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéBUTTONS_RIGHTHANDED ΓöéSets the mouse Γöé
Γöé Γöé Γöébuttons for a Γöé
Γöé Γöé Γöéright-handed Γöé
Γöé Γöé Γöéperson. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéBUTTONS_DEFAULT ΓöéSets the defaultΓöé
Γöé Γöé Γöésetup for the Γöé
Γöé Γöé Γöémouse buttons. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéDisplayWindowListButton ΓöéINP_NONE ΓöéHigh word. Γöé
Γöé Γöé ΓöéThis value is Γöé
Γöé Γöé Γöérequired if the Γöé
Γöé Γöé Γöédefault is not Γöé
Γöé Γöé Γöéset. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéWM_BUTTON2CLICK ΓöéLow word. Sets Γöé
Γöé ΓöéWM_CHORD Γöéthe button whichΓöé
Γöé Γöé Γöédisplays the Γöé
Γöé Γöé Γöéwindow list. Γöé
Γöé Γöé ΓöéOne of these Γöé
Γöé Γöé Γöévalues is Γöé
Γöé Γöé Γöérequired if the Γöé
Γöé Γöé Γöédefault is not Γöé
Γöé Γöé Γöéset. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéWINDOWLISTBUTTON_DEFAULT ΓöéSets the defaultΓöé
Γöé Γöé Γöébutton which Γöé
Γöé Γöé Γöédisplays the Γöé
Γöé Γöé Γöéwindow list. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéDoubleClickTime Γöétime ΓöéSets the time Γöé
Γöé Γöé Γöébetween mouse Γöé
Γöé Γöé Γöéclicks. Higher Γöé
Γöé Γöé Γöévalues allow Γöé
Γöé Γöé Γöémore time Γöé
Γöé Γöé Γöébetween mouse Γöé
Γöé Γöé Γöéclicks, where asΓöé
Γöé Γöé Γöélower values Γöé
Γöé Γöé Γöéallow less time Γöé
Γöé Γöé Γöébetween mouse Γöé
Γöé Γöé Γöéclicks. Γöé
Γöé Γöé ΓöéThis value must Γöé
Γöé Γöé Γöébe in the range Γöé
Γöé Γöé Γöé170 to 1 060. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéDOUBLECLICK_DEFAULT ΓöéSets the defaultΓöé
Γöé Γöé Γöétime between Γöé
Γöé Γöé Γöémouse clicks. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéDragObjectButton ΓöéINP_NONE ΓöéHigh word. Γöé
Γöé Γöé ΓöéThis value is Γöé
Γöé Γöé Γöérequired if the Γöé
Γöé Γöé Γöédefault is not Γöé
Γöé Γöé Γöéset. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéWM_BUTTON1MOTIONSTART ΓöéLow word. Sets Γöé
Γöé ΓöéWM_BUTTON2MOTIONSTART Γöéthe button whichΓöé
Γöé Γöé Γöédrags objects. Γöé
Γöé Γöé ΓöéOne of these Γöé
Γöé Γöé Γöévalues is Γöé
Γöé Γöé Γöérequired if the Γöé
Γöé Γöé Γöédefault is not Γöé
Γöé Γöé Γöéset. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéDRAGBUTTON_DEFAULT ΓöéSets the button Γöé
Γöé Γöé Γöéwhich drags Γöé
Γöé Γöé Γöéobjects to the Γöé
Γöé Γöé Γöédefault. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéEditTitleTextButton ΓöéINP_ALT ΓöéHigh word. Sets Γöé
Γöé ΓöéINP_CTRL Γöéthe key used Γöé
Γöé ΓöéINP_NONE Γöéwith a mouse Γöé
Γöé ΓöéINP_SHIFT Γöébutton to edit Γöé
Γöé Γöé Γöébutton text. Γöé
Γöé Γöé ΓöéOne of these Γöé
Γöé Γöé Γöévalues is Γöé
Γöé Γöé Γöérequired if the Γöé
Γöé Γöé Γöédefault is not Γöé
Γöé Γöé Γöéset. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéWM_BUTTON1CLICK ΓöéLow word. Sets Γöé
Γöé ΓöéWM_BUTTON2CLICK Γöéthe mouse buttonΓöé
Γöé ΓöéWM_BUTTON1DBLCLK Γöéused to edit Γöé
Γöé ΓöéWM_BUTTON2DBLCKL Γöébutton text. Γöé
Γöé Γöé ΓöéOne of these Γöé
Γöé Γöé Γöévalues is Γöé
Γöé Γöé Γöérequired if the Γöé
Γöé Γöé Γöédefault is not Γöé
Γöé Γöé Γöéset. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéTEXTEDITBUTTON_DEFAULT ΓöéSets the text Γöé
Γöé Γöé Γöéedit button to Γöé
Γöé Γöé Γöéthe default. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéPopupMenuButton ΓöéINP_ALT ΓöéHigh word. Sets Γöé
Γöé ΓöéINP_CTRL Γöéthe key used Γöé
Γöé ΓöéINP_NONE Γöéwith a mouse Γöé
Γöé ΓöéINP_SHIFT Γöébutton to Γöé
Γöé Γöé Γöédisplay pop-up Γöé
Γöé Γöé Γöémenus. Γöé
Γöé Γöé ΓöéOne of these Γöé
Γöé Γöé Γöévalues is Γöé
Γöé Γöé Γöérequired if the Γöé
Γöé Γöé Γöédefault is not Γöé
Γöé Γöé Γöéset. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéWM_BUTTON1CLICK ΓöéLow word. Sets Γöé
Γöé ΓöéWM_BUTTON2CLICK Γöéthe mouse buttonΓöé
Γöé ΓöéWM_BUTTON1DBLCLK Γöéused to display Γöé
Γöé ΓöéWM_BUTTON2DBLCKL Γöépop-up menus. Γöé
Γöé ΓöéWM_CHORD ΓöéOne of these Γöé
Γöé Γöé Γöévalues is Γöé
Γöé Γöé Γöérequired if the Γöé
Γöé Γöé Γöédefault is not Γöé
Γöé Γöé Γöéset. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéPOPUPBUTTON_DEFAULT ΓöéSets the defaultΓöé
Γöé Γöé Γöékey and mouse Γöé
Γöé Γöé Γöébutton used to Γöé
Γöé Γöé Γöédisplay pop-up Γöé
Γöé Γöé Γöémenus. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéTrackingSpeed Γöéspeed ΓöéSets the mouse Γöé
Γöé Γöé Γöétracking speed. Γöé
Γöé Γöé ΓöéThis value must Γöé
Γöé Γöé Γöébe in the range Γöé
Γöé Γöé Γöé1 to 7, where 1 Γöé
Γöé Γöé Γöéis the fastest Γöé
Γöé Γöé Γöévalue. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéTRACKING_DEFAULT ΓöéSets the defaultΓöé
Γöé Γöé Γöémouse tracking Γöé
Γöé Γöé Γöéspeed. Γöé
ΓööΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö┤ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö┤ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÿ
ΓòÉΓòÉΓòÉ 3.22. WPNetgrp ΓòÉΓòÉΓòÉ
Class definition file: wpnetgrp.idl
Class hierarchy
SOMObject
WPObject
WPFileSystem
WPFolder
WPNetgrp
Description This class is specific to version 3, or higher, of the OS/2
operating system.
This is the network group object class. An instances of this class can be
created as a Workplace object. Instances of this class are created for every
LAN system in a WPNetwork, for example LAN server and Novell**).
Instance methods
The following list shows all the WPNetgrp methods.
o wpAddNetworkPage
o wpQueryNetIdentity
o wpSetNetIdentity
WPFileSystem instance methods
The following list shows all the methods overridden by the WPNetgrp class.
These methods are overridden in order to modify the behavior defined by an
ancestor class.
o wpAddFile1Page
o wpAddFile2Page
o wpAddFile3Page
WPFolder instance methods
The following list shows all the methods overridden by the WPNetgrp class.
These methods are overridden in order to modify the behavior defined by an
ancestor class.
o wpAddFolderIncludePage
o wpDeleteContents
o wpPopulate
WPObject instance methods
The following list shows all the methods overridden by the WPNetgrp class.
These methods are overridden in order to modify the behavior defined by an
ancestor class.
o wpAddObjectGeneralPage
o wpAddSettingsPages
o wpFilterPopupMenu
o wpInitData
o wpMenuItemHelpSelected
o wpMenuItemSelected
o wpModifyPopupMenu
o wpOpen
o wpRestoreState
o wpSaveState
o wpSetup
o wpUnInitData
Class methods
There are currently no class methods defined for the WPNetgrp Workplace class
object.
WPObject class methods.
The following list shows all the class methods overridden by the WPNetgrp
class. These methods are overridden to modify the behavior defined by an
ancestor class.
o wpclsQueryDefaultHelp
o wpclsQueryDefaultView
o wpclsQueryIconData
o wpclsQueryStyle
o wpclsQueryTitle
ΓòÉΓòÉΓòÉ 3.23. WPNetLink ΓòÉΓòÉΓòÉ
Class definition file: wpnetlnk.idl
Class hierarchy
SOMObject
WPObject
WPAbstract
WPShadow
WPNetLink
Description This class is specific to version 3, or higher, of the OS/2
operating system.
This is the network link object class. This object handles all saving and
restoring of data for the shared directory object by providing a persistent
link or reference to that shared directory. The purpose of this link is to
locally store all the instance data of the shared directory that this object is
linked to and then reroute all requests for help, context menus, open views,
and so forth, to this object. An instance of this class can be created as a
Workplace object.
Instance methods
The following list shows all the WPNetLink methods.
o wpQueryObjectNetId
o wpSetObjectNetId
WPObject instance methods
The following list shows all the methods overridden by the WPNetLink class.
These methods are overridden in order to modify the behavior defined by an
ancestor class.
o wpCreateShadowObject
o wpFilterPopupMenu
o wpInitData
o wpMenuItemHelpSelected
o wpModifyPopupMenu
o wpQueryStyle
o wpRestoreState
o wpSaveState
o wpUnInitData
Class methods
There are currently no class methods defined for the WPNetLink Workplace class
object.
WPObject class methods.
The following list shows all the class methods overridden by the WPNetLink
class. These methods are overridden to modify the behavior defined by an
ancestor class.
o wpclsQueryStyle
o wpclsQueryTitle
ΓòÉΓòÉΓòÉ 3.24. WPNetwork ΓòÉΓòÉΓòÉ
Class definition file: wpnetwrk.idl
Class hierarchy
SOMObject
WPObject
WPFileSystem
WPFolder
WPNetwork
Description This class is specific to version 3, or higher, of the OS/2
operating system.
This is the network object class. An instances of this class can be created as
a Workplace object. This object is the "network" folder that is created by the
system on the Desktop. It is visible only if the LAN is attached to the machine
being used.
Instance methods
There are currently no methods defined for the WPNetwork Workplace object
class.
WPFileSystem instance methods
The following list shows all the methods overridden by the WPNetwork class.
These methods are overridden in order to modify the behavior defined by an
ancestor class.
o wpAddFile1Page
o wpAddFile2Page
o wpAddFile3Page
WPFolder instance methods
The following list shows all the methods overridden by the WPNetwork class.
These methods are overridden in order to modify the behavior defined by an
ancestor class.
o wpAddFolderIncludePage
o wpPopulate
WPObject instance methods
The following list shows all the methods overridden by the WPNetwork class.
These methods are overridden in order to modify the behavior defined by an
ancestor class.
o wpFilterPopupMenu
o wpInitData
o wpMenuItemHelpSelected
o wpMenuItemSelected
o wpModifyPopupMenu
o wpOpen
o wpRestoreState
o wpSetup
Class methods
There are currently no class methods defined for the WPNetwork Workplace class
object.
WPObject class methods.
The following list shows all the class methods overridden by the WPNetwork
class. These methods are overridden to modify the behavior defined by an
ancestor class.
o wpclsQueryDefaultHelp
o wpclsQueryDefaultView
o wpclsQueryIconData
o wpclsQueryStyle
o wpclsQueryTitle
ΓòÉΓòÉΓòÉ 3.25. WPObject ΓòÉΓòÉΓòÉ
Class definition file: wpobject.idl
Class hierarchy
SOMObject
WPObject
Description
This is the root Workplace object class. This is the fundamental class from
which all Workplace objects are derived, regardless of where they are actually
stored. Immediate descendant classes of WPObject are called storage classes,
since they take responsibility for storing the object information, typically in
a persistent form. Predefined Workplace object storage classes are the
following:
o WPAbstract
o WPFileSystem
o WPTransient
A Workplace object of this class cannot be created.
MenuID list
The following list shows the WPMENUIDs:
WPMENUID_ACCESSNEW
WPMENUID_ARRANGE
WPMENUID_ASSIGN
WPMENUID_CLOSE
WPMENUID_CHKDSK
WPMENUID_CREATEANOTHER
WPMENUID_COPY
WPMENUID_COPYDSK
WPMENUID_CREATESHADOW
WPMENUID_DELETE
WPMENUID_DESELALL
WPMENUID_DETAILS
WPMENUID_EJECTDISK
WPMENUID_EXTENDEDHELP
WPMENUID_FIND
WPMENUID_FIXDSK
WPMENUID_FORMAT
WPMENUID_HELP
WPMENUID_HELPINDEX
WPMENUID_HELPKEYS
WPMENUID_HELP_FOR_HELP
WPMENUID_HOWTOGETHELP
WPMENUID_ICON
WPMENUID_LOCKDISK
WPMENUID_LOCKUP
WPMENUID_LOGIN
WPMENUID_LOGOUT
WPMENUID_MOVE
WPMENUID_OPEN
WPMENUID_PALETTE
WPMENUID_PICKUP
WPMENUID_PRIMARY
WPMENUID_PRINT
WPMENUID_PROGRAM
WPMENUID_PROPERTIES
WPMENUID_PUTDOWN
WPMENUID_PUTDOWN_CANCEL
WPMENUID_PUTDOWN_COPY
WPMENUID_PUTDOWN_CREATE
WPMENUID_PUTDOWN_LINK
WPMENUID_PUTDOWN_MOVE
WPMENUID_REFRESH
WPMENUID_RESERVED1
WPMENUID_RESERVED2
WPMENUID_SELALL
WPMENUID_SELECT
WPMENUID_SHUTDOWN
WPMENUID_SORT
WPMENUID_SYSTEMSETUP
WPMENUID_TREE
WPMENUID_UNASSIGN
WPMENUID_UNLOCKDISK
WPMENUID_USER
wpSetup override by WPObject
The following table shows the keyname-value pairs added by the WPObject class.
ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ
ΓöéKEYNAME ΓöéVALUE ΓöéDESCRIPTION Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéCCVIEW ΓöéDEFAULT ΓöéThe default value of the Γöé
Γöé Γöé Γöéconcurrent view setting of Γöé
Γöé Γöé Γöéthe system is used when theΓöé
Γöé Γöé Γöéuser selects open. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéYES ΓöéThis sets the object's Γöé
Γöé Γöé Γöémultiple concurrent view Γöé
Γöé Γöé Γöébehavior, so that new viewsΓöé
Γöé Γöé Γöéof this object are created Γöé
Γöé Γöé Γöéevery time the user selectsΓöé
Γöé Γöé Γöéopen. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéNO ΓöéOpened view of this object Γöé
Γöé Γöé Γöéresurfaces when the user Γöé
Γöé Γöé Γöéselects open. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéDEFAULTVIEW ΓöéSETTINGS ΓöéThis sets the default open Γöé
Γöé Γöé Γöéview to Settings view. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé Γöéid ΓöéThis sets the default open Γöé
Γöé Γöé Γöéview to the id of a Γöé
Γöé Γöé Γöéuser-added view (0-9). Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéDEFAULT ΓöéThis sets the default open Γöé
Γöé Γöé Γöéview to the object's class Γöé
Γöé Γöé Γöédefault view, as returned Γöé
Γöé Γöé Γöéby wpclsQueryDefaultView. Γöé
Γöé Γöé ΓöéThis is the default value. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéHELPLIBRARY Γöéfilename ΓöéThis sets the help library.Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéHELPPANEL Γöéid ΓöéThis sets the object's Γöé
Γöé Γöé Γöédefault help panel for Γöé
Γöé Γöé Γöéobject-specific help. This Γöé
Γöé Γöé Γöéis equivalent to calling Γöé
Γöé Γöé ΓöéwpSetDefaultHelp. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéHIDEBUTTON ΓöéYES ΓöéViews of this object have aΓöé
Γöé Γöé Γöéhide button as opposed to aΓöé
Γöé Γöé Γöéminimize button. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéNO ΓöéViews of this object have aΓöé
Γöé Γöé Γöéminimize button as opposed Γöé
Γöé Γöé Γöéto a hide button. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé Γöé ΓöéThe default is the current Γöé
Γöé Γöé Γöésystem Button appearance Γöé
Γöé Γöé Γöéfor windows setting. This Γöé
Γöé Γöé Γöécannot be specified here. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéICONFILE Γöéfilename ΓöéThis sets the object's Γöé
Γöé Γöé Γöéicon. This is equivalent toΓöé
Γöé Γöé Γöécalling wpSetIconData. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéICONPOS Γöéx,y ΓöéThis sets the object's Γöé
Γöé Γöé Γöéinitial icon position in a Γöé
Γöé Γöé Γöéfolder. The x and y values Γöé
Γöé Γöé Γöérepresent the position in Γöé
Γöé Γöé Γöéthe object's folder in Γöé
Γöé Γöé Γöépercentage coordinates. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéICONRESOURCE Γöéid,module ΓöéThis sets the object's Γöé
Γöé Γöé Γöéicon. This is equivalent toΓöé
Γöé Γöé Γöécalling wpSetIconData. The Γöé
Γöé Γöé Γöé"id" is the icon resource Γöé
Γöé Γöé ΓöéID in the dynamic link Γöé
Γöé Γöé Γöélibrary (DLL) "module". Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéMINWIN ΓöéHIDE ΓöéViews of this object hide Γöé
Γöé Γöé Γöéwhen their minimize button Γöé
Γöé Γöé Γöéis selected. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéVIEWER ΓöéViews of this object Γöé
Γöé Γöé Γöéminimize to the minimized Γöé
Γöé Γöé Γöéwindow viewer when their Γöé
Γöé Γöé Γöéminimize button is Γöé
Γöé Γöé Γöéselected. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéDESKTOP ΓöéViews of this object Γöé
Γöé Γöé Γöéminimize to the desktop Γöé
Γöé Γöé Γöéwhen their minimize button Γöé
Γöé Γöé Γöéis selected. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé Γöé ΓöéThe default is the current Γöé
Γöé Γöé ΓöéMinimize button setting. Γöé
Γöé Γöé ΓöéThis cannot be specified Γöé
Γöé Γöé Γöéhere. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéNOCOPY ΓöéYES ΓöéThis sets the object's no Γöé
Γöé Γöé Γöécopy property, so that the Γöé
Γöé Γöé Γöéobject cannot be copied. Γöé
Γöé Γöé ΓöéThis is equivalent to Γöé
Γöé Γöé Γöécalling wpSetStyle with a Γöé
Γöé Γöé Γöéstyle of OBJSTYLE_NOCOPY. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéNO ΓöéThis resets the object's noΓöé
Γöé Γöé Γöécopy property, so that the Γöé
Γöé Γöé Γöéobject can be copied. Γöé
Γöé Γöé ΓöéThis is the default value. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéNODELETE ΓöéYES ΓöéThis sets the object's no Γöé
Γöé Γöé Γöédelete property, so that Γöé
Γöé Γöé Γöéthe object cannot be Γöé
Γöé Γöé Γöédeleted. This is equivalentΓöé
Γöé Γöé Γöéto calling wpSetStyle with Γöé
Γöé Γöé Γöéa style of Γöé
Γöé Γöé ΓöéOBJSTYLE_NODELETE. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéNO ΓöéThis resets the object's noΓöé
Γöé Γöé Γöédelete property, so that Γöé
Γöé Γöé Γöéthe object can be deleted. Γöé
Γöé Γöé ΓöéThis is the default value. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéNODRAG ΓöéYES ΓöéThis sets the object's no Γöé
Γöé Γöé Γöédrag property, so that the Γöé
Γöé Γöé Γöéobject cannot be dragged. Γöé
Γöé Γöé ΓöéThis is equivalent to Γöé
Γöé Γöé Γöécalling wpSetStyle with a Γöé
Γöé Γöé Γöéstyle of OBJSTYLE_NODRAG. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéNO ΓöéThis resets the object's noΓöé
Γöé Γöé Γöédrag property, so that the Γöé
Γöé Γöé Γöéobject can be dragged. Γöé
Γöé Γöé ΓöéThis is the default value. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéNODROP ΓöéYES ΓöéThis sets the object's no Γöé
Γöé Γöé Γöédrop property, so that no Γöé
Γöé Γöé Γöéother object can be droppedΓöé
Γöé Γöé Γöéon it. This is equivalent Γöé
Γöé Γöé Γöéto calling wpSetStyle with Γöé
Γöé Γöé Γöéa style of Γöé
Γöé Γöé ΓöéOBJSTYLE_NODROPON. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéNO ΓöéThis resets the object's noΓöé
Γöé Γöé Γöédrop property, so that Γöé
Γöé Γöé Γöéanother object can be Γöé
Γöé Γöé Γöédropped on it. Γöé
Γöé Γöé ΓöéThis is the default value. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéNOLINK ΓöéYES ΓöéThis sets the object's no Γöé
Γöé Γöé Γöélink property, so that the Γöé
Γöé Γöé Γöéobject cannot be linked. Γöé
Γöé Γöé ΓöéThis is equivalent to Γöé
Γöé Γöé Γöécalling wpSetStyle with a Γöé
Γöé Γöé Γöéstyle of OBJSTYLE_NOLINK. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéNO ΓöéThis resets the object's noΓöé
Γöé Γöé Γöélink property, so that the Γöé
Γöé Γöé Γöéobject can be linked. Γöé
Γöé Γöé ΓöéThis is the default value. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéNOMOVE ΓöéYES ΓöéThis sets the object's no Γöé
Γöé Γöé Γöémove property, so that the Γöé
Γöé Γöé Γöéobject cannot be moved. Γöé
Γöé Γöé ΓöéThis is equivalent to Γöé
Γöé Γöé Γöécalling wpSetStyle with a Γöé
Γöé Γöé Γöéstyle of OBJSTYLE_NOMOVE. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéNO ΓöéThis resets the object's noΓöé
Γöé Γöé Γöémove property, so that the Γöé
Γöé Γöé Γöéobject can be moved. Γöé
Γöé Γöé ΓöéThis is the default value. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéNOPRINT ΓöéYES ΓöéThis sets the object's no Γöé
Γöé Γöé Γöéprint property, so that theΓöé
Γöé Γöé Γöéobject cannot be printed. Γöé
Γöé Γöé ΓöéThis is equivalent to Γöé
Γöé Γöé Γöécalling wpSetStyle with a Γöé
Γöé Γöé Γöéstyle of OBJSTYLE_NOPRINT. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéNO ΓöéThis resets the object's noΓöé
Γöé Γöé Γöéprint property, so that theΓöé
Γöé Γöé Γöéobject can be printed. Γöé
Γöé Γöé ΓöéThis is the default value. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéNORENAME ΓöéYES ΓöéThis sets the object's no Γöé
Γöé Γöé Γöérename property, so that Γöé
Γöé Γöé Γöéthe object cannot be Γöé
Γöé Γöé Γöérenamed. This is equivalentΓöé
Γöé Γöé Γöéto calling wpSetStyle with Γöé
Γöé Γöé Γöéa style of Γöé
Γöé Γöé ΓöéOBJSTYLE_NORENAME. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéNO ΓöéThis resets the object's noΓöé
Γöé Γöé Γöérename property, so that Γöé
Γöé Γöé Γöéthe object can be renamed. Γöé
Γöé Γöé ΓöéThis is the default value. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéNOSETTINGS ΓöéYES ΓöéThis sets the object's no Γöé
Γöé Γöé Γöésettings property, so that Γöé
Γöé Γöé Γöéthe object' settings cannotΓöé
Γöé Γöé Γöébe opened. This is Γöé
Γöé Γöé Γöéequivalent to calling Γöé
Γöé Γöé ΓöéwpSetStyle with a style of Γöé
Γöé Γöé ΓöéOBJSTYLE_NOSETTINGS. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéNO ΓöéThis resets the object's noΓöé
Γöé Γöé Γöésettings property, so that Γöé
Γöé Γöé Γöéthe object's settings can Γöé
Γöé Γöé Γöébe opened. Γöé
Γöé Γöé ΓöéThis is the default value. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéNOSHADOW ΓöéYES ΓöéThis sets the object's no Γöé
Γöé Γöé Γöélink property, so that the Γöé
Γöé Γöé Γöéobject cannot be linked. Γöé
Γöé Γöé ΓöéThis is equivalent to Γöé
Γöé Γöé Γöécalling wpSetStyle with a Γöé
Γöé Γöé Γöéstyle of OBJSTYLE_NOLINK. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéNO ΓöéThis resets the object's noΓöé
Γöé Γöé Γöélink property, so that the Γöé
Γöé Γöé Γöéobject can be linked. Γöé
Γöé Γöé ΓöéThis is the default value. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéNOTVISIBLE ΓöéYES ΓöéThis sets the object's not Γöé
Γöé Γöé Γöévisible property, so that Γöé
Γöé Γöé Γöéthe object cannot be made Γöé
Γöé Γöé Γöévisible. This is equivalentΓöé
Γöé Γöé Γöéto calling wpSetStyle with Γöé
Γöé Γöé Γöéa style of Γöé
Γöé Γöé ΓöéOBJSTYLE_NOTVISIBLE. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéNO ΓöéThis resets the object's Γöé
Γöé Γöé Γöénot visible property, so Γöé
Γöé Γöé Γöéthat the object can be madeΓöé
Γöé Γöé Γöévisible. Γöé
Γöé Γöé ΓöéThis is the default value. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéOBJECTID Γöé<name> ΓöéThis sets a persistent ID Γöé
Γöé Γöé Γöéfor the object. The Γöé
Γöé Γöé ΓöéOBJECTID stays with the Γöé
Γöé Γöé Γöéobject even if it is moved Γöé
Γöé Γöé Γöéor renamed. The object Γöé
Γöé Γöé Γöépointer or handle can be Γöé
Γöé Γöé Γöéretrieved via Γöé
Γöé Γöé ΓöéwpclsQueryObject or Γöé
Γöé Γöé ΓöéWinQueryObject , Γöé
Γöé Γöé Γöérespectively. An OBJECTID Γöé
Γöé Γöé Γöéis any unique string Γöé
Γöé Γöé Γöépreceded with a "<" and Γöé
Γöé Γöé Γöéterminated with a ">". Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéOPEN ΓöéSETTINGS ΓöéThis opens the Settings Γöé
Γöé Γöé Γöéview when an object is Γöé
Γöé Γöé Γöécreated or when Γöé
Γöé Γöé ΓöéWinSetObjectData is called.Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéDEFAULT ΓöéThis opens the default viewΓöé
Γöé Γöé Γöéwhen an object is created Γöé
Γöé Γöé Γöéor when WinSetObjectData isΓöé
Γöé Γöé Γöécalled. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé Γöé ΓöéThe default is to not open Γöé
Γöé Γöé Γöéa view. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéTEMPLATE ΓöéYES ΓöéThis sets the object's Γöé
Γöé Γöé Γöétemplate property. This is Γöé
Γöé Γöé Γöéequivalent to calling Γöé
Γöé Γöé ΓöéwpSetStyle with a style of Γöé
Γöé Γöé ΓöéOBJSTYLE_TEMPLATE. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéNO ΓöéThis resets the object's Γöé
Γöé Γöé Γöétemplate property. Γöé
Γöé Γöé ΓöéThis is the default value. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéTITLE ΓöéTitle ΓöéThis sets the object's Γöé
Γöé Γöé Γöétitle. This is equivalent Γöé
Γöé Γöé Γöéto calling wpSetTitle. Γöé
ΓööΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö┤ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö┤ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÿ
Example
pszSetupString="TITLE=MYObject;ICONFILE=myobj.ico;HELPPANEL=132;
TEMPLATE=YES;NODELETE=NO"
Instance methods
The following lists show how all the WPObject instance methods are related
within functional areas:
Settings notebook methods
o wpAddObjectGeneralPage
o wpAddObjectGeneralPage2
o wpAddObjectWindowPage
o wpAddSettingsPages
o wpInsertSettingsPage
Save/restore state methods
o wpRestoreData
o wpRestoreLong
o wpRestoreState
o wpRestoreString
o wpSaveData
o wpSaveDeferred
o wpSaveImmediate
o wpSaveLong
o wpSaveState
o wpSaveString
Object usage methods
o wpAddToObjUseList
o wpCnrDeleteUseItem
o wpDeleteFromObjUseList
o wpFindUseItem
o wpIsLocked
o wpLockObject
o wpUnlockObject
Popup menu methods
o wpClose
o wpCopyObject
o wpCreateAnother
o wpCreateFromTemplate
o wpCreateShadowObject
o wpCreateShadowObjectExt
o wpDelete
o wpDisplayHelp
o wpDisplayMenu
o wpFilterPopupMenu
o wpHide
o wpInsertPopupMenuItems
o wpIsObjectInitialized
o wpMenuItemHelpSelected
o wpMenuItemSelected
o wpModifyPopupMenu
o wpMoveObject
o wpObjectReady
o wpOpen
o wpPrintObject
o wpRestore
Query and Set object information methods
o wpModifyStyle
o wpQueryButtonAppearance
o wpQueryConcurrentView
o wpQueryConfirmations
o wpQueryContainerFlagPtr
o wpQueryCoreRecord
o wpQueryDefaultHelp
o wpQueryDefaultIconPos
o wpQueryDefaultView
o wpQueryDetailsData
o wpQueryFolder
o wpQueryHandle
o wpQueryIcon
o wpQueryIconData
o wpQueryMinWindow
o wpQueryNameClashOptions
o wpQueryObjectID
o wpQueryScreenGroupID
o wpQueryStyle
o wpQueryTitle
o wpSetButtonAppearance
o wpSetConcurrentView
o wpSetDefaultHelp
o wpSetDefaultIconPos
o wpSetDefaultView
o wpSetIcon
o wpSetIconData
o wpSetIconHandle
o wpSetMinWindow
o wpSetObjectID
o wpSetStyle
o wpSetTitle
o wpViewObject
Error handling methods
o wpQueryError
o wpSetError
Memory management methods
o wpAllocMem
o wpFreeMem
Setup/cleanup methods
o wpFree
o wpInitData
o wpScanSetupString
o wpSetup
o wpSetupOnce
o wpUnInitData
Direct manipulation methods
o wpDraggedOverObject
o wpDragOver
o wpDrop
o wpDroppedOnObject
o wpEndConversation
o wpFormatDragItem
o wpRender
o wpRenderComplete
Miscellaneous methods
o wpCnrInsertObject
o wpCnrRefreshDetails
o wpCnrRemoveObject
o wpCnrSetEmphasis
o wpConfirmDelete
o wpConfirmObjectTitle
o wpCopiedFromTemplate
o wpDoesObjectMatch
o wpFindViewItem
o wpIsDeleteable
o wpRegisterView
o wpSwitchTo
o wpWaitForClose
SOMObject methods
The following list shows all the instance methods overridden by the WPObject
class. These instance methods are overridden in order to modify the behavior
defined by an ancestor class.
o somDefaultInit
o somInit
o somUninit
Class Methods
The following list shows all the WPObject class methods:
o wpclsCreateDefaultTemplates
o wpclsDecUsage
o wpclsFindObjectEnd
o wpclsFindObjectFirst
o wpclsFindObjectNext
o wpclsFindOneObject
o wpclsIncUsage
o wpclsInitData
o wpclsInsertMultipleObjects
o wpclsMakeAwake
o wpclsNew
o wpclsObjectFromHandle
o wpclsQueryButtonAppearance
o wpclsQueryDefaultHelp
o wpclsQueryDefaultView
o wpclsQueryDetails
o wpclsQueryDetailsInfo
o wpclsQueryError
o wpclsQueryExtendedCriteria
o wpclsQueryFolder
o wpclsQueryIcon
o wpclsQueryIconData
o wpclsQueryObject
o wpclsQuerySearchInfo
o wpclsQuerySettingsPageSize
o wpclsQueryStyle
o wpclsQueryTitle
o wpclsRemoveObjects
o wpclsSetError
o wpclsSetIconData
o wpclsSetIcon
o wpclsSetSettingsPageSize
o wpclsUnInitData
SOMClass methods
The following list shows all the class methods overridden by the the WPObject
class. These methods are overridden to modify the behavior defined by an
ancestor class.
o somClassReady
o somNew
o somRenew
ΓòÉΓòÉΓòÉ 3.26. WPPalette ΓòÉΓòÉΓòÉ
Class definition file: wppalet.idl
Class hierarchy
SOMObject
WPObject
WPAbstract
WPPalette
Description
This is the palette object class. There are no instances of this class
initially created by the system.
Instance methods
The following list shows all the WPPalette instance methods:
o wpDragCell
o wpEditCell
o wpInitCellStructs
o wpPaintCell
o wpPaintPalette
o wpQueryPaletteHelp
o wpQueryPaletteInfo
o wpRedrawCell
o wpRestoreCellData
o wpSaveCellData
o wpSelectCell
o wpSetPaletteInfo
o wpSetupCell
o wpShowPalettePointer
WPObject instance methods
The following list shows all the methods overridden by the WPPalette class.
These methods are overridden to modify the behavior defined by an ancestor
class.
o wpFilterPopupMenu
o wpInitData
o wpMenuItemHelpSelected
o wpMenuItemSelected
o wpModifyPopupMenu
o wpOpen
o wpRestoreState
o wpSaveState
o wpSetup
o wpUnInitData
wpSetup override by WPPalette
The following table shows the keyname-value pairs added by the WPPalette
class.
ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ
ΓöéKEYNAME ΓöéVALUE ΓöéDESCRIPTION Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéXCELLCOUNT Γöécolumns ΓöéNumber of columns of cells. Γöé
Γöé Γöé ΓöéIf not specified, defaults to Γöé
Γöé Γöé Γöé13. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéYCELLCOUNT Γöérows ΓöéNumber of rows of cells. If Γöé
Γöé Γöé Γöénot specified, defaults to 9. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéXCELLWIDTH Γöéwidth ΓöéWidth in dialog units of each Γöé
Γöé Γöé Γöécell. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéYCELLHEIGHT Γöéheight ΓöéHeight in dialog units of eachΓöé
Γöé Γöé Γöécell. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéXCELLGAP Γöégap ΓöéX separation in dialog units Γöé
Γöé Γöé Γöébetween each cell. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéYCELLGAP Γöégap ΓöéY separation in dialog units Γöé
Γöé Γöé Γöébetween each cell. Γöé
ΓööΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö┤ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö┤ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÿ
Example
pszSetupString="XCELLCOUNT=3,YCELLCOUNT=4"
Class methods
The following list shows all the WPPalette class methods:
o wpclsQueryEditString
WPObject class methods.
The following list shows all the class methods overridden by the WPPalette
class. These methods are overridden to modify the behavior defined by an
ancestor class.
o wpclsQueryDefaultHelp
o wpclsQueryDefaultView
o wpclsQueryStyle
o wpclsQueryTitle
ΓòÉΓòÉΓòÉ 3.27. WPPdr ΓòÉΓòÉΓòÉ
Class definition file: wppdr.idl
Class hierarchy
SOMObject
WPObject
WPTransient
WPPdr
Description
This is the printer driver object class. An instance of this class is created
by the print object in its Settings view.
Instance methods
There are currently no methods defined for the WPPdr Workplace class object.
WPObject instance methods
The following list shows all the methods overridden by the WPPdr class. These
methods are overridden in order to modify the behavior defined by an ancestor
class.
o wpAddSettingsPages
o wpDragOver
o wpDrop
o wpFilterPopupMenu
o wpFree
o wpInitData
o wpMenuItemHelpSelected
o wpMenuItemSelected
o wpModifyPopupMenu
o wpOpen
o wpQueryIcon
o wpQueryTitle
o wpUnInitData
Class methods
There are currently no class methods defined for the WPPdr Workplace class
object.
WPObject class methods.
The following list shows all the class methods overridden by the WPPdr class.
These methods are overridden to modify the behavior defined by an ancestor
class.
o wpclsQueryDefaultHelp
o wpclsQueryDefaultView
o wpclsQueryIcon
o wpclsQueryStyle
o wpclsQueryTitle
ΓòÉΓòÉΓòÉ 3.28. WPPif ΓòÉΓòÉΓòÉ
Class definition file: wppif.idl
Class hierarchy
SOMObject
WPObject
WPFileSystem
WPDataFile
WPPif
Description
This is the Picture Interchange Format (PIF) class object. All PIF files are of
this class. These PIF files are templatable. An instance of this class can be
created as a Workplace object. Instances of this class are created initially by
the system for each PIF file in the system.
Instance methods
There are currently no methods defined for the WPPif Workplace class object.
WPObject instance methods
The following list shows all the methods overridden by the WPPif class. These
methods are overridden in order to modify the behavior defined by an ancestor
class.
o wpSetupOnce
Class methods
There are currently no class methods defined for the WPPif Workplace class
object.
WPObject class methods.
The following list shows all the class methods overridden by the WPPif class.
These methods are overridden to modify the behavior defined by an ancestor
class.
o wpclsInitData
o wpclsQueryDefaultHelp
o wpclsQueryTitle
WPFileSystem class methods.
The following list shows all the class methods overridden by the WPPif class.
These methods are overridden to modify the behavior defined by an ancestor
class.
o wpclsQueryInstanceFilter
o wpclsQueryInstanceType
ΓòÉΓòÉΓòÉ 3.29. WPPointer ΓòÉΓòÉΓòÉ
Class definition file: wpptr.idl
Class hierarchy
SOMObject
WPObject
WPFileSystem
WPDataFile
WPPointer
Description
This is the WPPointer class. All pointers are of this class. These pointer
files are templatable. An instance of this class can be created as a Workplace
object. Instances of this class are created initially by the system for each
pointer in the system.
Instance methods
There are currently no methods defined for the WPPointer Workplace class
object.
WPObject instance methods
The following list shows all the methods overridden by the WPPointer class.
These methods are overridden in order to modify the behavior defined by an
ancestor class.
o wpSetupOnce
Class methods
There are currently no class methods defined for the WPPointer Workplace class
object.
WPObject class methods
The following list shows all the class methods overridden by the WPPointer
class. These methods are overridden to modify the behavior defined by an
ancestor class.
o wpclsInitData
o wpclsQueryDefaultHelp
o wpclsQueryTitle
WPFileSystem class methods.
The following list shows all the class methods overridden by the WPPointer
class. These methods are overridden to modify the behavior defined by an
ancestor class.
o wpclsQueryInstanceFilter
o wpclsQueryInstanceType
ΓòÉΓòÉΓòÉ 3.30. WPPort ΓòÉΓòÉΓòÉ
Class definition file: wpport.idl
Class hierarchy
SOMObject
WPObject
WPTransient
WPPort
Description
This is the port object class. An instance of this class is created by the
print object in its Settings view.
Instance methods
There are currently no methods defined for the WPPort Workplace class object.
WPObject instance methods
The following list shows all the methods overridden by the WPPort class. These
methods are overridden in order to modify the behavior defined by an ancestor
class.
o wpCnrSetEmphasis
o wpDragOver
o wpDrop
o wpFilterPopupMenu
o wpFree
o wpInitData
o wpMenuItemHelpSelected
o wpMenuItemSelected
o wpModifyPopupMenu
o wpOpen
o wpQueryIcon
o wpQueryTitle
o wpUnInitData
Class methods
There are currently no class methods defined for the WPPort Workplace class
object.
WPObject class methods.
The following list shows all the class methods overridden by the WPPort class.
These methods are overridden to modify the behavior defined by an ancestor
class.
o wpclsQueryDefaultHelp
o wpclsQueryDefaultView
o wpclsQueryIcon
o wpclsQueryIconData
o wpclsQueryStyle
o wpclsQueryTitle
ΓòÉΓòÉΓòÉ 3.31. WPPower ΓòÉΓòÉΓòÉ
Class definition file: wppower.idl
Class hierarchy
SOMObject
WPObject
WPAbstract
WPPower
Description
This class is specific to version 2.1, or higher, of the OS/2 operating system.
This is the power object class that represents the power management support. An
instance of this class can be created as a Workplace object. An instance of
this class is created initially by systems that support power management. It
cannot be deleted. It has the title "Power" and resides in the "System Setup"
folder.
Instance methods
The following list shows all the WPPower methods:
o wpAddPowerPage
o wpAddPowerViewPage
o wpChangePowerState
o wpQueryAutoRefresh
o wpQueryDefStatusView
o wpQueryPowerConfirmation
o wpQueryPowerManagement
o wpQueryRefreshRate
o wpSetAutoRefresh
o wpSetDefStatusView
o wpSetPowerConfirmation
o wpSetPowerManagement
o wpSetRefreshRate
WPObject instance methods
The following list shows all the methods overridden by the WPPower class.
These methods are overridden in order to modify the behavior defined by an
ancestor class.
o wpAddObjectWindowPage
o wpAddSettingsPages
o wpFilterPopupMenu
o wpInitData
o wpMenuItemHelpSelected
o wpMenuItemSelected
o wpModifyPopupMenu
o wpOpen
o wpRestoreState
o wpSaveState
Class methods
There are currently no class methods defined for the WPPower Workplace class
object.
WPObject class methods
The following list shows all the class methods overridden by the WPPower
class. These methods are overridden to modify the behavior defined by an
ancestor class.
o wpclsQueryDefaultHelp
o wpclsQueryDefaultView
o wpclsQueryIconData
o wpclsQueryStyle
o wpclsQueryTitle
ΓòÉΓòÉΓòÉ 3.32. WPPrinter ΓòÉΓòÉΓòÉ
Class definition file: wpprint.idl
Class hierarchy
SOMObject
WPObject
WPAbstract
WPPrinter
Description
This is the printer object class. An instance of this class can be created as a
Workplace object. An instance of this class is created initially by the system
in its template form. It has the title "Printer" and resides in the "Templates"
folder. Instances of this class are also created initially by the system for
each print configured. Each instance will have a title corresponding to the
description of the configured queue and printer and will reside on the desktop.
Instance methods
The following list shows all the WPPrinter methods:
o wpDeleteAllJobs
o wpHoldPrinter
o wpJobAdded
o wpJobChanged
o wpJobDeleted
o wpQueryComputerName
o wpQueryPrinterName
o wpQueryQueueOptions
o wpQueryRemoteOptions
o wpReleasePrinter
o wpSetComputerName
o wpSetDefaultPrinter
o wpSetPrinterName
o wpSetQueueOptions
o wpSetRemoteOptions
WPObject instance methods
The following list shows all the methods overridden by the WPPrinter class.
These methods are overridden in order to modify the behavior defined by an
ancestor class.
o wpAddSettingsPages
o wpCopiedFromTemplate
o wpCopyObject
o wpCreateAnother
o wpCreateFromTemplate
o wpCreateShadowObject
o wpDragOver
o wpDrop
o wpFilterPopupMenu
o wpFree
o wpInitData
o wpMenuItemHelpSelected
o wpMenuItemSelected
o wpModifyPopupMenu
o wpMoveObject
o wpOpen
o wpQueryDefaultHelp
o wpQueryDefaultView
o wpQueryIcon
o wpQueryIconData
o wpQueryStyle
o wpQueryTitle
o wpRestoreState
o wpSaveState
o wpSetDefaultView
o wpSetIcon
o wpSetIconData
o wpSetTitle
o wpSetup
o wpUnInitData
wpSetup override by WPPrint
The following table shows the keyname-value pairs added by the WPPrint class.
ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ
ΓöéKEYNAME ΓöéVALUE ΓöéDESCRIPTION Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéAPPDEFAULT ΓöéYES ΓöéThis printer object is to Γöé
Γöé Γöé Γöébecome the application's Γöé
Γöé Γöé Γöédefault printer object for Γöé
Γöé Γöé Γöéprinting. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéNO ΓöéThis printer object is not Γöé
Γöé Γöé Γöéto become the application'sΓöé
Γöé Γöé Γöédefault printer object for Γöé
Γöé Γöé Γöéprinting. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéDEFAULTVIEW ΓöéDETAILS ΓöéDefault open view for this Γöé
Γöé Γöé Γöéprinter object is in Γöé
Γöé Γöé Γöédetails view. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéICON ΓöéDefault open view for this Γöé
Γöé Γöé Γöéprinter object is in icon Γöé
Γöé Γöé Γöéview. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéJOBDIALOGBEFOREPRINT ΓöéYES ΓöéThe job properties dialog Γöé
Γöé Γöé Γöéis displayed before Γöé
Γöé Γöé Γöéprinting. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéNO ΓöéThe job properties dialog Γöé
Γöé Γöé Γöéis not displayed before Γöé
Γöé Γöé Γöéprinting. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéJOBPROPERTIES Γöéfilename ΓöéThe complete path to a Γöé
Γöé Γöé Γöébinary file containing the Γöé
Γöé Γöé Γöédefault job properties for Γöé
Γöé Γöé Γöéthis printer object. This Γöé
Γöé Γöé Γöéfile can be created by Γöé
Γöé Γöé Γöésaving the Γöé
Γöé Γöé ΓöéPRQINFO3->pDriverData data Γöé
Γöé Γöé Γöéto a file; this data can beΓöé
Γöé Γöé Γöéobtained by using the Γöé
Γöé Γöé ΓöéSplQueryQueue API of the Γöé
Γöé Γöé Γöéspooler. Γöé
Γöé Γöé ΓöéFor more information about Γöé
Γöé Γöé Γöéspooler functions, see the Γöé
Γöé Γöé ΓöéPresentation Manager Γöé
Γöé Γöé ΓöéProgramming Reference. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéOUTPUTTOFILE ΓöéYES ΓöéThe output of this printer Γöé
Γöé Γöé Γöéobject goes to a file. The Γöé
Γöé Γöé Γöéuser will be prompted for aΓöé
Γöé Γöé Γöéfilename each time a print Γöé
Γöé Γöé Γöéjob is submitted to this Γöé
Γöé Γöé Γöéprinter object. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéNO ΓöéThe output of this printer Γöé
Γöé Γöé Γöéobject does not go to a Γöé
Γöé Γöé Γöéfile. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéPORTNAME Γöéportname ΓöéThe names of already Γöé
Γöé Γöé Γöéinstalled ports to which Γöé
Γöé Γöé Γöéthis printer object is to Γöé
Γöé Γöé Γöébe attached. In the case ofΓöé
Γöé Γöé Γöémore than one port, specifyΓöé
Γöé Γöé Γöéa comma-separated list. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéPRINTDRIVER Γöédriver.deviceΓöéThe complete name of the Γöé
Γöé Γöé Γöéprint-driver that this Γöé
Γöé Γöé Γöéprinter object is to use. Γöé
Γöé Γöé ΓöéFor example: 'IBM42XX.IBM Γöé
Γöé Γöé Γöé420 Proprinter III' Γöé
Γöé Γöé ΓöéIn the case of more than Γöé
Γöé Γöé Γöéone print driver, specify aΓöé
Γöé Γöé Γöécomma-separated list. Γöé
Γöé Γöé ΓöéThese printer drivers must Γöé
Γöé Γöé Γöéalready be installed. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéPRINTERSPECIFICFORMAT ΓöéYES ΓöéThe printer object spools Γöé
Γöé Γöé Γöéprint jobs in PM_Q_RAW Γöé
Γöé Γöé Γöéformat. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéNO ΓöéThe printer object spools Γöé
Γöé Γöé Γöéprint jobs in PM_Q_STANDARDΓöé
Γöé Γöé Γöéformat. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéPRINTWHILESPOOLING ΓöéYES ΓöéThe printing is enabled Γöé
Γöé Γöé Γöéwhile the job is spooling. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéNO ΓöéThe printing is disabled Γöé
Γöé Γöé Γöéwhile the job is spooling. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéQSTARTTIME Γöétime ΓöéThe time when the printer Γöé
Γöé Γöé Γöéobject starts printing. TheΓöé
Γöé Γöé Γöétime format is HH:MM, and Γöé
Γöé Γöé Γöéthe base is a 24-hour Γöé
Γöé Γöé Γöéclock. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéQSTOPTIME Γöétime ΓöéThe time when the printer Γöé
Γöé Γöé Γöéobject is to stop printing.Γöé
Γöé Γöé ΓöéThe time format is HH:MM, Γöé
Γöé Γöé Γöéand the base is a 24-hour Γöé
Γöé Γöé Γöéclock. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéQUEUENAME Γöéname ΓöéThe local queue name for Γöé
Γöé Γöé Γöéthe printer object. If a Γöé
Γöé Γöé Γöéqueue name is not Γöé
Γöé Γöé Γöéspecified, one is created Γöé
Γöé Γöé Γöéby the printer object. Γöé
Γöé Γöé ΓöéThe QUEUENAME key will be Γöé
Γöé Γöé Γöéignored if this object has Γöé
Γöé Γöé Γöéalready been assigned a Γöé
Γöé Γöé Γöéqueue. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéQUEUEDRIVER Γöéqdrvname ΓöéThe queue driver name. The Γöé
Γöé Γöé Γöéqueue driver must already Γöé
Γöé Γöé Γöébe installed. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéSEPARATORFILE Γöéfilename ΓöéA separator file that Γöé
Γöé Γöé Γöéprints before each print Γöé
Γöé Γöé Γöéjob. Γöé
ΓööΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö┤ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö┤ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÿ
Class methods
There are currently no class methods defined for the WPPrinter Workplace class
object.
WPObject class methods.
The following list shows all the class methods overridden by the WPPrinter
class. These methods are overridden to modify the behavior defined by an
ancestor class.
o wpclsInitData
o wpclsQueryDefaultHelp
o wpclsQueryDefaultView
o wpclsQueryIcon
o wpclsQueryIconData
o wpclsQueryStyle
o wpclsQueryTitle
ΓòÉΓòÉΓòÉ 3.33. WPProgram ΓòÉΓòÉΓòÉ
Class definition file: wppgm.idl
Class hierarchy
SOMObject
WPObject
WPAbstract
WPProgram
Description
This is the program object class. This class provides an object that points to
executable programs and allows the user to run that program by simply
double-clicking on the program object. The program can also contain a variety
of useful additional parameters, such as the environment for the program and
the parameters that are passed to it. An instance of this class can be created
as a Workplace object and is created initially by the system in its template
form. It has the title "Program" and resides in the "Templates" folder.
Other instances of this class initially created by the system include:
o "DOS Full Screen" in the "Command Prompts" folder
o "DOS Window" in the "Command Prompts" folder
o "OS/2 Full Screen" in the "Command Prompts" folder
o "OS/2 Window" in the "Command Prompts" folder
o Every object in the "Games" folder
o Some objects in the "Information" folder
o Every object in the "Productivity" folder
Instance methods
The following list shows all the WPProgram methods:
o wpAddProgramAssociationPage
o wpAddProgramPage
o wpAddProgramSessionPage
o wpQueryAssociationFilter
o wpQueryAssociationType
o wpQueryProgDetails
o wpQueryProgramAssociations
o wpSetAssociationFilter
o wpSetAssociationType
o wpSetProgDetails
o wpSetProgramAssociations
o wpSetProgIcon
WPObject instance methods
The following list shows all the methods overridden by the WPProgram class.
These methods are overridden in order to modify the behavior defined by an
ancestor class.
o wpAddSettingsPages
o wpCopyObject
o wpCreateAnother
o wpCreateFromTemplate
o wpDragOver
o wpDrop
o wpInitData
o wpMenuItemHelpSelected
o wpMenuItemSelected
o wpModifyPopupMenu
o wpMoveObject
o wpOpen
o wpQueryDefaultHelp
o wpQueryIcon
o wpQueryIconData
o wpRestoreState
o wpSaveState
o wpSetIconData
o wpSetTitle
o wpSetup
o wpUnInitData
wpSetup override by WPProgram
The following table shows the keyname-value pairs added by the WPProgram
class.
ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ
ΓöéKEYNAME ΓöéVALUE ΓöéDESCRIPTION Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéASSOCFILTER Γöéfilters ΓöéSets the filename filter for Γöé
Γöé Γöé Γöéfiles associated with this Γöé
Γöé Γöé Γöéprogram. Multiple filters are Γöé
Γöé Γöé Γöéseparated by commas. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéASSOCTYPE Γöétype ΓöéSets the type of files Γöé
Γöé Γöé Γöéassociated with this program. Γöé
Γöé Γöé ΓöéMultiple types are separated Γöé
Γöé Γöé Γöéby commas. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéEXENAME Γöéfilename ΓöéSets the name of the program. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéMAXIMIZED ΓöéYES ΓöéThe program window is Γöé
Γöé Γöé Γöémaximized upon startup. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéNO ΓöéThe program window is restoredΓöé
Γöé Γöé Γöéto normal upon startup. Γöé
Γöé Γöé ΓöéThis is the default setting. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéMINIMIZED ΓöéYES ΓöéThe program window is Γöé
Γöé Γöé Γöéminimized upon startup. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéNO ΓöéThe program window is restoredΓöé
Γöé Γöé Γöéto normal upon startup. Γöé
Γöé Γöé ΓöéThis is the default setting. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéPROGTYPE ΓöéFULLSCREEN ΓöéSets the session type to OS/2 Γöé
Γöé Γöé Γöéfull-screen mode. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéPM ΓöéSets the session type to PM. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéPROG_30_STD ΓöéSets the session type to Γöé
Γöé Γöé Γöéstandard compatibility full Γöé
Γöé Γöé Γöéscreen mode. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéPROG_31_ENH ΓöéSets the session type to Γöé
Γöé Γöé Γöéenhanced compatibility full Γöé
Γöé Γöé Γöéscreen mode. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéPROG_31_ENHSEAMLESSCOMMONΓöéSets the session type to Γöé
Γöé Γöé ΓöéWIN-OS/2* window in the Γöé
Γöé Γöé ΓöéWIN-OS/2 enhanced Γöé
Γöé Γöé Γöécompatibility common session. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéPROG_31_ENHSEAMLESSVDM ΓöéSets the session type to Γöé
Γöé Γöé ΓöéWIN-OS/2 window in a separate Γöé
Γöé Γöé Γöésession enhanced compatibilityΓöé
Γöé Γöé Γöémode. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéPROG_31_STD ΓöéSets the session type to Γöé
Γöé Γöé Γöéstandard compatibility full Γöé
Γöé Γöé Γöéscreen mode. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéPROG_31_STDSEAMLESSCOMMONΓöéSets the session type to Γöé
Γöé Γöé ΓöéWIN-OS/2 window in the Γöé
Γöé Γöé ΓöéWIN-OS/2 standard Γöé
Γöé Γöé Γöécompatibility common session. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéPROG_31_STDSEAMLESSVDM ΓöéSets the session type to Γöé
Γöé Γöé ΓöéWIN-OS/2 window in a separate Γöé
Γöé Γöé Γöésession standard compatibilityΓöé
Γöé Γöé Γöémode. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéSEPARATEWIN ΓöéSets the session type to Γöé
Γöé Γöé ΓöéWIN-OS/2 window running in a Γöé
Γöé Γöé Γöéseparate VDM. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéVDM ΓöéSets the session type to DOS Γöé
Γöé Γöé Γöéfull-screen. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéWIN ΓöéSets the session type to Γöé
Γöé Γöé ΓöéWIN-OS/2 full screen. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéWINDOWABLEVIO ΓöéSets the session type to OS/2 Γöé
Γöé Γöé Γöéwindowed. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéWINDOWEDVDM ΓöéSets the session type to DOS Γöé
Γöé Γöé Γöéwindowed. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéWINDOWEDWIN ΓöéSets the session type to Γöé
Γöé Γöé ΓöéWIN-OS/2 window. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéNOAUTOCLOSE ΓöéYES ΓöéLeaves the window open when Γöé
Γöé Γöé Γöéthe program terminates. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéNO ΓöéCloses the window when the Γöé
Γöé Γöé Γöéprogram terminates. Γöé
Γöé Γöé ΓöéThis is the default setting. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéPARAMETERS Γöéparams ΓöéSets the parameters list, Γöé
Γöé Γöé Γöéwhich may include substitutionΓöé
Γöé Γöé Γöécharacters. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéSET ΓöéXXX=VVV ΓöéXXX is an environment Γöé
Γöé Γöé Γöévariable. VVV sets the value Γöé
Γöé Γöé Γöéof the environment variable. Γöé
Γöé Γöé ΓöéThis is also used to specify Γöé
Γöé Γöé ΓöéDOS settings on DOS and Γöé
Γöé Γöé ΓöéWindows** programs. Γöé
Γöé Γöé ΓöéEach variable/value pair must Γöé
Γöé Γöé Γöébe separated by a NULL (\0), Γöé
Γöé Γöé Γöéand the entire string must be Γöé
Γöé Γöé Γöéterminated by two NULLS Γöé
Γöé Γöé Γöé(\0\0). For exmple: DOS Γöé
Γöé Γöé ΓöéDEVICE=value\0env=value\0\0 Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéSTARTUPDIR Γöépathname ΓöéSets the working directory. Γöé
ΓööΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö┤ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö┤ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÿ
Example
pszSetupString="PROGTYPE=VDM;EXENAME=C=\EDIT.EXE;
ASSOCFILTER=*.DOC,*.TXT;ASSOCTYPE=Plain Text;
SET DOS_DEVICE=1.SYS,2.SYS;
SET PATH=C:\FRED"
Class methods
There are currently no class methods defined for the WPProgram Workplace class
object.
WPObject class methods.
The following list shows all the class methods overridden by the WPProgram
class. These methods are overridden to modify the behavior defined by an
ancestor class.
o wpclsQueryDefaultHelp
o wpclsQueryDefaultView
o wpclsQueryIconData
o wpclsQueryStyle
o wpclsQueryTitle
ΓòÉΓòÉΓòÉ 3.34. WPProgramFile ΓòÉΓòÉΓòÉ
Class definition file: wppgmf.idl
Class hierarchy
SOMObject
WPObject
WPFileSystem
WPDataFile
WPProgramFile
Description
This is the program file object class. All executable files are of this class.
From the Settings notebook pages for objects of this class, it is possible to
set up associations to various data file types (files with .TYPE EAs or file
extensions). It is also possible to set up a default working directory and
specify parameters to the executable program to be used when it is opened from
the shell. An instance of this class can be created as a Workplace object.
Instances of this class are created initially by the system for each program
file in the system. Each instance has a title corresponding to the file name of
the program file it represents and resides in a folder corresponding to the
physical directory in which the program file resides.
Instance methods
The following list shows all the WPProgramFile methods:
o wpAddProgramAssociationPage
o wpAddProgramPage
o wpAddProgramSessionPage
o wpQueryAssociationFilter
o wpQueryAssociationType
o wpQueryProgDetails
o wpQueryProgramAssociations
o wpSetAssociationFilter
o wpSetAssociationType
o wpSetProgDetails
o wpSetProgramAssociations
o wpSetProgIcon
WPObject instance methods
The following list shows all the methods overridden by the WPProgramFile
class. These methods are overridden in order to modify the behavior defined by
an ancestor class.
o wpAddSettingsPages
o wpCopyObject
o wpCreateAnother
o wpDragOver
o wpDrop
o wpFilterPopupMenu
o wpInitData
o wpMenuItemHelpSelected
o wpMenuItemSelected
o wpModifyPopupMenu
o wpMoveObject
o wpOpen
o wpQueryNameClashOptions
o wpRestoreState
o wpSaveState
o wpSetup
wpSetup override by WPProgramFile
The following table shows the keyname-value pairs added by the WPProgramFile
class.
ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ
ΓöéKEYNAME ΓöéVALUE ΓöéDESCRIPTION Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéASSOCFILTER Γöéfilters ΓöéSets the filename Γöé
Γöé Γöé Γöéfilter for files Γöé
Γöé Γöé Γöéassociated with thisΓöé
Γöé Γöé Γöéprogram. Multiple Γöé
Γöé Γöé Γöéfilters are Γöé
Γöé Γöé Γöéseparated by commas.Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéASSOCTYPE Γöétype ΓöéSets the type of Γöé
Γöé Γöé Γöéfiles associated Γöé
Γöé Γöé Γöéwith this program. Γöé
Γöé Γöé ΓöéMultiple types are Γöé
Γöé Γöé Γöéseparated by commas.Γöé
ΓööΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö┤ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö┤ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÿ
Example
pszSetupString="PROGTYPE=VDM;EXENAME=C=\EDIT.EXE;
ASSOCFILTER=*.DOC,*.TXT;ASSOCTYPE=Plain Text"
WPDataFile instance methods
The following list shows all the methods overridden by the WPProgramFile
class. These methods are overridden in order to modify the behavior defined by
an ancestor class.
o wpSetAssociatedFileIcon
Class methods
There are currently no class methods defined for the WPProgramFile Workplace
class object.
WPObject class methods.
The following list shows all the class methods overridden by the WPProgramFile
class. These methods are overridden to modify the behavior defined by an
ancestor class.
o wpclsQueryDefaultView
o wpclsQueryIconData
o wpclsQueryStyle
o wpclsQueryTitle
ΓòÉΓòÉΓòÉ 3.35. WPQdr ΓòÉΓòÉΓòÉ
Class definition file: wpqdr.idl
Class hierarchy
SOMObject
WPObject
WPTransient
WPQdr
Description
This is the queue driver object class. An instance of this class is created by
the print object in its Settings view.
Instance methods
There are currently no methods defined for the WPQdr Workplace class object.
WPObject instance methods
The following list shows all the methods overridden by the WPQdr class. These
methods are overridden in order to modify the behavior defined by an ancestor
class.
o wpAddSettingsPages
o wpDragOver
o wpDrop
o wpFilterPopupMenu
o wpFree
o wpInitData
o wpMenuItemHelpSelected
o wpMenuItemSelected
o wpModifyPopupMenu
o wpOpen
o wpQueryIcon
o wpQueryTitle
o wpUnInitData
Class methods
There are currently no class methods defined for the WPQdr Workplace class
object.
WPObject class methods.
The following list shows all the class methods overridden by the WPQdr class.
These methods are overridden to modify the behavior defined by an ancestor
class.
o wpclsQueryDefaultHelp
o wpclsQueryDefaultView
o wpclsQueryIcon
o wpclsQueryStyle
o wpclsQueryTitle
ΓòÉΓòÉΓòÉ 3.36. WPRootFolder ΓòÉΓòÉΓòÉ
Class definition file: wprootf.idl
Class hierarchy
SOMObject
WPObject
WPFileSystem
WPFolder
WPRootFolder
Description
The WPRootFolder class represents the root folder (or directory) of a
file-system device. Instances of this class exist for every file-system device
available. Each instance is paired with a WPDisk object, which represents a
particular device. An instance of this class can be created as a Workplace
object.
Instance methods
There are no methods defined in the WPRootFolder Workplace object class.
WPFileSystem instance methods
The following list shows the instance methods overridden by the WPRootFolder
class. These methods are overridden in order to modify the behavior defined by
an ancestor class.
o wpAddFile1Page
o wpAddFile2Page
o wpAddFile3Page
WPObject instance methods
The following list shows the instance methods overridden by the WPRootFolder
class. These methods are overridden in order to modify the behavior defined by
an ancestor class.
o wpFilterPopupMenu
o wpOpen
o wpRefresh
o wpRestoreState
o wpSaveState
o wpSetDefaultView
o wpSetTitle
Class methods
There are currently no class methods defined for the WPRootFolder Workplace
class object.
WPObject class methods
The following list shows all the class methods overridden by the WPRootFolder
class. These methods are overridden to modify the behavior defined by an
ancestor class.
o wpclsInitData
o wpclsQueryDefaultView
o wpclsQueryStyle
o wpclsUnInitData
ΓòÉΓòÉΓòÉ 3.37. WPRPrinter ΓòÉΓòÉΓòÉ
Class definition file: wprprint.idl
Class hierarchy
SOMObject
WPObject
WPAbstract
WPPrinter
WPRPrinter
Description
This is the remote (network) printer object class. An instance of this class
represents a print resource on another computer or server. For proper behavior,
a network must be installed. Each instance has a title corresponding to the
remote resource and resides on the desktop.
Instance methods
The following list shows all the WPRPrinter methods:
o wpAddNetworkPage
o wpQueryLocalAlias
o wpQueryNetworkId
WPObject instance methods
The following list shows all the methods overridden by the WPRPrinter class.
These methods are overridden in order to modify the behavior defined by an
ancestor class.
o wpAddSettingsPages
o wpCopiedFromTemplate
o wpCopyObject
o wpCreateFromTemplate
o wpDragOver
o wpDrop
o wpFilterPopupMenu
o wpInitData
o wpMenuItemHelpSelected
o wpMenuItemSelected
o wpModifyPopupMenu
o wpOpen
o wpRestoreState
o wpSaveState
o wpSetup
o wpUnInitData
wpSetup override by WPRPrinter
The following table shows the keyname-value pairs added by the WPRPrinter
class.
ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ
ΓöéKEYNAME ΓöéVALUE ΓöéDESCRIPTION Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéICON Γöéfilename ΓöéThe name of the .ICO file Γöé
Γöé Γöé Γöéto be used as the icon forΓöé
Γöé Γöé Γöéthis object. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéNETID Γöé<network> ΓöéThe full name of the Γöé
Γöé Γöé Γöéprinter resource as it is Γöé
Γöé Γöé Γöéknown to the network. For Γöé
Γöé Γöé Γöéexample: Γöé
Γöé Γöé ΓöéLS:\\DEPTSERV\DEPTPRNT Γöé
Γöé Γöé ΓöéThe NETID key will be Γöé
Γöé Γöé Γöéignored and FALSE will be Γöé
Γöé Γöé Γöéreturned if this object Γöé
Γöé Γöé Γöéhas already been assigned Γöé
Γöé Γöé Γöéa NetId. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéREFRESHINTERVAL Γöévalue ΓöéTime interval, in seconds,Γöé
Γöé Γöé Γöéwhen the printer object isΓöé
Γöé Γöé Γöérefreshed. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéSHOWJOBS ΓöéALL ΓöéAll jobs are displayed in Γöé
Γöé Γöé Γöéthe printer object. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéOWN ΓöéOnly the current user's Γöé
Γöé Γöé Γöéjobs are displayed in the Γöé
Γöé Γöé Γöéprinter object. Γöé
ΓööΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö┤ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö┤ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÿ
Class methods
There are currently no class methods defined for the WPRPrinter Workplace
class object.
WPObject class methods.
The following list shows all the class methods overridden by the WPRPrinter
class. These methods are overridden to modify the behavior defined by an
ancestor class.
o wpclsQueryIcon
o wpclsQueryIconData
o wpclsQueryStyle
o wpclsQueryTitle
ΓòÉΓòÉΓòÉ 3.38. WPSchemePalette ΓòÉΓòÉΓòÉ
Class definition file: wpscheme.idl
Class hierarchy
SOMObject
WPObject
WPAbstract
WPPalette
WPSchemePalette
Description
This is the scheme palette object class. An instance of this class can be
created as a Workplace object. An instance of this class is created initially
by the system. It has the title "Scheme Palette" and resides in the "System
Setup" folder.
Instance methods
There are currently no methods defined for the WPSchemePalette Workplace class
object.
WPObject instance methods
The following list shows all the methods overridden by the WPSchemePalette
class. These methods are overridden in order to modify the behavior defined by
an ancestor class.
o wpMenuItemHelpSelected
o wpSetup
wpSetup override by WPSchemePalette
The following are the keyname-value pairs added by the WPSchemePalette class.
ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ
ΓöéKEYNAME ΓöéVALUE ΓöéDESCRIPTION Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéAUTOSETUP ΓöéYES ΓöéThis automatically sets the palette Γöé
Γöé Γöé Γöévalues to the original system palette Γöé
Γöé Γöé Γöésettings. Γöé
Γöé Γöé ΓöéThis is the default setting. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéNO ΓöéThis does not set palette values to Γöé
Γöé Γöé Γöéthe original system palette settings. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéSCHEMES ΓöéSchemetype ΓöéThese are the initial schemes for eachΓöé
Γöé Γöé Γöécell in the scheme palette. The valuesΓöé
Γöé Γöé Γöéfor each cell are separated by commas.Γöé
Γöé Γöé ΓöéThis is equivalent to calling the Γöé
Γöé Γöé ΓöéwpSetupCell instance method. The Γöé
Γöé Γöé Γöéschemetype value is presented as the Γöé
Γöé Γöé Γöéscheme name followed by a colon, Γöé
Γöé Γöé Γöéfollowed by an application name in theΓöé
Γöé Γöé ΓöéINI file. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéXCELLCOUNTΓöécolumns ΓöéNumber of X cells as decimal digits. Γöé
Γöé Γöé ΓöéIf not specified, defaults to 4. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéYCELLCOUNTΓöérows ΓöéNumber of Y cells as decimal digits. Γöé
Γöé Γöé ΓöéIf not specified, defaults to 7. Γöé
ΓööΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö┤ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö┤ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÿ
Example
pszSetupString="SCHEMES=Marble:PM_Marble_Colors,Southwest:PM_Southwest_Colors,
Khaki:PM_Khaki_Colors"
WPPalette methods
The following list shows all the methods overridden by the WPSchemePalette
class. These methods are overridden in order to modify the behavior defined by
an ancestor class.
o wpDragCell
o wpEditCell
o wpPaintCell
o wpQueryPaletteHelp
o wpSetupCell
Class methods
There are currently no class methods defined for the WPSchemePalette Workplace
class object.
WPObject class methods
The following list shows all the class methods overridden by the
WPSchemePalette class. These methods are overridden to modify the behavior
defined by an ancestor class.
o wpclsQueryDefaultHelp
o wpclsQueryIconData
o wpclsQueryStyle
o wpclsQueryTitle
WPPalette class methods
The following list shows all the class methods overridden by the
WPSchemePalette class. These methods are overridden to modify the behavior
defined by an ancestor class.
o wpclsQueryEditString
ΓòÉΓòÉΓòÉ 3.39. WPServer ΓòÉΓòÉΓòÉ
Class definition file: wpserver.idl
Class hierarchy
SOMObject
WPObject
WPFileSystem
WPFolder
WPServer
Description This class is specific to version 3, or higher, of the OS/2
operating system.
This is the server object class. An instances of this class can be created as a
Workplace object. Instances of this class are created for every server in a
WPNetgrp folder that is accessible to the user.
Instance methods
The following list shows all the WPServer methods.
o wpAddServerPage
o wpQuerySrvrIdentity
WPFileSystem instance methods
The following list shows all the methods overridden by the WPServer class.
These methods are overridden in order to modify the behavior defined by an
ancestor class.
o wpAddFile1Page
o wpAddFile2Page
o wpAddFile3Page
WPFolder instance methods
The following list shows all the methods overridden by the WPServer class.
These methods are overridden in order to modify the behavior defined by an
ancestor class.
o wpAddFolderIncludePage
o wpDeleteContents
o wpPopulate
WPObject instance methods
The following list shows all the methods overridden by the WPServer class.
These methods are overridden in order to modify the behavior defined by an
ancestor class.
o wpAddObjectGeneralPage
o wpAddSettingsPages
o wpFilterPopupMenu
o wpInitData
o wpMenuItemHelpSelected
o wpMenuItemSelected
o wpModifyPopupMenu
o wpOpen
o wpRestoreState
o wpSaveState
o wpSetup
o wpUnInitData
wpSetup override by WPServer
The following table shows the keyname-value pairs added by the WPServer class.
ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ
ΓöéKEYNAME ΓöéVALUE ΓöéDESCRIPTION Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéSRVCOMMENT Γöécomment string ΓöéThis sets the object's title to Γöé
Γöé Γöé Γöéthe specified comment string. Γöé
Γöé Γöé ΓöéThis is equivalent to calling Γöé
Γöé Γöé ΓöéwpSetTitle. Γöé
Γöé Γöé ΓöéNote: Γöé
Γöé Γöé ΓöéThe value specified for the TITLEΓöé
Γöé Γöé Γöékeyword will override this Γöé
Γöé Γöé Γöécomment. Γöé
ΓööΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö┤ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö┤ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÿ
Class methods
There are currently no class methods defined for the WPServer Workplace class
object.
WPObject class methods.
The following list shows all the class methods overridden by the WPServer
class. These methods are overridden to modify the behavior defined by an
ancestor class.
o wpclsQueryDefaultHelp
o wpclsQueryIconData
o wpclsQueryIconDataN
o wpclsQueryStyle
o wpclsQueryTitle
ΓòÉΓòÉΓòÉ 3.40. WPShadow ΓòÉΓòÉΓòÉ
Class definition file: wpshadow.idl
Class hierarchy
SOMObject
WPObject
WPAbstract
WPShadow
Description
This is the shadow object class, instances of which provide a persistent link
or reference to any other object. This is achieved by storing away the location
and identity of the object to which it is linked and then rerouting all
requests for help, context menus, and open views to the object to which it is
linked.
Instance methods
The following list shows all the WPShadow methods:
o wpQueryShadowedObject
o wpSetLinkToObject
o wpSetShadowTitle
WPObject instance methods
The following list shows all the methods overridden by the WPShadow class.
These methods are overridden in order to modify the behavior defined by an
ancestor class.
o wpConfirmDelete
o wpConfirmObjectTitle
o wpCreateFromTemplate
o wpCreateShadowObject
o wpDraggedOverObject
o wpDragOver
o wpDrop
o wpDroppedOnObject
o wpFilterPopupMenu
o wpFormatDragItem
o wpInitData
o wpInsertPopupMenuItems
o wpMenuItemHelpSelected
o wpMenuItemSelected
o wpModifyPopupMenu
o wpOpen
o wpPrintObject
o wpQueryDefaultHelp
o wpQueryNameClashOptions
o wpQueryStyle
o wpQueryTitle
o wpRestoreState
o wpSaveState
o wpSetTitle
o wpSetup
o wpUnInitData
o wpViewObject
wpSetup override by WPShadow
The following table shows the keyname-value pairs added by the WPShadow class.
ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ
ΓöéKEYNAME ΓöéVALUE ΓöéDESCRIPTION Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéSHADOWID Γöé<name> or file ΓöéThis specifies the object for Γöé
Γöé Γöéname Γöéwhich this object is a shadow.Γöé
Γöé Γöé ΓöéThe value for this keyname is Γöé
Γöé Γöé Γöéan object's id (OBJECTID) or aΓöé
Γöé Γöé Γöéfully qualified pathname of a Γöé
Γöé Γöé Γöédirectory, program file, or Γöé
Γöé Γöé Γöédata file. Γöé
ΓööΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö┤ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö┤ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÿ
Class methods
WPObject class methods
There are currently no class methods defined for the WPShadow Workplace class
object.
The following list shows all the class methods overridden by the WPShadow
class. These methods are overridden to modify the behavior defined by an
ancestor class.
o wpclsQueryIconData
o wpclsQueryStyle
o wpclsQueryTitle
ΓòÉΓòÉΓòÉ 3.41. WPSharedDir ΓòÉΓòÉΓòÉ
Class definition file: wpshdir.idl
Class hierarchy
SOMObject
WPObject
WPFileSystem
WPFolder
WPSharedDir
Description This class is specific to version 3, or higher, of the OS/2
operating system.
This is the shared directory object class. An instances of this class can be
created as a Workplace object. Instances of this class are created for every
shared directory in a WPServer folder that is accessible to the user.
Instance methods
The following list shows all the WPSharedDir methods.
o wpAddResourcePage
WPFileSystem instance methods
The following list shows all the methods overridden by the WPSharedDir class.
These methods are overridden in order to modify the behavior defined by an
ancestor class.
o wpAddFile1Page
o wpAddFile2Page
o wpAddFile3Page
WPFolder instance methods
The following list shows all the methods overridden by the WPSharedDir class.
These methods are overridden in order to modify the behavior defined by an
ancestor class.
o wpAddFolderIncludePage
o wpPopulate
WPObject instance methods
The following list shows all the methods overridden by the WPSharedDir class.
These methods are overridden in order to modify the behavior defined by an
ancestor class.
o wpAddObjectGeneralPage
o wpAddSettingsPages
o wpFilterPopupMenu
o wpInitData
o wpMenuItemHelpSelected
o wpMenuItemSelected
o wpModifyPopupMenu
o wpOpen
o wpRestoreState
o wpSaveState
Class methods
There are currently no class methods defined for the WPSharedDir Workplace
class object.
WPObject class methods.
The following list shows all the class methods overridden by the WPSharedDir
class. These methods are overridden to modify the behavior defined by an
ancestor class.
o wpclsQueryDefaultHelp
o wpclsQueryDefaultView
o wpclsQueryIconData
o wpclsQueryStyle
o wpclsQueryTitle
ΓòÉΓòÉΓòÉ 3.42. WPShredder ΓòÉΓòÉΓòÉ
Class definition file: wpshred.idl
Class hierarchy
SOMObject
WPObject
WPAbstract
WPShredder
Description
This is the shredder device object class. An instance of this class can be
created as a Workplace object. An instance of this class is created initially
by the system. It has the title "shredder" and resides on the desktop.
Instance methods
There are currently no methods defined for the WPShadow Workplace class object.
WPObject instance methods
The following list shows all the methods overridden by the WPShredder class.
These methods are overridden in order to modify the behavior defined by an
ancestor class.
o wpAddObjectWindowPage
o wpDragOver
o wpDrop
o wpFilterPopupMenu
Class methods
There are currently no class methods defined for the WPShredder Workplace
class object.
WPObject class methods.
The following list shows all the class methods overridden by the WPShredder
class. These methods are overridden to modify the behavior defined by an
ancestor class.
o wpclsQueryDefaultHelp
o wpclsQueryDefaultView
o wpclsQueryIconData
o wpclsQueryStyle
o wpclsQueryTitle
ΓòÉΓòÉΓòÉ 3.43. WPSound ΓòÉΓòÉΓòÉ
Class definition file: wpsound.idl
Class hierarchy
SOMObject
WPObject
WPAbstract
WPSound
Description
This is the sound object class. An instance of this class can be created as a
Workplace object. An instance of this class is created initially by the system.
It has the title "Sound" and resides in the "System Setup" folder.
Instance methods
The following list shows all the WPSound methods:
o wpAddSoundWarningBeepPage
WPObject instance methods
The following list shows all the methods overridden by the WPSound class.
These methods are overridden in order to modify the behavior defined by an
ancestor class.
o wpAddObjectWindowPage
o wpAddSettingsPages
o wpFilterPopupMenu
Class methods
There are currently no class methods defined for the WPSound Workplace class
object.
WPObject class methods
The following list shows all the class methods overridden by the WPSound
class. These methods are overridden to modify the behavior defined by an
ancestor class.
o wpclsQueryDefaultHelp
o wpclsQueryDefaultView
o wpclsQueryIconData
o wpclsQueryStyle
o wpclsQueryTitle
ΓòÉΓòÉΓòÉ 3.44. WPSpecialNeeds ΓòÉΓòÉΓòÉ
Class definition file: wpspneed.idl
Class hierarchy
SOMObject
WPObject
WPAbstract
WPSpecialNeeds
Description
This is the special needs object class. An instance of this class can be
created as a Workplace object. An instance of this class is created initially
by the system when the keyboard special needs mode is activated via the
keyboard object settings. It has the title "Special Needs" and resides on the
desktop.
Instance methods
There are currently no methods defined for the WPSpecialNeeds Workplace object
class.
WPObject instance methods
The following list shows all the methods overridden by the WPSpecialNeeds
class. These methods are overridden in order to modify the behavior defined by
an ancestor class.
o wpFilterPopupMenu
Class methods
There are currently no class methods defined for the WPSpecialNeeds Workplace
class object.
WPObject class methods.
The following list shows all the class methods overridden by the
WPSpecialNeeds class. These methods are overridden to modify the behavior
defined by an ancestor class.
o wpclsQueryDefaultHelp
o wpclsQueryIconData
o wpclsQueryTitle
ΓòÉΓòÉΓòÉ 3.45. WPSpool ΓòÉΓòÉΓòÉ
Class definition file: wpspool.idl
Class hierarchy
SOMObject
WPObject
WPAbstract
WPSpool
Description
This is the spooler object class. An instance of this class is created
initially by the system. It has the title "Spooler" and resides in the "System
Setup" folder.
o wpAddSetPathPage
o wpAddSetPriorityPage
Instance methods
There are currently no class methods defined for the WPSpool Workplace class
object.
WPObject instance methods
The following list shows all the methods overridden by the WPSpool class.
These methods are overridden in order to modify the behavior defined by an
ancestor class.
o wpAddSettingsPages
o wpCopyObject
o wpDragOver
o wpDrop
o wpFilterPopupMenu
o wpInitData
o wpMenuItemHelpSelected
o wpMenuItemSelected
o wpModifyPopupMenu
o wpOpen
o wpQueryIcon
o wpQueryTitle
o wpRestoreState
o wpSaveState
o wpUnInitData
Class methods
There are currently no class methods defined for the WPSpool Workplace class
object.
WPObject class methods.
The following list shows all the class methods overridden by the WPSpool
class. These methods are overridden to modify the behavior defined by an
ancestor class.
o wpclsQueryDefaultHelp
o wpclsQueryDefaultView
o wpclsQueryIcon
o wpclsQueryIconData
o wpclsQueryStyle
o wpclsQueryTitle
ΓòÉΓòÉΓòÉ 3.46. WPStartup ΓòÉΓòÉΓòÉ
Class definition file: wpstart.idl
Class hierarchy
SOMObject
WPObject
WPFileSystem
WPFolder
WPStartup
Description
This is the startup folder object class. Any object in the startup folder will
be automatically opened every time the system is restarted. Any object in the
system that is open at shutdown time will be automatically reopened when the
system is restarted. The startup folder is used to automatically open (start)
objects that are not necessarily open (running) when the system is shut down.
This usually includes things such as a batch file that initializes the network
and then terminates. An instance of this class can be created as a Workplace
object and is created initially by the system. It has the title "Startup" and
resides in the "OS/2 System" folder.
Instance methods
There are currently no methods defined for the WPStartup Workplace object
class.
WPObject instance methods
The following list shows all the methods overridden by the WPStartup class.
These methods are overridden in order to modify the behavior defined by an
ancestor class.
o wpFree
o wpRestoreState
o wpSetupOnce
Class methods
There are currently no class methods defined for the WPStartup Workplace class
object.
WPObject class methods.
The following list shows all the class methods overridden by the WPStartup
class. These methods are overridden to modify the behavior defined by an
ancestor class.
o wpclsQueryDefaultHelp
o wpclsQueryIconData
o wpclsQueryStyle
o wpclsQueryTitle
ΓòÉΓòÉΓòÉ 3.47. WPSystem ΓòÉΓòÉΓòÉ
Class definition file: wpsystem.idl
Class hierarchy
SOMObject
WPObject
WPAbstract
WPSystem
Description
This is the system object class. An instance of this class can be created as a
Workplace object and is created initially by the system. It has the title
"System" and resides in the "System Setup" folder.
Instance methods
The following list shows all the WPSystem class methods:
o wpAddDMQSDisplayTypePage
o wpAddSysFdrSelfClosePage
o wpAddSysFdrDefViewPage
o wpAddSystemConfirmationPage
o wpAddSystemInputPage
o wpAddSystemLogoPage
o wpAddSystemPrintScreenPage
o wpAddSystemScreenPage
o wpAddSystemWindowPage
o wpAddTitleConfirmationPage
WPObject instance methods
The following list shows all the methods overridden by the WPSystem class.
These methods are overridden in order to modify the behavior defined by an
ancestor class.
o wpAddObjectWindowPage
o wpAddSettingsPages
o wpFilterPopupMenu
o wpRestoreState
o wpSaveState
Class methods
There are currently no class methods defined for the WPSystem Workplace class
object.
WPAbstract class methods.
The following list shows all the class methods overridden by the WPSystem
class. These methods are overridden to modify the behavior defined by an
ancestor class.
o wpclsQuerySetting
o wpclsSetSetting
WPObject class methods.
The following list shows all the class methods overridden by the WPSystem
class. These methods are overridden to modify the behavior defined by an
ancestor class.
o wpclsQueryDefaultHelp
o wpclsQueryDefaultView
o wpclsQueryIconData
o wpclsQueryStyle
o wpclsQueryTitle
wpclsSetSettings override by wpSystem
The defaults can be specified on a wpclsSetSetting invocation to request that
the setting be set to its default value. wpclsQuerySetting, however, never
returns an xxxx_DEFAULT value.
ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ
ΓöéSetting ΓöéValue ΓöéDescription Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéAnimation ΓöéANIMATION_ON ΓöéEnables animation Γöé
Γöé Γöé Γöéwhen a window is Γöé
Γöé Γöé Γöécreated or Γöé
Γöé Γöé Γöémaximized. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéANIMATION_OFF ΓöéDisables animation Γöé
Γöé Γöé Γöéwhen a window is Γöé
Γöé Γöé Γöécreated or Γöé
Γöé Γöé Γöémaximized. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéANIMATION_DEFAULT ΓöéSets the default Γöé
Γöé Γöé Γöéwindow animation Γöé
Γöé Γöé Γöésetting. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéConfirmCopyMoveCreateShadowΓöéCONFIRM_ON ΓöéDisplays a Γöé
Γöé Γöé Γöéconfirmation when a Γöé
Γöé Γöé Γöécopy, move, or Γöé
Γöé Γöé Γöécreate shadow Γöé
Γöé Γöé Γöéoperation occurs. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéCONFIRM_OFF ΓöéDoes not display a Γöé
Γöé Γöé Γöéconfirmation when a Γöé
Γöé Γöé Γöécopy, move, or Γöé
Γöé Γöé Γöécreate shadow Γöé
Γöé Γöé Γöéoperation occurs. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéCONFIRM_DEFAULT ΓöéSets the default Γöé
Γöé Γöé Γöéconfirmation displayΓöé
Γöé Γöé Γöésetting. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéConfirmFolderDelete ΓöéCONFIRM_ON ΓöéDisplays a Γöé
Γöé Γöé Γöéconfirmation when a Γöé
Γöé Γöé Γöéfolder is deleted. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéCONFIRM_OFF ΓöéDoes not display a Γöé
Γöé Γöé Γöéconfirmation when a Γöé
Γöé Γöé Γöéfolder is deleted. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéCONFIRM_DEFAULT ΓöéSets the default Γöé
Γöé Γöé Γöéconfirmation displayΓöé
Γöé Γöé Γöésetting. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéConfirmObjectDelete ΓöéCONFIRM_ON ΓöéDisplays a Γöé
Γöé Γöé Γöéconfirmation when anΓöé
Γöé Γöé Γöéobject is deleted. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéCONFIRM_OFF ΓöéDoes not display a Γöé
Γöé Γöé Γöéconfirmation when anΓöé
Γöé Γöé Γöéobject is deleted. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéCONFIRM_DEFAULT ΓöéSets the default Γöé
Γöé Γöé Γöéconfirmation displayΓöé
Γöé Γöé Γöésetting. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéConfirmRenameFileExtension ΓöéCONFIRM_ON ΓöéDisplays a Γöé
Γöé Γöé Γöéconfirmation when a Γöé
Γöé Γöé Γöéfile or extension isΓöé
Γöé Γöé Γöérenamed. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéCONFIRM_OFF ΓöéDoes not display a Γöé
Γöé Γöé Γöéconfirmation when a Γöé
Γöé Γöé Γöéfile or extension isΓöé
Γöé Γöé Γöérenamed. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéCONFIRM_DEFAULT ΓöéSets the default Γöé
Γöé Γöé Γöéconfirmation displayΓöé
Γöé Γöé Γöésetting. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéCurrentView ΓöéCCVIEW_ON ΓöéTurns concurrent Γöé
Γöé Γöé Γöéview mode on. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéCCVIEW_OFF ΓöéTurns concurrent Γöé
Γöé Γöé Γöéview mode off. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéCCVIEW_DEFAULT ΓöéSets the concurrent Γöé
Γöé Γöé Γöéview mode to the Γöé
Γöé Γöé Γöédefault. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéDisplayProgressIndicator ΓöéDISPLAY_ON ΓöéDisplays a progress Γöé
Γöé Γöé Γöéindicator. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéDISPLAY_OFF ΓöéDoes not display Γöé
Γöé Γöé Γöéprogress indicator. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéDISPLAY_DEFAULT ΓöéSets the default Γöé
Γöé Γöé Γöéprogress indicator Γöé
Γöé Γöé Γöédisplay setting. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéLogoDisplayTime ΓöéLOGO_INDEFINITE ΓöéDisplays the logo Γöé
Γöé Γöé Γöéindefinitely. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéLOGO_NONE ΓöéDoes not display theΓöé
Γöé Γöé Γöélogo. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé Γöétime ΓöéDisplays the logo Γöé
Γöé Γöé Γöéfor a given period Γöé
Γöé Γöé Γöéof time. This value Γöé
Γöé Γöé Γöémust be in the rangeΓöé
Γöé Γöé Γöé0 to 32767 Γöé
Γöé Γöé Γöémilliseconds. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéLOGO_DEFAULT ΓöéSets the default Γöé
Γöé Γöé Γöélogo display time. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéMinButtonAppearance ΓöéBUTTON_HIDE ΓöéSets views of this Γöé
Γöé Γöé Γöéobject to have a Γöé
Γöé Γöé Γöéhide button as Γöé
Γöé Γöé Γöéopposed to a Γöé
Γöé Γöé Γöéminimize button. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéBUTTON_MINIMIZE ΓöéSets views of this Γöé
Γöé Γöé Γöéobject to have a Γöé
Γöé Γöé Γöéminimize button as Γöé
Γöé Γöé Γöéopposed to a hide Γöé
Γöé Γöé Γöébutton. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéBUTTON_DEFAULT ΓöéSets the default Γöé
Γöé Γöé Γöéminimize button Γöé
Γöé Γöé Γöéappearance setting. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéMinButtonBehavior ΓöéMINWIN_HIDE ΓöéHides the view of anΓöé
Γöé Γöé Γöéobject when its Γöé
Γöé Γöé Γöéminimize button is Γöé
Γöé Γöé Γöéselected. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéMINWIN_VIEWER ΓöéMinimizes the view Γöé
Γöé Γöé Γöéof an object to the Γöé
Γöé Γöé Γöéminimized window Γöé
Γöé Γöé Γöéviewer when its Γöé
Γöé Γöé Γöéminimize button is Γöé
Γöé Γöé Γöéselected. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéMINWIN_DESKTOP ΓöéMinimizes the view Γöé
Γöé Γöé Γöéof an object to the Γöé
Γöé Γöé ΓöéDesktop when its Γöé
Γöé Γöé Γöéminimize button is Γöé
Γöé Γöé Γöéselected. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéMINWIN_DEFAULT ΓöéSets the default Γöé
Γöé Γöé Γöéminimize button Γöé
Γöé Γöé Γöébehavior setting. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéNameClash ΓöéNAMECLASH_PROMPT ΓöéDisplays a dialog Γöé
Γöé Γöé Γöéwhen an object is Γöé
Γöé Γöé Γöécreated, copied or Γöé
Γöé Γöé Γöémoved to a folder Γöé
Γöé Γöé Γöéwhich contains Γöé
Γöé Γöé Γöéanother object with Γöé
Γöé Γöé Γöéthe same name. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéNAMECLASH_RENAME ΓöéRenames an object Γöé
Γöé Γöé Γöéwhen it is created, Γöé
Γöé Γöé Γöécopied or moved to aΓöé
Γöé Γöé Γöéfolder which Γöé
Γöé Γöé Γöécontains another Γöé
Γöé Γöé Γöéobject with the sameΓöé
Γöé Γöé Γöéname. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéNAMECLASH_REPLACE ΓöéReplaces the Γöé
Γöé Γöé Γöéexisting object withΓöé
Γöé Γöé Γöéthe new object when Γöé
Γöé Γöé Γöéan object is Γöé
Γöé Γöé Γöécreated, copied or Γöé
Γöé Γöé Γöémoved to a folder Γöé
Γöé Γöé Γöéwhich contains Γöé
Γöé Γöé Γöéanother object with Γöé
Γöé Γöé Γöéthe same name. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéNAMECLASH_DEFAULT ΓöéSets the default Γöé
Γöé Γöé Γöésetting for handlingΓöé
Γöé Γöé Γöéname clashes. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéPrintScreen ΓöéPRINTSCREEN_ON ΓöéEnables printing Γöé
Γöé Γöé Γöéwhen the print Γöé
Γöé Γöé Γöéscreen key is Γöé
Γöé Γöé Γöépressed. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéPRINTSCREEN_OFF ΓöéDisables printing Γöé
Γöé Γöé Γöéwhen the print Γöé
Γöé Γöé Γöéscreen key is Γöé
Γöé Γöé Γöépressed. Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓöéPRINTSCREEN_DEFAULT ΓöéSets the default Γöé
Γöé Γöé Γöésetting when the Γöé
Γöé Γöé Γöéprint screen key is Γöé
Γöé Γöé Γöépressed. Γöé
ΓööΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö┤ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö┤ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÿ
ΓòÉΓòÉΓòÉ 3.48. WPTemplates ΓòÉΓòÉΓòÉ
Class definition file: wptemps.idl
Class hierarchy
SOMObject
WPObject
WPFileSystem
WPFolder
WPTemplates
Description
This is the template folder object class. This class of folder always contains
a template instance of every class of object that the user can create that
supports the "Create another" action.
A WPTemplates object is a normal folder in all respects other than the
following:
o It always contains a template for every class that supports them.
o The last template for each object class cannot be deleted from the
folder.
An instance of this class can be created as a Workplace object and is created
initially by the system. It has the title, "Templates" and resides on the
desktop. A template instance is also created for each data type defined in an
application's ASSOCTABLE resource.
Instance methods
There are currently no methods defined for the WPTemplates Workplace object
class.
WPFolder instance methods
The following list shows all the methods overridden by the WPTemplates class.
These methods are overridden in order to modify the behavior defined by an
ancestor class.
o wpPopulate
WPObject instance methods
The following list shows all the methods overridden by the WPTemplates class.
These methods are overridden in order to modify the behavior defined by an
ancestor class.
o wpSetup
Class methods
There are currently no class methods defined for the WPTemplates Workplace
class object.
WPObject class methods.
The following list shows all the class methods overridden by the WPTemplates
class. These methods are overridden to modify the behavior defined by an
ancestor class.
o wpclsQueryIconData
o wpclsQueryStyle
o wpclsQueryTitle
ΓòÉΓòÉΓòÉ 3.49. WPTransient ΓòÉΓòÉΓòÉ
Class definition file: wptrans.idl
Class hierarchy
SOMObject
WPObject
WPTransient
Description
This is the non-persistent object storage class. The WPTransient class is a
storage class with no storage medium. This means that instances of object
classes derived from WPTransient do not persist across reboots. This class is
available for applications which need to utilize a large amount of workplace
functionality (such as context menus and Settings notebooks) in their object
class without having to be a file, directory, or a record in the INI file. An
instance of this class can be created as a Workplace object. No instances of
this class are initially created by the system.
Instance methods
There are currently no methods defined for the WPTransient Workplace object
class.
WPObject instance methods
The following list shows all the methods overridden by the WPTransient class.
These methods are overridden in order to modify the behavior defined by an
ancestor class.
o wpCopyObject
o wpQueryHandle
o wpSaveDeferred
Class methods
There are currently no class methods defined for the WPTransient Workplace
class object.
WPObject class methods
The following list shows all the class methods overridden by the WPTransient
class. These methods are overridden to modify the behavior defined by an
ancestor class.
o wpclsQueryStyle
o wpclsQueryTitle
ΓòÉΓòÉΓòÉ 3.50. WPWinConfig ΓòÉΓòÉΓòÉ
Class definition file: wincfg.idl
Class hierarchy
SOMObject
WPObject
WPAbstract
WPWinConfig
Description This class is specific to version 3, or higher, of the OS/2
operating system.
This is the WIN-OS/2* configuration object class. This object stores and allows
the user to modify the default settings for WIN-OS/2 applications. It initially
resides in the system setup folder. An instance of this class can be created as
a Workplace object.
Instance methods
The following list shows all the WPWinConfig methods.
o wpAddDDEPage
o wpAddSessionPage
o wpAddSession31Page
WPObject instance methods
The following list shows all the methods overridden by the WPWinConfig class.
These methods are overridden in order to modify the behavior defined by an
ancestor class.
o wpAddObjectGeneralPage
o wpAddSettingsPages
o wpFilterPopupMenu
Class methods
There are currently no class methods defined for the WPWinConfig Workplace
class object.
WPObject class methods
The following list shows all the class methods overridden by the WPWinConfig
class. These methods are overridden to modify the behavior defined by an
ancestor class.
o wpclsQueryDefaultHelp
o wpclsQueryDefaultView
o wpclsQueryIconData
o wpclsQueryStyle
o wpclsQueryTitle
ΓòÉΓòÉΓòÉ 4. Workplace Class Methods ΓòÉΓòÉΓòÉ
This chapter contains an alphabetic listing of the Workplace class methods.
Class methods act on class data common to all instances of the class.
Metaclasses define all the class methods for a class. Metaclasses are,
therefore, the mechanisms for defining class properties as opposed to instance
properties. Workplace class methods are prefixed by wpcls. See the Workplace
Shell Programming Guide for guidance information on this subject.
ΓòÉΓòÉΓòÉ 4.1. wpclsCreateDefaultTemplates ΓòÉΓòÉΓòÉ
ΓòÉΓòÉΓòÉ <hidden> wpclsCreateDefaultTemplates - Syntax ΓòÉΓòÉΓòÉ
/*******************************************/
/* This method is called to allow the */
/* specified class to create default */
/* template instances of its class. */
/*******************************************/
#define INCL_WINWORKPLACE
#include <os2.h>
M_WPObject *somSelf; /* Pointer to the WPObject class object. */
WPFolder *Folder; /* Pointer to the folder in which to create the templates. */
BOOL rc; /* Flag indicating whether the class creates the templates. */
rc = _wpclsCreateDefaultTemplates(somSelf,
Folder);
ΓòÉΓòÉΓòÉ <hidden> wpclsCreateDefaultTemplates Parameter - somSelf ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
ΓòÉΓòÉΓòÉ <hidden> wpclsCreateDefaultTemplates Parameter - Folder ΓòÉΓòÉΓòÉ
Folder (WPFolder *) - input
Pointer to the folder in which to create the templates.
Points to an object of class WPFolder.
ΓòÉΓòÉΓòÉ <hidden> wpclsCreateDefaultTemplates Return Value - rc ΓòÉΓòÉΓòÉ
rc (BOOL) - returns
Flag indicating whether the class creates the templates.
Possible values are described in the following list:
TRUE
The class creates its own templates.
FALSE
The Templates folder creates the templates for the class.
ΓòÉΓòÉΓòÉ <hidden> wpclsCreateDefaultTemplates - Parameters ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
Folder (WPFolder *) - input
Pointer to the folder in which to create the templates.
Points to an object of class WPFolder.
rc (BOOL) - returns
Flag indicating whether the class creates the templates.
Possible values are described in the following list:
TRUE
The class creates its own templates.
FALSE
The Templates folder creates the templates for the class.
ΓòÉΓòÉΓòÉ <hidden> wpclsCreateDefaultTemplates - Usage ΓòÉΓòÉΓòÉ
This method is generally called only by the system when the class is
registered. A class is registered by a call to the WinRegisterObjectClass
function.
When the system calls this method, "Folder" is a pointer to the Templates
folder.
ΓòÉΓòÉΓòÉ <hidden> wpclsCreateDefaultTemplates - How to Override ΓòÉΓòÉΓòÉ
This method should be overridden by classes that need to create default
template instances of their class.
ΓòÉΓòÉΓòÉ <hidden> wpclsCreateDefaultTemplates - Topics ΓòÉΓòÉΓòÉ
Select an item:
Syntax
Parameters
Returns
How to Override
Usage
Glossary
ΓòÉΓòÉΓòÉ 4.2. wpclsDecUsage ΓòÉΓòÉΓòÉ
ΓòÉΓòÉΓòÉ <hidden> wpclsDecUsage - Syntax ΓòÉΓòÉΓòÉ
/*******************************************/
/* This method is specific to version 3, */
/* or higher, of the OS/2 operating */
/* system. This class method is called to */
/* decrement the class usage count. */
/*******************************************/
#define INCL_WINWORKPLACE
#include <os2.h>
M_WPObject *somSelf; /* Pointer to the WPObject class object. */
wpclsDecUsage(somSelf);
ΓòÉΓòÉΓòÉ <hidden> wpclsDecUsage Parameter - somSelf ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
ΓòÉΓòÉΓòÉ <hidden> wpclsDecUsage - Return Value ΓòÉΓòÉΓòÉ
There is no return value for this method.
ΓòÉΓòÉΓòÉ <hidden> wpclsDecUsage - Parameters ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
There is no return value for this method.
ΓòÉΓòÉΓòÉ <hidden> wpclsDecUsage - Remarks ΓòÉΓòÉΓòÉ
The class usage count is used by the system to dynamically load and unload DLLs
containing classes.
ΓòÉΓòÉΓòÉ <hidden> wpclsDecUsage - How to Override ΓòÉΓòÉΓòÉ
This method is generally not overridden.
ΓòÉΓòÉΓòÉ <hidden> wpclsDecUsage - Related Methods ΓòÉΓòÉΓòÉ
o wpclsIncUsage
ΓòÉΓòÉΓòÉ <hidden> wpclsDecUsage - Topics ΓòÉΓòÉΓòÉ
Select an item:
Syntax
Parameters
Returns
Remarks
How to Override
Related Methods
Glossary
ΓòÉΓòÉΓòÉ 4.3. wpclsFileSysExists ΓòÉΓòÉΓòÉ
ΓòÉΓòÉΓòÉ <hidden> wpclsFileSysExists - Syntax ΓòÉΓòÉΓòÉ
/*******************************************/
/* This method is specific to version 3, */
/* or higher, of the OS/2 operating */
/* system. This method returns the object */
/* if the specified file or directory */
/* already exists in the given folder. */
/*******************************************/
#define INCL_WINWORKPLACE
#include <os2.h>
M_WPFileSystem *somSelf; /* Pointer to the WPFileSystem class object. */
SOMAny *Folder; /* Pointer to folder in which to search for file or directory. */
PSZ pszFilename; /* Name of file or directory on which search is to be performed. */
ULONG attrFile; /* Flag specifying whether name to be searched is a file or directory. */
WPObject Object *; /* Pointer to the object found. */
Object * = _wpclsFileSysExists(somSelf, Folder,
pszFilename, attrFile);
ΓòÉΓòÉΓòÉ <hidden> wpclsFileSysExists Parameter - somSelf ΓòÉΓòÉΓòÉ
somSelf (M_WPFileSystem *) - input
Pointer to the WPFileSystem class object.
ΓòÉΓòÉΓòÉ <hidden> wpclsFileSysExists Parameter - Folder ΓòÉΓòÉΓòÉ
Folder (SOMAny *) - input
Pointer to folder in which to search for file or directory.
ΓòÉΓòÉΓòÉ <hidden> wpclsFileSysExists Parameter - pszFilename ΓòÉΓòÉΓòÉ
pszFilename (PSZ) - input
Name of file or directory on which search is to be performed.
ΓòÉΓòÉΓòÉ <hidden> wpclsFileSysExists Parameter - attrFile ΓòÉΓòÉΓòÉ
attrFile (ULONG) - input
Flag specifying whether name to be searched is a file or directory.
ΓòÉΓòÉΓòÉ <hidden> wpclsFileSysExists Return Value - Object * ΓòÉΓòÉΓòÉ
Object * (WPObject) - returns
Pointer to the object found.
A return value of NULL indicates that the object was not found.
ΓòÉΓòÉΓòÉ <hidden> wpclsFileSysExists - Parameters ΓòÉΓòÉΓòÉ
somSelf (M_WPFileSystem *) - input
Pointer to the WPFileSystem class object.
Folder (SOMAny *) - input
Pointer to folder in which to search for file or directory.
pszFilename (PSZ) - input
Name of file or directory on which search is to be performed.
attrFile (ULONG) - input
Flag specifying whether name to be searched is a file or directory.
Object * (WPObject) - returns
Pointer to the object found.
A return value of NULL indicates that the object was not found.
ΓòÉΓòÉΓòÉ <hidden> wpclsFileSysExists - Usage ΓòÉΓòÉΓòÉ
This method can be called at any time.
ΓòÉΓòÉΓòÉ <hidden> wpclsFileSysExists - How to Override ΓòÉΓòÉΓòÉ
This method is generally not overridden.
ΓòÉΓòÉΓòÉ <hidden> wpclsFileSysExists - Topics ΓòÉΓòÉΓòÉ
Select an item:
Syntax
Parameters
Returns
How to Override
Usage
Glossary
ΓòÉΓòÉΓòÉ 4.4. wpclsFindObjectEnd ΓòÉΓòÉΓòÉ
ΓòÉΓòÉΓòÉ <hidden> wpclsFindObjectEnd - Syntax ΓòÉΓòÉΓòÉ
/*******************************************/
/* This method is called to end the find */
/* operation started by a call to the */
/* wpclsFindObjectFirst method. */
/*******************************************/
#define INCL_WINWORKPLACE
#include <os2.h>
M_WPObject *somSelf; /* Pointer to the WPObject class object. */
HFIND hfind; /* Handle associated with a previous wpclsFindObjectFirst or wpclsFindObjectNext method call. */
BOOL rc; /* Success indicator. */
rc = _wpclsFindObjectEnd(somSelf, hfind);
ΓòÉΓòÉΓòÉ <hidden> wpclsFindObjectEnd Parameter - somSelf ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
ΓòÉΓòÉΓòÉ <hidden> wpclsFindObjectEnd Parameter - hfind ΓòÉΓòÉΓòÉ
hfind (HFIND) - input
Handle associated with a previous wpclsFindObjectFirst or
wpclsFindObjectNext method call.
ΓòÉΓòÉΓòÉ <hidden> wpclsFindObjectEnd Return Value - rc ΓòÉΓòÉΓòÉ
rc (BOOL) - returns
Success indicator.
TRUE Successful completion.
FALSE Error occurred.
ΓòÉΓòÉΓòÉ <hidden> wpclsFindObjectEnd - Parameters ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
hfind (HFIND) - input
Handle associated with a previous wpclsFindObjectFirst or
wpclsFindObjectNext method call.
rc (BOOL) - returns
Success indicator.
TRUE Successful completion.
FALSE Error occurred.
ΓòÉΓòÉΓòÉ <hidden> wpclsFindObjectEnd - Usage ΓòÉΓòÉΓòÉ
This method should be called to terminate a find operation that was started by
a previous call to the wpclsFindObjectFirst method.
ΓòÉΓòÉΓòÉ <hidden> wpclsFindObjectEnd - How to Override ΓòÉΓòÉΓòÉ
This method is generally not overridden.
ΓòÉΓòÉΓòÉ <hidden> wpclsFindObjectEnd - Related Methods ΓòÉΓòÉΓòÉ
o wpclsFindObjectEnd
o wpclsFindObjectFirst
o wpclsFindObjectNext
ΓòÉΓòÉΓòÉ <hidden> wpclsFindObjectEnd - Example Code ΓòÉΓòÉΓòÉ
This example finds all occurrences of an object type in a folder.
VOID clsFindEverybody(SOMAny *self)
{
BOOL rc; /* Return from methods */
HFIND hFind = 0; /* Handle for repeated finds */
CLASS Class[2]; /* List of classes to look for */
OBJECT Object[10]; /* Objects returned from search */
ULONG ulCount = 10; /* Count of objects to find / or found */
WPFolder *folder = 0; /* Pointer to folder for search */
ULONG errorid = 0; /* Error returned from previous search */
CHAR sz[CCHMAXPATH]; /* Title string to look for */
PSZ title = sz;
Class[0] = _WPFolder;
Class[1] = NULL;
/* Get the pointer to the desktop (since that is where we are looking) */
folder = _wpclsQueryFolder( _WPFolder, "<WP_DESKTOP>", TRUE );
_wpclsSetError( _WPObject, 0 ); /* Reset the error indicators */
rc = 0;
/* Attempt to find the first 10 objects matching our criteria */
ulCount = 10;
rc =_wpclsFindObjectFirst(_WPObject, /* Class self pointer */
Class, /* Pointer to array of class objects */
&hFind, /* Handle for wpclsFindObjectNext */
NULL, /* Find EVERYTHING */
folder, /* Pointer to folder of interest */
TRUE, /* Search all folders in tree */
NULL, /* No extended criteria */
Object, /* Array of object pointers */
&ulCount ); /* Number requested and number found */
errorid = _wpclsQueryError( _WPObject); /* Get errorid (may still be OK) */
if ((!rc && (errorid == WPERR_BUFFER_OVERFLOW)) || rc) {
/***** Process objects found here ******/
} else {
somPrintf(" _wpclsFindObjectFirst failed, errorid=%u\n", errorid );
return;
} /* endif */
do {
_wpclsSetError( _WPObject, 0 ); /* Reset error indicators */
rc = 0;
/* Look for next 10 objects */
rc =_wpclsFindObjectNext(_WPObject, /* Self */
hFind, /* Handle from previous Find */
Object, /* Objects found */
&ulCount ); /* Number to look for. On
return, number found */
errorid = _wpclsQueryError( _WPObject );
if ((!rc && (errorid == WPERR_BUFFER_OVERFLOW)) || rc) {
/***** Process objects found here ******/
} else {
somPrintf("_wpclsFindObjectNext failed, errorid=%u\n", errorid);
return;
} /* endif */
} while ( errorid == WPERR_BUFFER_OVERFLOW ); /* enddo */
_wpclsSetError( _WPObject, 0 ); /* Reset error indicators */
rc = 0;
/* Indicate find complete */
rc =_wpclsFindObjectEnd( _WPObject, hFind );
if (!rc) {
errorid = _wpclsQueryError( _WPObject );
somPrintf( "_wpclsFindObjectEnd failed, errorid=%u\n", errorid );
return;
}
return;
}
ΓòÉΓòÉΓòÉ <hidden> wpclsFindObjectEnd - Topics ΓòÉΓòÉΓòÉ
Select an item:
Syntax
Parameters
Returns
How to Override
Usage
Example Code
Related Methods
Glossary
ΓòÉΓòÉΓòÉ 4.5. wpclsFindObjectFirst ΓòÉΓòÉΓòÉ
ΓòÉΓòÉΓòÉ <hidden> wpclsFindObjectFirst - Syntax ΓòÉΓòÉΓòÉ
/*******************************************/
/* This method is called to find workplace */
/* objects. */
/*******************************************/
#define INCL_WINWORKPLACE
#include <os2.h>
M_WPObject *somSelf; /* Pointer to the WPObject class object. */
PCLASS pClasslist; /* Pointer to an array of class objects. */
PHFIND phFind; /* Address of the handle associated with this method. */
PSZ pszTitle; /* Pointer to the title specification for objects to be searched. */
WPFolder *Folder; /* Pointer to the folder in which to find objects. */
BOOL fSubfolders; /* Scope indicator. */
PVOID pExtendedCriteria; /* Pointer to extended search criteria. */
POBJECT pBuffer; /* Pointer to a buffer that contains an array of object pointers. */
PULONG pCount; /* Address of the number of matching entries requested in pBuffer. */
BOOL rc; /* Success indicator. */
rc = _wpclsFindObjectFirst(somSelf, pClasslist,
phFind, pszTitle, Folder, fSubfolders,
pExtendedCriteria, pBuffer, pCount);
ΓòÉΓòÉΓòÉ <hidden> wpclsFindObjectFirst Parameter - somSelf ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
ΓòÉΓòÉΓòÉ <hidden> wpclsFindObjectFirst Parameter - pClasslist ΓòÉΓòÉΓòÉ
pClasslist (PCLASS) - output
Pointer to an array of class objects.
The final element of the array should be NULL.
ΓòÉΓòÉΓòÉ <hidden> wpclsFindObjectFirst Parameter - phFind ΓòÉΓòÉΓòÉ
phFind (PHFIND) - output
Address of the handle associated with this method.
This handle is used with subsequent calls to wpclsFindObjectNext and
wpclsFindObjectEnd.
ΓòÉΓòÉΓòÉ <hidden> wpclsFindObjectFirst Parameter - pszTitle ΓòÉΓòÉΓòÉ
pszTitle (PSZ) - input
Pointer to the title specification for objects to be searched.
This title may include the wildcard characters "*" and "?".
ΓòÉΓòÉΓòÉ <hidden> wpclsFindObjectFirst Parameter - Folder ΓòÉΓòÉΓòÉ
Folder (WPFolder *) - input
Pointer to the folder in which to find objects.
This pointer can be determined by issuing a call to the wpclsQueryFolder
method.
ΓòÉΓòÉΓòÉ <hidden> wpclsFindObjectFirst Parameter - fSubfolders ΓòÉΓòÉΓòÉ
fSubfolders (BOOL) - input
Scope indicator.
TRUE
Search Folder and all folders in its tree.
FALSE
Search only the folder specified by Folder.
ΓòÉΓòÉΓòÉ <hidden> wpclsFindObjectFirst Parameter - pExtendedCriteria ΓòÉΓòÉΓòÉ
pExtendedCriteria (PVOID) - input
Pointer to extended search criteria.
Points to a buffer that contains the class-specific extended search
criteria.
If this parameter is specified, only the object of the specified classes
are returned. if this parameter is NULL, objects of all classes are
returned.
ΓòÉΓòÉΓòÉ <hidden> wpclsFindObjectFirst Parameter - pBuffer ΓòÉΓòÉΓòÉ
pBuffer (POBJECT) - output
Pointer to a buffer that contains an array of object pointers.
The size of this buffer must be large enough to hold the number of
requested entries specified by pCount.
ΓòÉΓòÉΓòÉ <hidden> wpclsFindObjectFirst Parameter - pCount ΓòÉΓòÉΓòÉ
pCount (PULONG) - in/out
Address of the number of matching entries requested in pBuffer.
On return, this field contains the number of entries placed into pBuffer.
ΓòÉΓòÉΓòÉ <hidden> wpclsFindObjectFirst Return Value - rc ΓòÉΓòÉΓòÉ
rc (BOOL) - returns
Success indicator.
TRUE Successful completion.
FALSE Error occurred.
FALSE can indicate:
WPERR_OBJECT_NOT_FOUND
WPERR_BUFFER_OVERFLOW
ΓòÉΓòÉΓòÉ <hidden> wpclsFindObjectFirst - Parameters ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
pClasslist (PCLASS) - output
Pointer to an array of class objects.
The final element of the array should be NULL.
phFind (PHFIND) - output
Address of the handle associated with this method.
This handle is used with subsequent calls to wpclsFindObjectNext and
wpclsFindObjectEnd.
pszTitle (PSZ) - input
Pointer to the title specification for objects to be searched.
This title may include the wildcard characters "*" and "?".
Folder (WPFolder *) - input
Pointer to the folder in which to find objects.
This pointer can be determined by issuing a call to the wpclsQueryFolder
method.
fSubfolders (BOOL) - input
Scope indicator.
TRUE
Search Folder and all folders in its tree.
FALSE
Search only the folder specified by Folder.
pExtendedCriteria (PVOID) - input
Pointer to extended search criteria.
Points to a buffer that contains the class-specific extended search
criteria.
If this parameter is specified, only the object of the specified classes
are returned. if this parameter is NULL, objects of all classes are
returned.
pBuffer (POBJECT) - output
Pointer to a buffer that contains an array of object pointers.
The size of this buffer must be large enough to hold the number of
requested entries specified by pCount.
pCount (PULONG) - in/out
Address of the number of matching entries requested in pBuffer.
On return, this field contains the number of entries placed into pBuffer.
rc (BOOL) - returns
Success indicator.
TRUE Successful completion.
FALSE Error occurred.
FALSE can indicate:
WPERR_OBJECT_NOT_FOUND
WPERR_BUFFER_OVERFLOW
ΓòÉΓòÉΓòÉ <hidden> wpclsFindObjectFirst - Remarks ΓòÉΓòÉΓòÉ
This method returns object pointers (up to the number requested in pCount) for
as many objects that match the specifications and that fit in pBuffer. On
output, pCount contains the actual number of object pointers returned.
wpclsFindObjectNext uses the find object handle associated with
wpclsFindObjectFirst to continue the search started by the wpclsFindObjectFirst
request.
If wpclsFindObjectFirst returns FALSE, the wpQueryError method can be called to
retrieve the error code. Error codes include:
WPERR_OBJECT_NOT_FOUND
No objects matching the specified criteria were found.
WPERR_BUFFER_OVERFLOW
The pBuffer was not large enough to fit all objects matching the specified
criteria. The wpclsFindObjectNext method should be called to retrieve the
rest of the objects matching the specified criteria.
The wpclsFindObjectEnd method should be called to terminate the find
operation.
ΓòÉΓòÉΓòÉ <hidden> wpclsFindObjectFirst - Usage ΓòÉΓòÉΓòÉ
This method can be called at any time in order to find objects.
ΓòÉΓòÉΓòÉ <hidden> wpclsFindObjectFirst - How to Override ΓòÉΓòÉΓòÉ
This method is generally not overridden.
ΓòÉΓòÉΓòÉ <hidden> wpclsFindObjectFirst - Related Methods ΓòÉΓòÉΓòÉ
o wpclsFindObjectEnd
o wpclsFindObjectFirst
o wpclsFindObjectNext
ΓòÉΓòÉΓòÉ <hidden> wpclsFindObjectFirst - Example Code ΓòÉΓòÉΓòÉ
This example finds all occurrences of an object type in a folder.
VOID clsFindEverybody(SOMAny *self)
{
BOOL rc; /* Return from methods */
HFIND hFind = 0; /* Handle for repeated finds */
CLASS Class[2]; /* List of classes to look for */
OBJECT Object[10]; /* Objects returned from search */
ULONG ulCount = 10; /* Count of objects to find / or found */
WPFolder *folder = 0; /* Pointer to folder for search */
ULONG errorid = 0; /* Error returned from previous search */
CHAR sz[CCHMAXPATH]; /* Title string to look for */
PSZ title = sz;
Class[0] = _WPFolder;
Class[1] = NULL;
/* Get the pointer to the desktop (since that is where we are looking) */
folder = _wpclsQueryFolder( _WPFolder, "<WP_DESKTOP>", TRUE );
_wpclsSetError( _WPObject, 0 ); /* Reset the error indicators */
rc = 0;
/* Attempt to find the first 10 objects matching our criteria */
ulCount = 10;
rc =_wpclsFindObjectFirst(_WPObject, /* Class self pointer */
Class, /* Pointer to array of class objects */
&hFind, /* Handle for wpclsFindObjectNext */
NULL, /* Find EVERYTHING */
folder, /* Pointer to folder of interest */
TRUE, /* Search all folders in tree */
NULL, /* No extended criteria */
Object, /* Array of object pointers */
&ulCount ); /* Number requested and number found */
errorid = _wpclsQueryError( _WPObject); /* Get errorid (may still be OK) */
if ((!rc && (errorid == WPERR_BUFFER_OVERFLOW)) || rc) {
/***** Process objects found here ******/
} else {
somPrintf(" _wpclsFindObjectFirst failed, errorid=%u\n", errorid );
return;
} /* endif */
do {
_wpclsSetError( _WPObject, 0 ); /* Reset error indicators */
rc = 0;
/* Look for next 10 objects */
rc =_wpclsFindObjectNext(_WPObject, /* Self */
hFind, /* Handle from previous Find */
Object, /* Objects found */
&ulCount ); /* Number to look for. On
return, number found */
errorid = _wpclsQueryError( _WPObject );
if ((!rc && (errorid == WPERR_BUFFER_OVERFLOW)) || rc) {
/***** Process objects found here ******/
} else {
somPrintf("_wpclsFindObjectNext failed, errorid=%u\n", errorid);
return;
} /* endif */
} while ( errorid == WPERR_BUFFER_OVERFLOW ); /* enddo */
_wpclsSetError( _WPObject, 0 ); /* Reset error indicators */
rc = 0;
/* Indicate find complete */
rc =_wpclsFindObjectEnd( _WPObject, hFind );
if (!rc) {
errorid = _wpclsQueryError( _WPObject );
somPrintf( "_wpclsFindObjectEnd failed, errorid=%u\n", errorid );
return;
}
return;
}
ΓòÉΓòÉΓòÉ <hidden> wpclsFindObjectFirst - Topics ΓòÉΓòÉΓòÉ
Select an item:
Syntax
Parameters
Returns
Remarks
How to Override
Usage
Example Code
Related Methods
Glossary
ΓòÉΓòÉΓòÉ 4.6. wpclsFindObjectNext ΓòÉΓòÉΓòÉ
ΓòÉΓòÉΓòÉ <hidden> wpclsFindObjectNext - Syntax ΓòÉΓòÉΓòÉ
/*******************************************/
/* This method is called to find the next */
/* set of matching objects. */
/*******************************************/
#define INCL_WINWORKPLACE
#include <os2.h>
M_WPObject *somSelf; /* Pointer to the WPObject class object. */
HFIND hfind; /* Handle associated with a previous wpclsFindObjectFirst or wpclsFindObjectNext method call. */
POBJECT pBuffer; /* Pointer to a buffer that contains an array of object pointers. */
PULONG pCount; /* Address of the number of matching entries requested in pBuffer. */
BOOL rc; /* Success indicator. */
rc = _wpclsFindObjectNext(somSelf, hfind,
pBuffer, pCount);
ΓòÉΓòÉΓòÉ <hidden> wpclsFindObjectNext Parameter - somSelf ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
ΓòÉΓòÉΓòÉ <hidden> wpclsFindObjectNext Parameter - hfind ΓòÉΓòÉΓòÉ
hfind (HFIND) - input
Handle associated with a previous wpclsFindObjectFirst or
wpclsFindObjectNext method call.
ΓòÉΓòÉΓòÉ <hidden> wpclsFindObjectNext Parameter - pBuffer ΓòÉΓòÉΓòÉ
pBuffer (POBJECT) - output
Pointer to a buffer that contains an array of object pointers.
The size of this buffer must be large enough to hold the number of
requested entries specified by pulCount.
ΓòÉΓòÉΓòÉ <hidden> wpclsFindObjectNext Parameter - pCount ΓòÉΓòÉΓòÉ
pCount (PULONG) - in/out
Address of the number of matching entries requested in pBuffer.
On return, this field contains the number of entries placed into pBuffer.
ΓòÉΓòÉΓòÉ <hidden> wpclsFindObjectNext Return Value - rc ΓòÉΓòÉΓòÉ
rc (BOOL) - returns
Success indicator.
TRUE Successful completion.
FALSE Error occurred.
FALSE can indicate:
WPERR_OBJECT_NOT_FOUND
WPERR_BUFFER_OVERFLOW
ΓòÉΓòÉΓòÉ <hidden> wpclsFindObjectNext - Parameters ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
hfind (HFIND) - input
Handle associated with a previous wpclsFindObjectFirst or
wpclsFindObjectNext method call.
pBuffer (POBJECT) - output
Pointer to a buffer that contains an array of object pointers.
The size of this buffer must be large enough to hold the number of
requested entries specified by pulCount.
pCount (PULONG) - in/out
Address of the number of matching entries requested in pBuffer.
On return, this field contains the number of entries placed into pBuffer.
rc (BOOL) - returns
Success indicator.
TRUE Successful completion.
FALSE Error occurred.
FALSE can indicate:
WPERR_OBJECT_NOT_FOUND
WPERR_BUFFER_OVERFLOW
ΓòÉΓòÉΓòÉ <hidden> wpclsFindObjectNext - Remarks ΓòÉΓòÉΓòÉ
wpclsFindObjectNext returns object pointers (up to the number requested in
pulCount) for as many objects that match the specifications and that fit in
pBuffer. On output, pulCount contains the actual number of object pointers
returned.
wpclsFindObjectNext uses the find object handle associated with
wpclsFindObjectFirst to continue the search started by the wpclsFindObjectFirst
request.
If wpclsFindObjectNext returns FALSE, the wpQueryError method can be called to
retrieve the error code. Error codes include:
WPERR_OBJECT_NOT_FOUND
No objects matching the specified criteria were found.
WPERR_BUFFER_OVERFLOW
The pBuffer buffer was not large enough to fit all objects matching the
specified criteria. The wpclsFindObjectNext method should be called to
retrieve the rest of the objects matching the specified criteria.
The wpclsFindObjectEnd method should be called to terminate the find
operation.
ΓòÉΓòÉΓòÉ <hidden> wpclsFindObjectNext - Usage ΓòÉΓòÉΓòÉ
This method can be called at any time in order to find the next set of matching
objects. This method should be called only after a previous call to the
wpclsFindObjectFirst method returned an error of WPERR_BUFFER_OVERFLOW.
ΓòÉΓòÉΓòÉ <hidden> wpclsFindObjectNext - How to Override ΓòÉΓòÉΓòÉ
This method is generally not overridden.
ΓòÉΓòÉΓòÉ <hidden> wpclsFindObjectNext - Related Methods ΓòÉΓòÉΓòÉ
o wpclsFindObjectEnd
o wpclsFindObjectFirst
o wpclsFindObjectNext
ΓòÉΓòÉΓòÉ <hidden> wpclsFindObjectNext - Example Code ΓòÉΓòÉΓòÉ
This example finds all occurrences of an object type in a folder.
VOID clsFindEverybody(SOMAny *self)
{
BOOL rc; /* Return from methods */
HFIND hFind = 0; /* Handle for repeated finds */
CLASS Class[2]; /* List of classes to look for */
OBJECT Object[10]; /* Objects returned from search */
ULONG ulCount = 10; /* Count of objects to find / or found */
WPFolder *folder = 0; /* Pointer to folder for search */
ULONG errorid = 0; /* Error returned from previous search */
CHAR sz[CCHMAXPATH]; /* Title string to look for */
PSZ title = sz;
Class[0] = _WPFolder;
Class[1] = NULL;
/* Get the pointer to the desktop (since that is where we are looking) */
folder = _wpclsQueryFolder( _WPFolder, "<WP_DESKTOP>", TRUE );
_wpclsSetError( _WPObject, 0 ); /* Reset the error indicators */
rc = 0;
/* Attempt to find the first 10 objects matching our criteria */
ulCount = 10;
rc =_wpclsFindObjectFirst(_WPObject, /* Class self pointer */
Class, /* Pointer to array of class objects */
&hFind, /* Handle for wpclsFindObjectNext */
NULL, /* Find EVERYTHING */
folder, /* Pointer to folder of interest */
TRUE, /* Search all folders in tree */
NULL, /* No extended criteria */
Object, /* Array of object pointers */
&ulCount ); /* Number requested and number found */
errorid = _wpclsQueryError( _WPObject); /* Get errorid (may still be OK) */
if ((!rc && (errorid == WPERR_BUFFER_OVERFLOW)) || rc) {
/***** Process objects found here ******/
} else {
somPrintf(" _wpclsFindObjectFirst failed, errorid=%u\n", errorid );
return;
} /* endif */
do {
_wpclsSetError( _WPObject, 0 ); /* Reset error indicators */
rc = 0;
/* Look for next 10 objects */
rc =_wpclsFindObjectNext(_WPObject, /* Self */
hFind, /* Handle from previous Find */
Object, /* Objects found */
&ulCount ); /* Number to look for. On
return, number found */
errorid = _wpclsQueryError( _WPObject );
if ((!rc && (errorid == WPERR_BUFFER_OVERFLOW)) || rc) {
/***** Process objects found here ******/
} else {
somPrintf("_wpclsFindObjectNext failed, errorid=%u\n", errorid);
return;
} /* endif */
} while ( errorid == WPERR_BUFFER_OVERFLOW ); /* enddo */
_wpclsSetError( _WPObject, 0 ); /* Reset error indicators */
rc = 0;
/* Indicate find complete */
rc =_wpclsFindObjectEnd( _WPObject, hFind );
if (!rc) {
errorid = _wpclsQueryError( _WPObject );
somPrintf( "_wpclsFindObjectEnd failed, errorid=%u\n", errorid );
return;
}
return;
}
ΓòÉΓòÉΓòÉ <hidden> wpclsFindObjectNext - Topics ΓòÉΓòÉΓòÉ
Select an item:
Syntax
Parameters
Returns
Remarks
How to Override
Usage
Example Code
Related Methods
Glossary
ΓòÉΓòÉΓòÉ 4.7. wpclsFindOneObject ΓòÉΓòÉΓòÉ
ΓòÉΓòÉΓòÉ <hidden> wpclsFindOneObject - Syntax ΓòÉΓòÉΓòÉ
/*******************************************/
/* This method is specific to version 3, */
/* or higher, of the OS/2 operating */
/* system. This method is used by find */
/* pushbuttons to find an object matching */
/* a predefined set of properties. */
/*******************************************/
#define INCL_WINWORKPLACE
#include <os2.h>
M_WPObject *somSelf; /* Pointer to the WPObject class object. */
HWND hwndOwner; /* Handle of the owner window for the dialogs. */
PSZ pszFindParams; /* Setup string which defines the properties of an object. */
WPObject *Object; /* Pointer to the found object. */
Object = _wpclsFindOneObject(somSelf, hwndOwner,
pszFindParams);
ΓòÉΓòÉΓòÉ <hidden> wpclsFindOneObject Parameter - somSelf ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
ΓòÉΓòÉΓòÉ <hidden> wpclsFindOneObject Parameter - hwndOwner ΓòÉΓòÉΓòÉ
hwndOwner (HWND) - input
Handle of the owner window for the dialogs.
ΓòÉΓòÉΓòÉ <hidden> wpclsFindOneObject Parameter - pszFindParams ΓòÉΓòÉΓòÉ
pszFindParams (PSZ) - input
Setup string which defines the properties of an object.
ΓòÉΓòÉΓòÉ <hidden> wpclsFindOneObject Return Value - Object ΓòÉΓòÉΓòÉ
Object (WPObject *) - returns
Pointer to the found object.
ΓòÉΓòÉΓòÉ <hidden> wpclsFindOneObject - Parameters ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
hwndOwner (HWND) - input
Handle of the owner window for the dialogs.
pszFindParams (PSZ) - input
Setup string which defines the properties of an object.
Object (WPObject *) - returns
Pointer to the found object.
ΓòÉΓòÉΓòÉ <hidden> wpclsFindOneObject - Usage ΓòÉΓòÉΓòÉ
This method can be called at any time.
ΓòÉΓòÉΓòÉ <hidden> wpclsFindOneObject - How to Override ΓòÉΓòÉΓòÉ
This method is generally not overridden.
ΓòÉΓòÉΓòÉ <hidden> wpclsFindOneObject - Related Methods ΓòÉΓòÉΓòÉ
o wpclsFindObjectEnd
o wpclsFindObjectFirst
o wpclsFindObjectNext
ΓòÉΓòÉΓòÉ <hidden> wpclsFindOneObject - Topics ΓòÉΓòÉΓòÉ
Select an item:
Syntax
Parameters
Returns
How to Override
Usage
Related Methods
Glossary
ΓòÉΓòÉΓòÉ 4.8. wpclsIncUsage ΓòÉΓòÉΓòÉ
ΓòÉΓòÉΓòÉ <hidden> wpclsIncUsage - Syntax ΓòÉΓòÉΓòÉ
/*******************************************/
/* This method is specific to version 3, */
/* or higher, of the OS/2 operating */
/* system. This class method is called to */
/* increment the class usage count. */
/*******************************************/
#define INCL_WINWORKPLACE
#include <os2.h>
M_WPObject *somSelf; /* Pointer to the WPObject class object. */
wpclsIncUsage(somSelf);
ΓòÉΓòÉΓòÉ <hidden> wpclsIncUsage Parameter - somSelf ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
ΓòÉΓòÉΓòÉ <hidden> wpclsIncUsage - Return Value ΓòÉΓòÉΓòÉ
There is no return value for this method.
ΓòÉΓòÉΓòÉ <hidden> wpclsIncUsage - Parameters ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
There is no return value for this method.
ΓòÉΓòÉΓòÉ <hidden> wpclsIncUsage - Remarks ΓòÉΓòÉΓòÉ
The class usage count is used by the system to dynamically load and unload DLLs
containing classes.
ΓòÉΓòÉΓòÉ <hidden> wpclsIncUsage - How to Override ΓòÉΓòÉΓòÉ
This method should not be overridden.
ΓòÉΓòÉΓòÉ <hidden> wpclsIncUsage - Related Methods ΓòÉΓòÉΓòÉ
o wpclsDecUsage
ΓòÉΓòÉΓòÉ <hidden> wpclsIncUsage - Topics ΓòÉΓòÉΓòÉ
Select an item:
Syntax
Parameters
Returns
Remarks
How to Override
Related Methods
Glossary
ΓòÉΓòÉΓòÉ 4.9. wpclsInitData ΓòÉΓòÉΓòÉ
ΓòÉΓòÉΓòÉ <hidden> wpclsInitData - Syntax ΓòÉΓòÉΓòÉ
/*******************************************/
/* This method is called to allow the */
/* class object to initialize its instance */
/* data. */
/*******************************************/
#define INCL_WINWORKPLACE
#include <os2.h>
M_WPObject *somSelf; /* Pointer to the WPObject class object. */
wpclsInitData(somSelf);
ΓòÉΓòÉΓòÉ <hidden> wpclsInitData Parameter - somSelf ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
ΓòÉΓòÉΓòÉ <hidden> wpclsInitData - Return Value ΓòÉΓòÉΓòÉ
There is no return value for this method.
ΓòÉΓòÉΓòÉ <hidden> wpclsInitData - Parameters ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
There is no return value for this method.
ΓòÉΓòÉΓòÉ <hidden> wpclsInitData - Remarks ΓòÉΓòÉΓòÉ
This method is called immediately after the class object is first awakened.
When the class object is made dormant, the wpclsUnInitData method is called to
give the class object the opportunity to deallocate resources allocated during
the processing of wpclsInitData.
ΓòÉΓòÉΓòÉ <hidden> wpclsInitData - Usage ΓòÉΓòÉΓòÉ
This method is generally called only by the system when the class object is
awakened. The class object is awakened when the first instance of this class is
either awakened or newly created. It is made dormant again when the last
instance of this class is made dormant.
ΓòÉΓòÉΓòÉ <hidden> wpclsInitData - How to Override ΓòÉΓòÉΓòÉ
Any class that has metaclass instance variables should override this method so
that those variables are all initially in a known state. It is essential to
pass this method onto the parent class object before performing any override
processing.
ΓòÉΓòÉΓòÉ <hidden> wpclsInitData - Related Methods ΓòÉΓòÉΓòÉ
o wpclsUnInitData
ΓòÉΓòÉΓòÉ <hidden> wpclsInitData - Example Code ΓòÉΓòÉΓòÉ
This coding example uses wpclsInitData to initialize class data associated with
MyDataBase.
SOM_Scope void SOMLINK MyDataBaseM_wpclsInitData(M_MyDataBase *somSelf)
{
/* M_MyDataBaseData *somThis = M_MyDataBaseGetData(somSelf); */
M_MyDataBaseMethodDebug("M_MyDataBase","MyDataBaseM_wpclsInitData");
hModule = _clsQueryModuleHandle( somSelf );
_hIcon = WinLoadPointer ( HWND_DESKTOP, hModule, ID_WINDOW );
parent_wpclsInitData(somSelf);
}
ΓòÉΓòÉΓòÉ <hidden> wpclsInitData - Topics ΓòÉΓòÉΓòÉ
Select an item:
Syntax
Parameters
Returns
Remarks
How to Override
Usage
Example Code
Related Methods
Glossary
ΓòÉΓòÉΓòÉ 4.10. wpclsInsertMultipleObjects ΓòÉΓòÉΓòÉ
ΓòÉΓòÉΓòÉ <hidden> wpclsInsertMultipleObjects - Syntax ΓòÉΓòÉΓòÉ
/*******************************************/
/* This method is specific to version 3, */
/* or higher, of the OS/2 operating */
/* system. This method inserts multiple */
/* objects into a container at one time. */
/*******************************************/
#define INCL_WINWORKPLACE
#include <os2.h>
M_WPObject *somSelf; /* Pointer to the WPObject class object. */
HWND hwndCnr; /* Handle to the container window in which objects are to be inserted. */
PPOINTL pptlIcon; /* Pointer to the initial icon position of the first icon inserted. */
PVOID *pObjectArray; /* Pointer to an array of object pointers. */
PVOID pRecordParent; /* Pointer to the parent record. */
ULONG NumRecords; /* Number of records in pObjectArray to be inserted. */
BOOL rc; /* Success indicator. */
rc = _wpclsInsertMultipleObjects(somSelf,
hwndCnr, pptlIcon, pObjectArray, pRecordParent,
NumRecords);
ΓòÉΓòÉΓòÉ <hidden> wpclsInsertMultipleObjects Parameter - somSelf ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
ΓòÉΓòÉΓòÉ <hidden> wpclsInsertMultipleObjects Parameter - hwndCnr ΓòÉΓòÉΓòÉ
hwndCnr (HWND) - input
Handle to the container window in which objects are to be inserted.
ΓòÉΓòÉΓòÉ <hidden> wpclsInsertMultipleObjects Parameter - pptlIcon ΓòÉΓòÉΓòÉ
pptlIcon (PPOINTL) - input
Pointer to the initial icon position of the first icon inserted.
ΓòÉΓòÉΓòÉ <hidden> wpclsInsertMultipleObjects Parameter - pObjectArray ΓòÉΓòÉΓòÉ
pObjectArray (PVOID *) - input
Pointer to an array of object pointers.
The objects in this array are to be inserted into the container.
ΓòÉΓòÉΓòÉ <hidden> wpclsInsertMultipleObjects Parameter - pRecordParent ΓòÉΓòÉΓòÉ
pRecordParent (PVOID) - input
Pointer to the parent record.
This parameter should be set to NULL if the records being inserted will not
have a parent or tree view is not supported.
ΓòÉΓòÉΓòÉ <hidden> wpclsInsertMultipleObjects Parameter - NumRecords ΓòÉΓòÉΓòÉ
NumRecords (ULONG) - input
Number of records in pObjectArray to be inserted.
This parameter must be greater than 0.
ΓòÉΓòÉΓòÉ <hidden> wpclsInsertMultipleObjects Return Value - rc ΓòÉΓòÉΓòÉ
rc (BOOL) - returns
Success indicator.
TRUE
Successful completion.
FALSE
Errors occurred.
ΓòÉΓòÉΓòÉ <hidden> wpclsInsertMultipleObjects - Parameters ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
hwndCnr (HWND) - input
Handle to the container window in which objects are to be inserted.
pptlIcon (PPOINTL) - input
Pointer to the initial icon position of the first icon inserted.
pObjectArray (PVOID *) - input
Pointer to an array of object pointers.
The objects in this array are to be inserted into the container.
pRecordParent (PVOID) - input
Pointer to the parent record.
This parameter should be set to NULL if the records being inserted will not
have a parent or tree view is not supported.
NumRecords (ULONG) - input
Number of records in pObjectArray to be inserted.
This parameter must be greater than 0.
rc (BOOL) - returns
Success indicator.
TRUE
Successful completion.
FALSE
Errors occurred.
ΓòÉΓòÉΓòÉ <hidden> wpclsInsertMultipleObjects - Remarks ΓòÉΓòÉΓòÉ
This method provides rapid insertion of multiple objects into a container at
once. wpCnrInsertObject performs the same function as this method, but operates
only on one object at a time.
This method adds each object to the in-use list.
ΓòÉΓòÉΓòÉ <hidden> wpclsInsertMultipleObjects - Usage ΓòÉΓòÉΓòÉ
This method can be called at any time to add multiple objects to a container.
ΓòÉΓòÉΓòÉ <hidden> wpclsInsertMultipleObjects - How to Override ΓòÉΓòÉΓòÉ
This method is generally not overridden.
ΓòÉΓòÉΓòÉ <hidden> wpclsInsertMultipleObjects - Related Methods ΓòÉΓòÉΓòÉ
o wpCnrRemoveObject
o wpCnrInsertObject
o wpclsRemoveObjects
ΓòÉΓòÉΓòÉ <hidden> wpclsInsertMultipleObjects - Topics ΓòÉΓòÉΓòÉ
Select an item:
Syntax
Parameters
Returns
Remarks
How to Override
Usage
Related Methods
Glossary
ΓòÉΓòÉΓòÉ 4.11. wpclsMakeAwake ΓòÉΓòÉΓòÉ
ΓòÉΓòÉΓòÉ <hidden> wpclsMakeAwake - Syntax ΓòÉΓòÉΓòÉ
/*******************************************/
/* This method is called to allow the */
/* specified class to awaken an object. */
/*******************************************/
#define INCL_WINWORKPLACE
#include <os2.h>
M_WPObject *somSelf; /* Pointer to the WPObject class object. */
PSZ pTitle; /* Pointer to the object title. */
ULONG ulStyle; /* Object style flags to set on the object. */
HPOINTER hptrIcon; /* Icon to set on the object. */
POBJDATA pObjData; /* Pointer to the object data. */
WPFolder *Folder; /* Pointer to a Folder object. */
ULONG ulUser; /* Base class-defined value. */
WPObject *Success; /* Success indicator. */
Success = _wpclsMakeAwake(somSelf, pTitle,
ulStyle, hptrIcon, pObjData, Folder,
ulUser);
ΓòÉΓòÉΓòÉ <hidden> wpclsMakeAwake Parameter - somSelf ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
ΓòÉΓòÉΓòÉ <hidden> wpclsMakeAwake Parameter - pTitle ΓòÉΓòÉΓòÉ
pTitle (PSZ) - input
Pointer to the object title.
A pointer to a string containing a title to set on the object. If this
value is NULL, the class default value is used.
ΓòÉΓòÉΓòÉ <hidden> wpclsMakeAwake Parameter - ulStyle ΓòÉΓòÉΓòÉ
ulStyle (ULONG) - input
Object style flags to set on the object.
If this value is NULL, the current or default value is used.
Predefined object style bits are as follows:
OBJSTYLE_CUSTOMICON
Destroy the icon when the object goes to sleep.
OBJSTYLE_NOCOPY
Do not allow copy on the object.
OBJSTYLE_NODELETE
Do not allow delete on the object.
OBJSTYLE_NODDRAG
Do not allow drag of this object.
OBJSTYLE_NODDROPON
Do not allow dropping on this object.
OBJSTYLE_NOLINK
Do not allow linking on the object.
OBJSTYLE_NOMOVE
Do not allow moving on the object.
OBJSTYLE_NOPRINT
Do not allow printting of this object.
OBJSTYLE_NORENAME
Do not allow renaming of the object.
OBJSTYLE_NOTVISIBLE
Make this object hidden.
OBJSTYLE_NODSETTINGS
Do not allow setting of this object.
OBJSTYLE_TEMPLATE
This object is a template.
ΓòÉΓòÉΓòÉ <hidden> wpclsMakeAwake Parameter - hptrIcon ΓòÉΓòÉΓòÉ
hptrIcon (HPOINTER) - input
Icon to set on the object.
If this value is NULL, the class default value is used.
ΓòÉΓòÉΓòÉ <hidden> wpclsMakeAwake Parameter - pObjData ΓòÉΓòÉΓòÉ
pObjData (POBJDATA) - input
Pointer to the object data.
If this value is NULL, the class default value is used.
ΓòÉΓòÉΓòÉ <hidden> wpclsMakeAwake Parameter - Folder ΓòÉΓòÉΓòÉ
Folder (WPFolder *) - input
Pointer to a Folder object.
A pointer to a Folder object that contains the new object. This pointer can
be determined by issuing a call to the wpclsQueryFolder method.
ΓòÉΓòÉΓòÉ <hidden> wpclsMakeAwake Parameter - ulUser ΓòÉΓòÉΓòÉ
ulUser (ULONG) - input
Base class-defined value.
This value is defined by the user and used by the base storage class.
ΓòÉΓòÉΓòÉ <hidden> wpclsMakeAwake Return Value - Success ΓòÉΓòÉΓòÉ
Success (WPObject *) - returns
Success indicator.
NULL Error occurred
Other Pointer to the awakened object.
ΓòÉΓòÉΓòÉ <hidden> wpclsMakeAwake - Parameters ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
pTitle (PSZ) - input
Pointer to the object title.
A pointer to a string containing a title to set on the object. If this
value is NULL, the class default value is used.
ulStyle (ULONG) - input
Object style flags to set on the object.
If this value is NULL, the current or default value is used.
Predefined object style bits are as follows:
OBJSTYLE_CUSTOMICON
Destroy the icon when the object goes to sleep.
OBJSTYLE_NOCOPY
Do not allow copy on the object.
OBJSTYLE_NODELETE
Do not allow delete on the object.
OBJSTYLE_NODDRAG
Do not allow drag of this object.
OBJSTYLE_NODDROPON
Do not allow dropping on this object.
OBJSTYLE_NOLINK
Do not allow linking on the object.
OBJSTYLE_NOMOVE
Do not allow moving on the object.
OBJSTYLE_NOPRINT
Do not allow printting of this object.
OBJSTYLE_NORENAME
Do not allow renaming of the object.
OBJSTYLE_NOTVISIBLE
Make this object hidden.
OBJSTYLE_NODSETTINGS
Do not allow setting of this object.
OBJSTYLE_TEMPLATE
This object is a template.
hptrIcon (HPOINTER) - input
Icon to set on the object.
If this value is NULL, the class default value is used.
pObjData (POBJDATA) - input
Pointer to the object data.
If this value is NULL, the class default value is used.
Folder (WPFolder *) - input
Pointer to a Folder object.
A pointer to a Folder object that contains the new object. This pointer can
be determined by issuing a call to the wpclsQueryFolder method.
ulUser (ULONG) - input
Base class-defined value.
This value is defined by the user and used by the base storage class.
Success (WPObject *) - returns
Success indicator.
NULL Error occurred
Other Pointer to the awakened object.
ΓòÉΓòÉΓòÉ <hidden> wpclsMakeAwake - Remarks ΓòÉΓòÉΓòÉ
An object is made awake when it is created in an open folder or when a folder
containing the object is opened. An object awakened by the wpclsMakeAwake class
method is automatically locked. The wpUnlockObject method can be called to
allow the object to return to its dormant state.
ΓòÉΓòÉΓòÉ <hidden> wpclsMakeAwake - Usage ΓòÉΓòÉΓòÉ
This method is generally called only by base storage classes in order to awaken
an object from the dormant state.
ΓòÉΓòÉΓòÉ <hidden> wpclsMakeAwake - How to Override ΓòÉΓòÉΓòÉ
This method is generally not overridden.
ΓòÉΓòÉΓòÉ <hidden> wpclsMakeAwake - Related Methods ΓòÉΓòÉΓòÉ
o wpclsNew
o wpInitData
o wpUnlockObject
ΓòÉΓòÉΓòÉ <hidden> wpclsMakeAwake - Topics ΓòÉΓòÉΓòÉ
Select an item:
Syntax
Parameters
Returns
Remarks
How to Override
Usage
Related Methods
Glossary
ΓòÉΓòÉΓòÉ 4.12. wpclsNew ΓòÉΓòÉΓòÉ
ΓòÉΓòÉΓòÉ <hidden> wpclsNew - Syntax ΓòÉΓòÉΓòÉ
/*******************************************/
/* This method creates a new instance of a */
/* given class of object. */
/*******************************************/
#define INCL_WINWORKPLACE
#include <os2.h>
M_WPObject *somSelf; /* Pointer to the WPObject class object. */
PSZ pszTitle; /* Pointer to the object title. */
PSZ pszSetupEnv; /* Environment setup string. */
WPFolder *Folder; /* Pointer to the folder object in which to place the new object. */
BOOL fLock; /* Lock object flag. */
WPObject *wpclsNew; /* Pointer to the new object. */
wpclsNew = _wpclsNew(somSelf, pszTitle, pszSetupEnv,
Folder, fLock);
ΓòÉΓòÉΓòÉ <hidden> wpclsNew Parameter - somSelf ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
ΓòÉΓòÉΓòÉ <hidden> wpclsNew Parameter - pszTitle ΓòÉΓòÉΓòÉ
pszTitle (PSZ) - input
Pointer to the object title.
A pointer to a null-terminated string which contains the initial title of
the object as it is to appear when displayed on the user interface
underneath an icon or on the title bar of an open object.
ΓòÉΓòÉΓòÉ <hidden> wpclsNew Parameter - pszSetupEnv ΓòÉΓòÉΓòÉ
pszSetupEnv (PSZ) - input
Environment setup string.
A pointer to a zero-terminated string which contains the environment setup
string of the new object. The pszSetupEnv string is extracted when the
wpSetup method is called.
Refer to wpSetup for the description of this field for the class of the
object being created.
ΓòÉΓòÉΓòÉ <hidden> wpclsNew Parameter - Folder ΓòÉΓòÉΓòÉ
Folder (WPFolder *) - input
Pointer to the folder object in which to place the new object.
This pointer can be determined by issuing a call to the wpclsQueryFolder
method.
ΓòÉΓòÉΓòÉ <hidden> wpclsNew Parameter - fLock ΓòÉΓòÉΓòÉ
fLock (BOOL) - input
Lock object flag.
Possible values are described in the following list:
TRUE
The new flag remains awake until the caller issues the wpUnlockObject
method on it.
FALSE
The newly created object is made dormant whenever the object and the
folder containing the object are closed.
ΓòÉΓòÉΓòÉ <hidden> wpclsNew Return Value - wpclsNew ΓòÉΓòÉΓòÉ
wpclsNew (WPObject *) - returns
Pointer to the new object.
A return value of NULL indicates that an error occurred.
ΓòÉΓòÉΓòÉ <hidden> wpclsNew - Parameters ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
pszTitle (PSZ) - input
Pointer to the object title.
A pointer to a null-terminated string which contains the initial title of
the object as it is to appear when displayed on the user interface
underneath an icon or on the title bar of an open object.
pszSetupEnv (PSZ) - input
Environment setup string.
A pointer to a zero-terminated string which contains the environment setup
string of the new object. The pszSetupEnv string is extracted when the
wpSetup method is called.
Refer to wpSetup for the description of this field for the class of the
object being created.
Folder (WPFolder *) - input
Pointer to the folder object in which to place the new object.
This pointer can be determined by issuing a call to the wpclsQueryFolder
method.
fLock (BOOL) - input
Lock object flag.
Possible values are described in the following list:
TRUE
The new flag remains awake until the caller issues the wpUnlockObject
method on it.
FALSE
The newly created object is made dormant whenever the object and the
folder containing the object are closed.
wpclsNew (WPObject *) - returns
Pointer to the new object.
A return value of NULL indicates that an error occurred.
ΓòÉΓòÉΓòÉ <hidden> wpclsNew - Remarks ΓòÉΓòÉΓòÉ
This method is a modified version of somNew that takes arguments. These
arguments provide a way to create a new object with a defined state.
ΓòÉΓòÉΓòÉ <hidden> wpclsNew - Usage ΓòÉΓòÉΓòÉ
This method can be called at any time to create a new workplace object. The
created object is a persistent instance of the class specified by WPClass.
ΓòÉΓòÉΓòÉ <hidden> wpclsNew - How to Override ΓòÉΓòÉΓòÉ
This method can be overridden only in a metaclass.
ΓòÉΓòÉΓòÉ <hidden> wpclsNew - Related Methods ΓòÉΓòÉΓòÉ
o wpFree
o wpSetup
o wpUnlockObject
o wpclsQueryFolder
ΓòÉΓòÉΓòÉ <hidden> wpclsNew - Topics ΓòÉΓòÉΓòÉ
Select an item:
Syntax
Parameters
Returns
Remarks
How to Override
Usage
Related Methods
Glossary
ΓòÉΓòÉΓòÉ 4.13. wpclsObjectFromHandle ΓòÉΓòÉΓòÉ
ΓòÉΓòÉΓòÉ <hidden> wpclsObjectFromHandle - Syntax ΓòÉΓòÉΓòÉ
/*******************************************/
/* This method is specific to version 3, */
/* or higher, of the OS/2 operating */
/* system. This method extracts the */
/* object pointer for an instance */
/* represented by the given handle. */
/*******************************************/
#define INCL_WINWORKPLACE
#include <os2.h>
M_WPObject *somSelf; /* Pointer to the WPObject class object. */
HOBJECT hObject; /* Persistent object handle. */
WPObject *pObject; /* Pointer to the object instance. */
pObject = _wpclsObjectFromHandle(somSelf,
hObject);
ΓòÉΓòÉΓòÉ <hidden> wpclsObjectFromHandle Parameter - somSelf ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
ΓòÉΓòÉΓòÉ <hidden> wpclsObjectFromHandle Parameter - hObject ΓòÉΓòÉΓòÉ
hObject (HOBJECT) - input
Persistent object handle.
ΓòÉΓòÉΓòÉ <hidden> wpclsObjectFromHandle Return Value - pObject ΓòÉΓòÉΓòÉ
pObject (WPObject *) - returns
Pointer to the object instance.
ΓòÉΓòÉΓòÉ <hidden> wpclsObjectFromHandle - Parameters ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
hObject (HOBJECT) - input
Persistent object handle.
pObject (WPObject *) - returns
Pointer to the object instance.
ΓòÉΓòÉΓòÉ <hidden> wpclsObjectFromHandle - Remarks ΓòÉΓòÉΓòÉ
Each base class must store the relationship between the object handles and the
folders they reside in.
Using HOBJECT for .INI files or files in which an application uses a
rename/save/delete sequence is not supported.
ΓòÉΓòÉΓòÉ <hidden> wpclsObjectFromHandle - Usage ΓòÉΓòÉΓòÉ
This method can be called at any time to find the object pointer from a given
handle.
ΓòÉΓòÉΓòÉ <hidden> wpclsObjectFromHandle - How to Override ΓòÉΓòÉΓòÉ
This method is generally not overridden.
ΓòÉΓòÉΓòÉ <hidden> wpclsObjectFromHandle - Topics ΓòÉΓòÉΓòÉ
Select an item:
Syntax
Parameters
Returns
Remarks
How to Override
Usage
Glossary
ΓòÉΓòÉΓòÉ 4.14. wpclsQueryActiveDesktop ΓòÉΓòÉΓòÉ
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryActiveDesktop - Syntax ΓòÉΓòÉΓòÉ
/*******************************************/
/* This method is specific to version 3, */
/* or higher, of the OS/2 operating */
/* system. This method returns a pointer */
/* to the active WPDesktop object. */
/*******************************************/
#define INCL_WINWORKPLACE
#include <os2.h>
M_WPDesktop *somSelf; /* Pointer to the WPDesktop class object. */
WPDesktop *WPDesktop; /* Pointer to the active desktop object. */
WPDesktop = _wpclsQueryActiveDesktop(somSelf);
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryActiveDesktop Parameter - somSelf ΓòÉΓòÉΓòÉ
somSelf (M_WPDesktop *) - input
Pointer to the WPDesktop class object.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryActiveDesktop Return Value - WPDesktop ΓòÉΓòÉΓòÉ
WPDesktop (WPDesktop *) - returns
Pointer to the active desktop object.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryActiveDesktop - Parameters ΓòÉΓòÉΓòÉ
somSelf (M_WPDesktop *) - input
Pointer to the WPDesktop class object.
WPDesktop (WPDesktop *) - returns
Pointer to the active desktop object.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryActiveDesktop - Remarks ΓòÉΓòÉΓòÉ
Multiple desktop objects can be awake, but only one can be active at a time.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryActiveDesktop - Usage ΓòÉΓòÉΓòÉ
This method can be called at any time.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryActiveDesktop - How to Override ΓòÉΓòÉΓòÉ
This method is generally not overridden.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryActiveDesktop - Related Methods ΓòÉΓòÉΓòÉ
o wpclsQueryActiveDesktopHWND
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryActiveDesktop - Topics ΓòÉΓòÉΓòÉ
Select an item:
Syntax
Parameters
Returns
Remarks
How to Override
Usage
Related Methods
Glossary
ΓòÉΓòÉΓòÉ 4.15. wpclsQueryActiveDesktopHWND ΓòÉΓòÉΓòÉ
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryActiveDesktopHWND - Syntax ΓòÉΓòÉΓòÉ
/*******************************************/
/* This method is specific to version 3, */
/* or higher, of the OS/2 operating */
/* system. This method returns the handle */
/* of the active WPDesktop object. */
/*******************************************/
#define INCL_WINWORKPLACE
#include <os2.h>
M_WPDesktop *somSelf; /* Pointer to the WPDesktop class object. */
HWND hwndDesktop; /* Handle of the active desktop object' frame window. */
hwndDesktop = _wpclsQueryActiveDesktopHWND(
somSelf);
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryActiveDesktopHWND Parameter - somSelf ΓòÉΓòÉΓòÉ
somSelf (M_WPDesktop *) - input
Pointer to the WPDesktop class object.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryActiveDesktopHWND Return Value - hwndDesktop ΓòÉΓòÉΓòÉ
hwndDesktop (HWND) - returns
Handle of the active desktop object' frame window.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryActiveDesktopHWND - Parameters ΓòÉΓòÉΓòÉ
somSelf (M_WPDesktop *) - input
Pointer to the WPDesktop class object.
hwndDesktop (HWND) - returns
Handle of the active desktop object' frame window.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryActiveDesktopHWND - Usage ΓòÉΓòÉΓòÉ
This method can be called at any time.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryActiveDesktopHWND - How to Override ΓòÉΓòÉΓòÉ
This method is generally not overridden.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryActiveDesktopHWND - Related Methods ΓòÉΓòÉΓòÉ
o wpclsQueryActiveDesktop
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryActiveDesktopHWND - Topics ΓòÉΓòÉΓòÉ
Select an item:
Syntax
Parameters
Returns
How to Override
Usage
Related Methods
Glossary
ΓòÉΓòÉΓòÉ 4.16. wpclsQueryAwakeObject ΓòÉΓòÉΓòÉ
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryAwakeObject - Syntax ΓòÉΓòÉΓòÉ
/*******************************************/
/* This method is specific to version 3, */
/* or higher, of the OS/2 operating */
/* system. This class method determines */
/* if the given object is already awake. */
/*******************************************/
#define INCL_WINWORKPLACE
#include <os2.h>
M_WPFileSystem *somSelf; /* Pointer to the WPFileSystem class object. */
PSZ pszInputPath; /* Fully-qualified input path. */
WPObject Object; /* The awake object. */
Object = _wpclsQueryAwakeObject(somSelf, pszInputPath);
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryAwakeObject Parameter - somSelf ΓòÉΓòÉΓòÉ
somSelf (M_WPFileSystem *) - input
Pointer to the WPFileSystem class object.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryAwakeObject Parameter - pszInputPath ΓòÉΓòÉΓòÉ
pszInputPath (PSZ) - input
Fully-qualified input path.
Note: This parameter must be a valid path. The system does not call the
file system to check whether the file exists.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryAwakeObject Return Value - Object ΓòÉΓòÉΓòÉ
Object (WPObject) - returns
The awake object.
A return value of NULL indicates that the object is not already awake.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryAwakeObject - Parameters ΓòÉΓòÉΓòÉ
somSelf (M_WPFileSystem *) - input
Pointer to the WPFileSystem class object.
pszInputPath (PSZ) - input
Fully-qualified input path.
Note: This parameter must be a valid path. The system does not call the
file system to check whether the file exists.
Object (WPObject) - returns
The awake object.
A return value of NULL indicates that the object is not already awake.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryAwakeObject - Remarks ΓòÉΓòÉΓòÉ
This methods requires that for an object to be awake, all path coomponents
prior to the object are also awake. If any path component is not found awake,
then the routine assumes that the object for that passed file cannot be awake
either.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryAwakeObject - Usage ΓòÉΓòÉΓòÉ
This method can be called at any time.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryAwakeObject - How to Override ΓòÉΓòÉΓòÉ
This method is generally not overridden.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryAwakeObject - Related Methods ΓòÉΓòÉΓòÉ
o wpclsMakeAwake
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryAwakeObject - Topics ΓòÉΓòÉΓòÉ
Select an item:
Syntax
Parameters
Returns
Remarks
How to Override
Usage
Related Methods
Glossary
ΓòÉΓòÉΓòÉ 4.17. wpclsQueryButtonAppearance ΓòÉΓòÉΓòÉ
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryButtonAppearance - Syntax ΓòÉΓòÉΓòÉ
/*******************************************/
/* This method is specific to version 3, */
/* or higher, of the OS/2 operating */
/* system. This class method returns the */
/* system button appearance. */
/*******************************************/
#define INCL_WINWORKPLACE
#include <os2.h>
M_WPObject *somSelf; /* Pointer to the WPObject class object. */
ULONG ulButtonType; /* Flag indicating the system default button appearance. */
ulButtonType = _wpclsQueryButtonAppearance(
somSelf);
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryButtonAppearance Parameter - somSelf ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryButtonAppearance Return Value - ulButtonType ΓòÉΓòÉΓòÉ
ulButtonType (ULONG) - returns
Flag indicating the system default button appearance.
Possible values are described in the following list:
HIDEBUTTON
MINBUTTON
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryButtonAppearance - Parameters ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
ulButtonType (ULONG) - returns
Flag indicating the system default button appearance.
Possible values are described in the following list:
HIDEBUTTON
MINBUTTON
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryButtonAppearance - Usage ΓòÉΓòÉΓòÉ
This method can be called at any time to query the default button appearance.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryButtonAppearance - How to Override ΓòÉΓòÉΓòÉ
This method is generally not overridden.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryButtonAppearance - Related Methods ΓòÉΓòÉΓòÉ
o wpQueryButtonAppearance
o wpSetButtonAppearance
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryButtonAppearance - Topics ΓòÉΓòÉΓòÉ
Select an item:
Syntax
Parameters
Returns
How to Override
Usage
Related Methods
Glossary
ΓòÉΓòÉΓòÉ 4.18. wpclsQueryDefaultHelp ΓòÉΓòÉΓòÉ
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryDefaultHelp - Syntax ΓòÉΓòÉΓòÉ
/*******************************************/
/* This method is called to allow the */
/* class object to specify its default */
/* help panel for its instances. */
/*******************************************/
#define INCL_WINWORKPLACE
#include <os2.h>
M_WPObject *somSelf; /* Pointer to the WPObject class object. */
PULONG HelpPanelId; /* Pointer to the help panel which provides help for this class. */
PSZ HelpLibrary; /* Pointer to the buffer in which to place the name of the Help library. */
ULONG rc; /* Success indicator. */
rc = _wpclsQueryDefaultHelp(somSelf, HelpPanelId,
HelpLibrary);
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryDefaultHelp Parameter - somSelf ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryDefaultHelp Parameter - HelpPanelId ΓòÉΓòÉΓòÉ
HelpPanelId (PULONG) - output
Pointer to the help panel which provides help for this class.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryDefaultHelp Parameter - HelpLibrary ΓòÉΓòÉΓòÉ
HelpLibrary (PSZ) - output
Pointer to the buffer in which to place the name of the Help library.
This buffer should be at least the length of CCHMAXPATH bytes.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryDefaultHelp Return Value - rc ΓòÉΓòÉΓòÉ
rc (ULONG) - returns
Success indicator.
TRUE Successful completion.
FALSE Error occurred.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryDefaultHelp - Parameters ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
HelpPanelId (PULONG) - output
Pointer to the help panel which provides help for this class.
HelpLibrary (PSZ) - output
Pointer to the buffer in which to place the name of the Help library.
This buffer should be at least the length of CCHMAXPATH bytes.
rc (ULONG) - returns
Success indicator.
TRUE Successful completion.
FALSE Error occurred.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryDefaultHelp - Remarks ΓòÉΓòÉΓòÉ
This class method is called during the default processing of
wpQueryDefaultHelp.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryDefaultHelp - Usage ΓòÉΓòÉΓòÉ
This method can be called at any time in order to determine the default help
panel for this object class.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryDefaultHelp - How to Override ΓòÉΓòÉΓòÉ
The default WPObject class does not process this method other than returning
FALSE.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryDefaultHelp - Related Methods ΓòÉΓòÉΓòÉ
o wpDisplayHelp
o wpMenuItemHelpSelected
o wpQueryDefaultHelp
o wpSetDefaultHelp
o wpclsQueryDefaultHelp
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryDefaultHelp - Example Code ΓòÉΓòÉΓòÉ
This example provides general help for the Spread (sheet) instance.
SOM_Scope BOOL SOMLINK SpreadM_wpclsQueryDefaultHelp(M_Spread *somSelf,
PULONG pHelpPanelId,
PSZ pszHelpLibrary)
{
/* M_SpreadData *somThis = M_SpreadGetData(somSelf); */
M_SpreadMethodDebug("M_Spread","SpreadM_wpclsQueryDefaultHelp");
if (pHelpPanelId) /* set default help panel id */
*pHelpPanelId = PANEL_MAIN;
if (pszHelpLibrary) /* copy help filename */
strcpy( pszHelpLibrary, "spdsheet.hlp");
return( TRUE ); /* Help exists */
}
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryDefaultHelp - Topics ΓòÉΓòÉΓòÉ
Select an item:
Syntax
Parameters
Returns
Remarks
How to Override
Usage
Example Code
Related Methods
Glossary
ΓòÉΓòÉΓòÉ 4.19. wpclsQueryDefaultView ΓòÉΓòÉΓòÉ
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryDefaultView - Syntax ΓòÉΓòÉΓòÉ
/*******************************************/
/* This method is called to allow the */
/* class object to specify the default */
/* open view for its instance. */
/*******************************************/
#define INCL_WINWORKPLACE
#include <os2.h>
M_WPObject *somSelf; /* Pointer to the WPObject class object. */
ULONG ulView; /* Default open view. */
ulView = wpclsQueryDefaultView(somSelf);
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryDefaultView Parameter - somSelf ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryDefaultView Return Value - ulView ΓòÉΓòÉΓòÉ
ulView (ULONG) - returns
Default open view.
OPEN_CONTENTS
Open contents view.
OPEN_DEFAULT
Open default view (same as double-click).
OPEN_DETAILS
Open details view.
OPEN_HELP
Display HelpPanel.
OPEN_RUNNING
Execute object.
OPEN_SETTINGS
Open Settings notebook.
OPEN_TREE
Open tree view.
OPEN_UNKNOWN
Unknown view.
OPEN_USER
Class-specific views have a greater value than this.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryDefaultView - Parameters ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
ulView (ULONG) - returns
Default open view.
OPEN_CONTENTS
Open contents view.
OPEN_DEFAULT
Open default view (same as double-click).
OPEN_DETAILS
Open details view.
OPEN_HELP
Display HelpPanel.
OPEN_RUNNING
Execute object.
OPEN_SETTINGS
Open Settings notebook.
OPEN_TREE
Open tree view.
OPEN_UNKNOWN
Unknown view.
OPEN_USER
Class-specific views have a greater value than this.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryDefaultView - Usage ΓòÉΓòÉΓòÉ
This method can be called at any time in order to query the default open view
for instances of this class.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryDefaultView - How to Override ΓòÉΓòÉΓòÉ
All classes should override this method, so that new objects in their class
will always have a sensible default view (device objects typically have a
default view of OPEN_SETTINGS). The default view is used for both the
conditional Open cascade menu and double-clicking on the object.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryDefaultView - Related Methods ΓòÉΓòÉΓòÉ
o wpQueryDefaultView
o wpclsQueryDefaultView
o wpSetDefaultView
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryDefaultView - Example Code ΓòÉΓòÉΓòÉ
This example demonstrates how to change the default open view of the instances
of this class by overriding this method.
SOM_Scope ULONG SOMLINK MyObjectM_wpclsQueryDefaultView(M_MyObject *somSelf)
{
/* M_MyObjectData *somThis = M_MyObjectGetData(somSelf); */
M_MyObjectMethodDebug("M_MyObject","MtObjectM_wpclsQueryDefaultView");
/* Make the default open view the ICON view */
return ( OPEN_ICON );
}
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryDefaultView - Topics ΓòÉΓòÉΓòÉ
Select an item:
Syntax
Parameters
Returns
How to Override
Usage
Example Code
Related Methods
Glossary
ΓòÉΓòÉΓòÉ 4.20. wpclsQueryDetails ΓòÉΓòÉΓòÉ
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryDetails - Syntax ΓòÉΓòÉΓòÉ
/*******************************************/
/* This method is called to allow the */
/* class object to specify the default */
/* details view items for its instances. */
/*******************************************/
#define INCL_WINWORKPLACE
#include <os2.h>
M_WPObject *somSelf; /* Pointer to the WPObject class object. */
PCLASSDETAILS pReturn; /* Success indicator. */
pReturn = _wpclsQueryDetails(somSelf);
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryDetails Parameter - somSelf ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryDetails Return Value - pReturn ΓòÉΓòÉΓòÉ
pReturn (PCLASSDETAILS) - returns
Success indicator.
NULL Error occurred
Other Pointer to details information.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryDetails - Parameters ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
pReturn (PCLASSDETAILS) - returns
Success indicator.
NULL Error occurred
Other Pointer to details information.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryDetails - Related Methods ΓòÉΓòÉΓòÉ
o wpQueryDetailsData
o wpclsQueryDetails
o wpclsQueryDetailsInfo
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryDetails - Example Code ΓòÉΓòÉΓòÉ
This example shows an override of the method to invoke 'DisplayMethodInfo' in
the WPSTUTOR sample program.
SOM_Scope PCLASSDETAILS SOMLINK wpstutM_wpclsQueryDetails(M_WPSTutorial *somSelf)
{
/* M_WPSTutorialData *somThis = M_WPSTutorialGetData(somSelf); */
M_WPSTutorialMethodDebug("M_WPSTutorial","wpstutM_wpclsQueryDetails");
DisplayMethodInfo(IDS_WPCLSQUERYDETAILS);
return (parent_wpclsQueryDetails(somSelf));
}
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryDetails - Topics ΓòÉΓòÉΓòÉ
Select an item:
Syntax
Parameters
Returns
Example Code
Related Methods
Glossary
ΓòÉΓòÉΓòÉ 4.21. wpclsQueryDetailsInfo ΓòÉΓòÉΓòÉ
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryDetailsInfo - Syntax ΓòÉΓòÉΓòÉ
/*******************************************/
/* This method is called to allow the */
/* class object to specify its details to */
/* be used for its instances. */
/*******************************************/
#define INCL_WINWORKPLACE
#include <os2.h>
M_WPObject *somSelf; /* Pointer to the WPObject class object. */
PCLASSFIELDINFO pClassFieldInfo; /* Pointer to details information. */
PULONG pSize; /* Total number of bytes of details data. */
ULONG ulReturn; /* Sum of the number of detail columns for the object. */
ulReturn = _wpclsQueryDetailsInfo(somSelf,
pClassFieldInfo, pSize);
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryDetailsInfo Parameter - somSelf ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryDetailsInfo Parameter - pClassFieldInfo ΓòÉΓòÉΓòÉ
pClassFieldInfo (PCLASSFIELDINFO) - in/out
Pointer to details information.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryDetailsInfo Parameter - pSize ΓòÉΓòÉΓòÉ
pSize (PULONG) - in/out
Total number of bytes of details data.
This total includes the details added by this class and ancestor classes.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryDetailsInfo Return Value - ulReturn ΓòÉΓòÉΓòÉ
ulReturn (ULONG) - returns
Sum of the number of detail columns for the object.
This sum includes details added by this class and ancestor classes.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryDetailsInfo - Parameters ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
pClassFieldInfo (PCLASSFIELDINFO) - in/out
Pointer to details information.
pSize (PULONG) - in/out
Total number of bytes of details data.
This total includes the details added by this class and ancestor classes.
ulReturn (ULONG) - returns
Sum of the number of detail columns for the object.
This sum includes details added by this class and ancestor classes.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryDetailsInfo - Remarks ΓòÉΓòÉΓòÉ
All objects which have information to display in details view must override
this method.
The two possible queries are:
Query 1
A request for the CLASSFIELDINFO linked the list segment associated with an
object. This information is needed just prior to changing the view of a
container control to details view.
If pClassFieldInfo is NULL (no subclasses have appended details data), the
number of columns of details information for this class and all its
superclasses is returned. If pClassFieldInfo is NON-NULL, the number of columns
of details informtion is returned and *pClassFieldInfo points to the head of a
linked list of CLASSFIELDINFO structures to which a linked list of
CLASSFIELDINFO structures describing the details fields of objects of this
subclass should be appended.
For example,on input *pClassFieldInfo:
CLASSFIELDINFO_1_grandparent_
CLASSFIELDINFO_2_grandparent
CLASSFIELDINFO_1_parent
on output, *pClassFieldInfo:
CLASSFIELDINFO_1_grandparent_
CLASSFIELDINFO_2_grandparent
CLASSFIELDINFO_1_parent
CLASSFIELDINFO_1_self
The correct way to handle this request is to do the following:
o Call the parent method. The parent method returns the number of columns
the ancestors have contributed.
o Walk the chain of CLASSFIELDINFO structures to the end and append the
chain of CLASSFIELDINFO structures for the current class (using the
pNextFieldInfo element).
o If *pClassFieldInfo is zero (indicating no parent columns), assign
*pClassFieldInfo = beginning of CLASSFIELDINFO chain for this subclass.
o Return the sum of the details columns of the parent and the current
subclass.
Note the following differences between the CLASSFIELDINFO and FIELDINFO
structures:
o The offFieldData and ulLenFieldData fields are required so that
appropriate offsets for the data can be computed. The application is
responsible for providing offFieldData and ulLenFieldData fields.
o The ulReserved field should be left NULL.
o Owner draw, comparison, and sort functions may be specified for the
field.
For example, if an object has three fields:
typedef struct _SAMPLE_DETAIL_DATA {
CDATE cdate;
CTIME ctime;
PSZ psz;
} SAMPLE_DETAIL_DATA;
classfieldinfo[0].offFieldData = FIELDOFFSET(SAMPLE,cdate);
classfieldinfo[0].ulLenFieldData = FIELDOFFSET(SAMPLE,ctime)
FIELDOFFSET(SAMPLE,cdate);
classfieldinfo[1].offFieldData = FIELDOFFSET(SAMPLE,ctime);
classfieldinfo[1].ulLenFieldData = FIELDOFFSET(SAMPLE,psz) -
FIELDOFFSET(SAMPLE,ctime);
classfieldinfo[2].offFieldData = FIELDOFFSET(SAMPLE,psz);
classfieldinfo[2].ulLenFieldData = sizeof(SAMPLE) -
FIELDOFFSET(SAMPLE,psz);
Note that *pClassFieldInfo must be modified to point to the beginning of the
CLASSFIELDINFO linked list only if *pClassFieldInfo is 0.
The application must return the sum of the details columns of the parent and
itself:
return(n_cols + n_parent_cols);
Note also that the fields MUST be set up sequentially. classfieldinfo[0] must
point to data at an offset of 0. classfieldinfo[n] must point to data
adjacent, and directly following that described by classfieldinfo[-1].
Query 2
The number of bytes of details data associated with an object. This
information is needed prior to allocating memory for a container control
insert record.
If pSize is NON-NULL, the override should adjust *pSize by the number of bytes
which must be added to the end of a MINIRECORDCORE structure to hold the
details information for objects of this class.
Example:
*pSize += bytes_of_details_data;
In the case of the above example,
*pSize += sizeof(SAMPLE_DETAIL_DATA);
Note: All class field pointers returned should be pointers to static data
areas.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryDetailsInfo - Usage ΓòÉΓòÉΓòÉ
This method is generally called only by the system.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryDetailsInfo - How to Override ΓòÉΓòÉΓòÉ
This method should be overridden by classes that introduce class-specific
details to be displayed in details view. The parent method must always be
called before appending the request information.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryDetailsInfo - Related Methods ΓòÉΓòÉΓòÉ
o wpQueryDetailsData
o wpclsQueryDetails
o wpclsQueryDetailsInfo
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryDetailsInfo - Example Code ΓòÉΓòÉΓòÉ
This example adds details data for the Car object by appending FIELDINFO
structures to *ppClassFieldInfo.
SOM_Scope ULONG SOMLINK carM_wpclsQueryDetailsInfo(M_Car *somSelf,
PCLASSFIELDINFO *ppClassFieldInfo,
PULONG pSize)
{
ULONG cParentCol;
PCLASSFIELDINFO pCFI;
ULONG i;
/* M_CarData *somThis = M_CarGetData(somSelf); */
M_CarMethodDebug("M_Car","carM_wpclsQueryDetailsInfo");
/* Always call the parent method first to retrieve the number of
details columns and any data already defined in the details buffer. */
cParentCol = parent_wpclsQueryDetailsInfo(somSelf, ppClassFieldInfo, pSize);
/* If details columns exist, add the size of ours to it */
if (pSize)
*pSize += sizeof(CARDETAILS);
/* If the request was for the chained fieldinfo structures
* (ppClassFieldInfo is non-NULL), link them in
*
* eventually the chain will look like
*
* Grandad - Dad - Me - Kid - Grandkid
*
* I will be getting the pointer to the beginning of the chain
*
* If the beginning of the chain is 0, I will assign the address
* of my first CLASSFIELDINFO structure to *ppClassFieldInfo.
* Otherwise *pp points to the first column description in the
* chain. We need to walk the chain and link our CLASSFIELDINFO
* structures at the end.
*/
if (ppClassFieldInfo) {
if (*ppClassFieldInfo) {
pCFI = *ppClassFieldInfo;
for (i=0;i<cParentColumns;i++)
pCFI = (pCFI->pNextFieldInfo) ? pCFI->pNextFieldInfo : pCFI;
pCFI->pNextFieldInfo = fieldinfo;
} else {
*ppClassFieldInfo = fieldinfo;
} /* endif */
} /* endif */
return ((ULONG) (cParentColumns + NUM_CAR_FIELDS));
}
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryDetailsInfo - Topics ΓòÉΓòÉΓòÉ
Select an item:
Syntax
Parameters
Returns
Remarks
How to Override
Usage
Example Code
Related Methods
Glossary
ΓòÉΓòÉΓòÉ 4.22. wpclsQueryEditString ΓòÉΓòÉΓòÉ
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryEditString - Syntax ΓòÉΓòÉΓòÉ
/*******************************************/
/* This method is called to allow the */
/* class object to specify the text to be */
/* used in the edit pushbutton of the */
/* palette object's open view. */
/*******************************************/
#define INCL_WINWORKPLACE
#include <os2.h>
M_WPPalette *somSelf; /* Pointer to the WPPalette class object. */
PSZ ppointer; /* Pointer to the edit pushbutton string. */
ppointer = _wpclsQueryEditString(somSelf);
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryEditString Parameter - somSelf ΓòÉΓòÉΓòÉ
somSelf (M_WPPalette *) - input
Pointer to the WPPalette class object.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryEditString Return Value - ppointer ΓòÉΓòÉΓòÉ
ppointer (PSZ) - returns
Pointer to the edit pushbutton string.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryEditString - Parameters ΓòÉΓòÉΓòÉ
somSelf (M_WPPalette *) - input
Pointer to the WPPalette class object.
ppointer (PSZ) - returns
Pointer to the edit pushbutton string.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryEditString - Usage ΓòÉΓòÉΓòÉ
This method can be called at any time in order to determine the text of the
edit pushbutton.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryEditString - How to Override ΓòÉΓòÉΓòÉ
This method should be overridden in order to specify class-specific edit
pushbutton text. The parent method is generally not called.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryEditString - Topics ΓòÉΓòÉΓòÉ
Select an item:
Syntax
Parameters
Returns
How to Override
Usage
Glossary
ΓòÉΓòÉΓòÉ 4.23. wpclsQueryError ΓòÉΓòÉΓòÉ
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryError - Syntax ΓòÉΓòÉΓòÉ
/*******************************************/
/* This class method queries the current */
/* error code held within a class object. */
/*******************************************/
#define INCL_WINWORKPLACE
#include <os2.h>
M_WPObject *somSelf; /* Pointer to the WPObject class object. */
ULONG ulErrorId; /* ID of the last error. */
ulErrorId = _wpclsQueryError(somSelf);
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryError Parameter - somSelf ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryError Return Value - ulErrorId ΓòÉΓòÉΓòÉ
ulErrorId (ULONG) - returns
ID of the last error.
Last error that occurred when using this class object.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryError - Parameters ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
ulErrorId (ULONG) - returns
ID of the last error.
Last error that occurred when using this class object.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryError - Remarks ΓòÉΓòÉΓòÉ
When an error occurs within a class method and that method subsequently fails,
the calling procedure can retrieve the error code for that failed method call
by using the wpclsQueryError method. Note that the error code is always that of
the last method that failed. A successful method does not modify the error code
held within a class object. This method is analogous to the WinGetErrorInfo and
the WinGetLastError function calls that are used by Presentation Manager
applications to diagnose the reason for the previous failing call to a
Presentation Manager function call.
The system-provided class methods will return error codes as defined in the
header file PMERR.H. For example, the wpclsQueryObject method will normally log
an error of WPERR_OBJECT_NOT_FOUND if it is unable to return an object pointer.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryError - Usage ΓòÉΓòÉΓòÉ
This method should be called immediately after a class method has failed in
order to diagnose why the failure occurred.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryError - How to Override ΓòÉΓòÉΓòÉ
Never override this class method.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryError - Related Methods ΓòÉΓòÉΓòÉ
o wpclsSetError
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryError - Example Code ΓòÉΓòÉΓòÉ
This example finds all occurrences of an object type in a folder.
VOID clsFindEverybody(SOMAny *self)
{
BOOL rc; /* Return from methods */
HFIND hFind = 0; /* Handle for repeated finds */
CLASS Class[2]; /* List of classes to look for */
OBJECT Object[10]; /* Objects returned from search */
ULONG ulCount = 10; /* Count of objects to find / or found */
WPFolder *folder = 0; /* Pointer to folder for search */
ULONG errorid = 0; /* Error returned from previous search */
CHAR sz[CCHMAXPATH]; /* Title string to look for */
PSZ title = sz;
Class[0] = _WPFolder;
Class[1] = NULL;
/* Get the pointer to the desktop (since that is where we are looking) */
folder = _wpclsQueryFolder( _WPFolder, "<WP_DESKTOP>", TRUE );
_wpclsSetError( _WPObject, 0 ); /* Reset the error indicators */
rc = 0;
/* Attempt to find the first 10 objects matching our criteria */
ulCount = 10;
rc =_wpclsFindObjectFirst(_WPObject, /* Class self pointer */
Class, /* Pointer to array of class objects */
&hFind, /* Handle for wpclsFindObjectNext */
NULL, /* Find EVERYTHING */
folder, /* Pointer to folder of interest */
TRUE, /* Search all folders in tree */
NULL, /* No extended criteria */
Object, /* Array of object pointers */
&ulCount ); /* Number requested and number found */
errorid = _wpclsQueryError( _WPObject); /* Get errorid (may still be OK) */
if ((!rc && (errorid == WPERR_BUFFER_OVERFLOW)) || rc) {
/***** Process objects found here ******/
} else {
somPrintf(" _wpclsFindObjectFirst failed, errorid=%u\n", errorid );
return;
} /* endif */
do {
_wpclsSetError( _WPObject, 0 ); /* Reset error indicators */
rc = 0;
/* Look for next 10 objects */
rc =_wpclsFindObjectNext(_WPObject, /* Self */
hFind, /* Handle from previous Find */
Object, /* Objects found */
&ulCount ); /* Number to look for. On
return, number found */
errorid = _wpclsQueryError( _WPObject );
if ((!rc && (errorid == WPERR_BUFFER_OVERFLOW)) || rc) {
/***** Process objects found here ******/
} else {
somPrintf("_wpclsFindObjectNext failed, errorid=%u\n", errorid);
return;
} /* endif */
} while ( errorid == WPERR_BUFFER_OVERFLOW ); /* enddo */
_wpclsSetError( _WPObject, 0 ); /* Reset error indicators */
rc = 0;
/* Indicate find complete */
rc =_wpclsFindObjectEnd( _WPObject, hFind );
if (!rc) {
errorid = _wpclsQueryError( _WPObject );
somPrintf( "_wpclsFindObjectEnd failed, errorid=%u\n", errorid );
return;
}
return;
}
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryError - Topics ΓòÉΓòÉΓòÉ
Select an item:
Syntax
Parameters
Returns
Remarks
How to Override
Usage
Example Code
Related Methods
Glossary
ΓòÉΓòÉΓòÉ 4.24. wpclsQueryExtendedCriteria ΓòÉΓòÉΓòÉ
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryExtendedCriteria - Syntax ΓòÉΓòÉΓòÉ
/*******************************************/
/* The wpclsQueryExtendedCriteria method */
/* is called to allow the specified class */
/* to specify the extended criteria to be */
/* used on a search for instances of this */
/* class. */
/*******************************************/
#define INCL_WINWORKPLACE
#include <os2.h>
M_WPObject *somSelf; /* Pointer to the WPObject class object. */
PSZ Title; /* Pointer to the title specification for objects to be searched. */
ULONG ulSearchType; /* Flag indicating type of search to be performed. */
PVOID ExtendedCriteria; /* Pointer to a buffer that contains the class-specific extended search criteria. */
BOOL fSuccess; /* Success indicator. */
fSuccess = wpclsQueryExtendedCriteria(somSelf,
Title, ulSearchType, ExtendedCriteria);
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryExtendedCriteria Parameter - somSelf ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryExtendedCriteria Parameter - Title ΓòÉΓòÉΓòÉ
Title (PSZ) - input
Pointer to the title specification for objects to be searched.
This title may include the wildcard characters "*" and "?".
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryExtendedCriteria Parameter - ulSearchType ΓòÉΓòÉΓòÉ
ulSearchType (ULONG) - input
Flag indicating type of search to be performed.
SEARCH_ALL_FOLDERS
Search all folders.
SEARCH_THIS_FOLDER
Search current folder only.
SEARCH_THIS_TREE
Search the current folder tree only.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryExtendedCriteria Parameter - ExtendedCriteria ΓòÉΓòÉΓòÉ
ExtendedCriteria (PVOID) - output
Pointer to a buffer that contains the class-specific extended search
criteria.
This buffer can be passed to the wpDoesObjectMatch method.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryExtendedCriteria Return Value - fSuccess ΓòÉΓòÉΓòÉ
fSuccess (BOOL) - returns
Success indicator.
TRUE
Successful completion.
FALSE
An error occurred or the user canceled the search operation.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryExtendedCriteria - Parameters ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
Title (PSZ) - input
Pointer to the title specification for objects to be searched.
This title may include the wildcard characters "*" and "?".
ulSearchType (ULONG) - input
Flag indicating type of search to be performed.
SEARCH_ALL_FOLDERS
Search all folders.
SEARCH_THIS_FOLDER
Search current folder only.
SEARCH_THIS_TREE
Search the current folder tree only.
ExtendedCriteria (PVOID) - output
Pointer to a buffer that contains the class-specific extended search
criteria.
This buffer can be passed to the wpDoesObjectMatch method.
fSuccess (BOOL) - returns
Success indicator.
TRUE
Successful completion.
FALSE
An error occurred or the user canceled the search operation.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryExtendedCriteria - Remarks ΓòÉΓòÉΓòÉ
This method is called by the system during the processing of the Find and
folder Include facilities.
This method typically prompts the user to select the extended criteria.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryExtendedCriteria - Usage ΓòÉΓòÉΓòÉ
This method can be called at any time in order to determine the extended search
criteria to be used for finding objects of this class.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryExtendedCriteria - How to Override ΓòÉΓòÉΓòÉ
This method should be overridden by classes which introduce extended search
criteria for use by the Find and folder Include facilities.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryExtendedCriteria - Topics ΓòÉΓòÉΓòÉ
Select an item:
Syntax
Parameters
Returns
Remarks
How to Override
Usage
Glossary
ΓòÉΓòÉΓòÉ 4.25. wpclsQueryFolder ΓòÉΓòÉΓòÉ
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryFolder - Syntax ΓòÉΓòÉΓòÉ
/*******************************************/
/* This method is called to get a pointer */
/* to a folder object that corresponds to */
/* a given file system location. */
/*******************************************/
#define INCL_WINWORKPLACE
#include <os2.h>
M_WPObject *somSelf; /* Pointer to the WPObject class object. */
PSZ pLocation; /* Folder location. */
BOOL fLock; /* Lock object flag. */
WPFolder *Success; /* Success indicator. */
Success = _wpclsQueryFolder(somSelf, pLocation,
fLock);
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryFolder Parameter - somSelf ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryFolder Parameter - pLocation ΓòÉΓòÉΓòÉ
pLocation (PSZ) - input
Folder location.
This value can be in any of the following formats:
o Predefined object IDs of system folders:
"<WP_NOWHERE>" The hidden folder.
"<LOCATION_DESKTOP>" The currently active desktop.
"<WP_OS2SYS>" The System folder.
"<WP_TEMPS>" The Templates folder.
"<WP_CONFIG>" The System Setup folder.
"<WP_START>" The Startup folder.
"<WP_INFO>" The Information folder.
"<WP_DRIVES>" The Drives folder.
o Real name specified as a fully qualified path name.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryFolder Parameter - fLock ΓòÉΓòÉΓòÉ
fLock (BOOL) - input
Lock object flag.
If this flag is false, the newly created object will be made dormant
whenever the object and the folder containing the object are closed. If
this flag is true, the new flag will remain active until the caller issues
the wpUnlockObject method on it.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryFolder Return Value - Success ΓòÉΓòÉΓòÉ
Success (WPFolder *) - returns
Success indicator.
NULL Error occurred
Other Pointer to a folder object.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryFolder - Parameters ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
pLocation (PSZ) - input
Folder location.
This value can be in any of the following formats:
o Predefined object IDs of system folders:
"<WP_NOWHERE>" The hidden folder.
"<LOCATION_DESKTOP>" The currently active desktop.
"<WP_OS2SYS>" The System folder.
"<WP_TEMPS>" The Templates folder.
"<WP_CONFIG>" The System Setup folder.
"<WP_START>" The Startup folder.
"<WP_INFO>" The Information folder.
"<WP_DRIVES>" The Drives folder.
o Real name specified as a fully qualified path name.
fLock (BOOL) - input
Lock object flag.
If this flag is false, the newly created object will be made dormant
whenever the object and the folder containing the object are closed. If
this flag is true, the new flag will remain active until the caller issues
the wpUnlockObject method on it.
Success (WPFolder *) - returns
Success indicator.
NULL Error occurred
Other Pointer to a folder object.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryFolder - Remarks ΓòÉΓòÉΓòÉ
To obtain a real name from an object pointer, the wpQueryRealName method should
be called.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryFolder - Usage ΓòÉΓòÉΓòÉ
This method can be called at any time in order to determine the object pointer
for a folder.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryFolder - How to Override ΓòÉΓòÉΓòÉ
This method is generally not overridden.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryFolder - Example Code ΓòÉΓòÉΓòÉ
#define INCL_WINWORKPLACE
#include <os2.h>
SOMAny *objDesktop;
SOMAny *objSysShadow;
/* Get the object pointer of the desktop folder */
objDesktop = _wpclsQueryFolder( _WPFolder
, "<WP_DESKTOP>" /* Folder location */
,TRUE); /* Keep active */
/* Create a shadow of the desktop */
objSysShadow = _wpCreateShadowObject( self
, objDesktop /* Object to shadow */
,FALSE); /* Make dormant when folder
closes */
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryFolder - Topics ΓòÉΓòÉΓòÉ
Select an item:
Syntax
Parameters
Returns
Remarks
How to Override
Usage
Example Code
Glossary
ΓòÉΓòÉΓòÉ 4.26. wpclsQueryIcon ΓòÉΓòÉΓòÉ
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryIcon - Syntax ΓòÉΓòÉΓòÉ
/*******************************************/
/* This method is called to allow the */
/* class object to specify the default */
/* icon to be used for its instances. */
/*******************************************/
#define INCL_WINWORKPLACE
#include <os2.h>
M_WPObject *somSelf; /* Pointer to the WPObject class object. */
HPOINTER hptrSuccess; /* Success indicator. */
hptrSuccess = _wpclsQueryIcon(somSelf);
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryIcon Parameter - somSelf ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryIcon Return Value - hptrSuccess ΓòÉΓòÉΓòÉ
hptrSuccess (HPOINTER) - returns
Success indicator.
NULL Error occurred
Other Handle to an icon.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryIcon - Parameters ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
hptrSuccess (HPOINTER) - returns
Success indicator.
NULL Error occurred
Other Handle to an icon.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryIcon - Remarks ΓòÉΓòÉΓòÉ
The class default icon can be loaded on wpclsInitData and freed on
wpclsUnInitData.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryIcon - Usage ΓòÉΓòÉΓòÉ
This method can be called at any time in order to determine the default icon
for instances of this class.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryIcon - How to Override ΓòÉΓòÉΓòÉ
This method is overridden in order to change the default icon for an instance
of the class.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryIcon - Related Methods ΓòÉΓòÉΓòÉ
o wpclsQueryIcon
o wpQueryIcon
o wpQueryIconData
o wpSetIcon
o wpSetIconData
o wpclsQueryIconData
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryIcon - Example Code ΓòÉΓòÉΓòÉ
This example returns the handle to an icon.
SOM_Scope HPOINTER SOMLINK pviewM_wpclsQueryIcon(M_PictureViewer *somSelf)
{
/* M_PictureViewerData *somThis = M_PictureViewerGetData(somSelf); */
M_PictureViewerMethodDebug("M_PictureViewer","pviewM_wpclsQueryIcon");
/* return (parent_wpclsQueryIcon(somSelf)); don't call parent method */
return ( _hIcon ); /* Return own Icon */
}
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryIcon - Topics ΓòÉΓòÉΓòÉ
Select an item:
Syntax
Parameters
Returns
Remarks
How to Override
Usage
Example Code
Related Methods
Glossary
ΓòÉΓòÉΓòÉ 4.27. wpclsQueryIconData ΓòÉΓòÉΓòÉ
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryIconData - Syntax ΓòÉΓòÉΓòÉ
/*******************************************/
/* This class method allows the system to */
/* build the class default icon for a */
/* given class. */
/*******************************************/
#define INCL_WINWORKPLACE
#include <os2.h>
M_WPObject *somSelf; /* Pointer to the WPObject class object. */
PICONINFO pIconInfo; /* Handle to the container control window. */
ULONG ulcbIconInfo; /* Buffer size. */
ulcbIconInfo = _wpclsQueryIconData(somSelf,
pIconInfo);
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryIconData Parameter - somSelf ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryIconData Parameter - pIconInfo ΓòÉΓòÉΓòÉ
pIconInfo (PICONINFO) - in/out
Handle to the container control window.
If this parameter is NULLHANDLE, the size should still be returned
correctly.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryIconData Return Value - ulcbIconInfo ΓòÉΓòÉΓòÉ
ulcbIconInfo (ULONG) - returns
Buffer size.
The size of the buffer needed to accommodate the ICONINFO buffer that is
returned by this particular class object.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryIconData - Parameters ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
pIconInfo (PICONINFO) - in/out
Handle to the container control window.
If this parameter is NULLHANDLE, the size should still be returned
correctly.
ulcbIconInfo (ULONG) - returns
Buffer size.
The size of the buffer needed to accommodate the ICONINFO buffer that is
returned by this particular class object.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryIconData - Remarks ΓòÉΓòÉΓòÉ
If NULLHANDLE is passed for the pIconInfo parameter, the caller is asking for
the size of the ICONINFO buffer needed for this class (usually for memory
allocation purposes). Otherwise, the pIconInfo parameter can always be assumed
to be large enough to accommodate the ICONINFO for this class.
Note that the ICONINFO structure allows you to specify the default icon in
three different ways:
o An icon file name
o A module name and resource identifier
o A block of binary data
However, only one mechanism need be supported by any given class. For example,
a caller cannot request one of the three formats by prefilling the ICONINFO
structure.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryIconData - Usage ΓòÉΓòÉΓòÉ
This method may be called at any time. Typically, it would not be useful for
another object class to make calls to this method.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryIconData - How to Override ΓòÉΓòÉΓòÉ
Workplace classes that wish to have a unique class default icon must override
this method and fill out the appropriate fields within the ICONINFO structure.
In addition, the correct size for the ICONINFO must always be returned.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryIconData - Related Methods ΓòÉΓòÉΓòÉ
o wpQueryIcon
o wpQueryIconData
o wpSetIcon
o wpSetIconData
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryIconData - Example Code ΓòÉΓòÉΓòÉ
This example returns information about the icon associated with the class if
pIconInfo is non-NULL.
SOM_Scope ULONG SOMLINK CalendarM_wpclsQueryIconData(M_Calendar *somSelf,
PICONINFO pIconInfo)
{
M_CalendarData *somThis = M_CalendarGetData(somSelf);
M_CalendarMethodDebug("M_Calendar","myfM_wpclsQueryIconData");
if (pIconInfo) {
pIconInfo->fFormat = ICON_RESOURCE;
pIconInfo->hmod = _clsQueryModuleHandle( somSelf );
pIconInfo->resid = ID_ICON;
} /* endif */
return ( sizeof(ICONINFO) );
}
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryIconData - Topics ΓòÉΓòÉΓòÉ
Select an item:
Syntax
Parameters
Returns
Remarks
How to Override
Usage
Example Code
Related Methods
Glossary
ΓòÉΓòÉΓòÉ 4.28. wpclsQueryIconDataN ΓòÉΓòÉΓòÉ
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryIconDataN - Syntax ΓòÉΓòÉΓòÉ
/*******************************************/
/* This method is specific to version 3, */
/* or higher, of the OS/2 operating */
/* system. This class method allows the */
/* system to build the class default */
/* animation icon for a given class. */
/*******************************************/
#define INCL_WINWORKPLACE
#include <os2.h>
M_WPFolder *somSelf; /* Pointer to the WPFolder class object. */
PICONINFO pIconInfo; /* Pointer to the icon information. */
ULONG ulcbIconInfo; /* Size of the buffer needed to store the ICONINFO data returned by this class object. */
ULONG ulIconIndex; /* Animation icon index. */
_wpclsQueryIconDataN(somSelf, pIconInfo, ulcbIconInfo,
ulIconIndex);
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryIconDataN Parameter - somSelf ΓòÉΓòÉΓòÉ
somSelf (M_WPFolder *) - input
Pointer to the WPFolder class object.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryIconDataN Parameter - pIconInfo ΓòÉΓòÉΓòÉ
pIconInfo (PICONINFO) - input
Pointer to the icon information.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryIconDataN Parameter - ulcbIconInfo ΓòÉΓòÉΓòÉ
ulcbIconInfo (ULONG) - input
Size of the buffer needed to store the ICONINFO data returned by this class
object.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryIconDataN Parameter - ulIconIndex ΓòÉΓòÉΓòÉ
ulIconIndex (ULONG) - input
Animation icon index.
This value must be 1.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryIconDataN - Parameters ΓòÉΓòÉΓòÉ
somSelf (M_WPFolder *) - input
Pointer to the WPFolder class object.
pIconInfo (PICONINFO) - input
Pointer to the icon information.
ulcbIconInfo (ULONG) - input
Size of the buffer needed to store the ICONINFO data returned by this class
object.
ulIconIndex (ULONG) - input
Animation icon index.
This value must be 1.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryIconDataN - Remarks ΓòÉΓòÉΓòÉ
If NULLHANDLE is passed for the pIconInfo parameter, the caller is asking for
the size of the ICONINFO buffer needed for this class usually for memory
allocation purposes. Otherwise, the pIconInfo parameter can always be assumed
to be large enough to accommodate the ICONINFO for this class.
Note that the ICONINFO structure allows you to specify the default icon in
three different ways:
o An icon filename
o A module name and resource identifier
o A block of binary data
However, only one mechanism needs to be supported for any given class. For
example, a caller cannot request one of the three formats by prefilling the
ICONINFO structure.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryIconDataN - Usage ΓòÉΓòÉΓòÉ
This method may be called at any time. Typically, it would not be useful for
another object class to make calls to this method.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryIconDataN - How to Override ΓòÉΓòÉΓòÉ
Workplace classes that wish to have a unique class default animation icon must
override this method and fill out the appropriate fields within the ICONINFO
structure. In addition, the correct size for the ICONINFO must always be
returned.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryIconDataN - Related Methods ΓòÉΓòÉΓòÉ
o wpQueryIcon
o wpQueryIconData
o wpSetIcon
o wpSetIconData
o wpclsQueryIconN
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryIconDataN - Topics ΓòÉΓòÉΓòÉ
Select an item:
Syntax
Parameters
Remarks
How to Override
Usage
Related Methods
Glossary
ΓòÉΓòÉΓòÉ 4.29. wpclsQueryIconN ΓòÉΓòÉΓòÉ
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryIconN - Syntax ΓòÉΓòÉΓòÉ
/*******************************************/
/* This method is specific to version 3, */
/* or higher, of the OS/2 operating */
/* system. This method is called to allow */
/* the class object to specify the default */
/* animation icon to be used for its */
/* instances. */
/*******************************************/
#define INCL_WINWORKPLACE
#include <os2.h>
M_WPFolder *somSelf; /* Pointer to the WPFolder class object. */
ULONG ulIconIndex; /* Animation icon index. */
HPOINTER hptr; /* Handle to the animation icon. */
hptr = _wpclsQueryIconN(somSelf, ulIconIndex);
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryIconN Parameter - somSelf ΓòÉΓòÉΓòÉ
somSelf (M_WPFolder *) - input
Pointer to the WPFolder class object.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryIconN Parameter - ulIconIndex ΓòÉΓòÉΓòÉ
ulIconIndex (ULONG) - input
Animation icon index.
This value must be 1.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryIconN Return Value - hptr ΓòÉΓòÉΓòÉ
hptr (HPOINTER) - returns
Handle to the animation icon.
A return value of NULL indicates that there is no animation icon.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryIconN - Parameters ΓòÉΓòÉΓòÉ
somSelf (M_WPFolder *) - input
Pointer to the WPFolder class object.
ulIconIndex (ULONG) - input
Animation icon index.
This value must be 1.
hptr (HPOINTER) - returns
Handle to the animation icon.
A return value of NULL indicates that there is no animation icon.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryIconN - Remarks ΓòÉΓòÉΓòÉ
This method is very similar to wpclsQueryIcon. The difference is that
wpclsQueryIcon returns the handle for a normal object icon (the closed folder
icon), while wpclsQueryIconN returns the handle for the animation icon (the
open folder icon).
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryIconN - Usage ΓòÉΓòÉΓòÉ
This method can be called at any time.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryIconN - How to Override ΓòÉΓòÉΓòÉ
This method generally not overridden.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryIconN - Related Methods ΓòÉΓòÉΓòÉ
o wpclsQueryIcon
o wpQueryIcon
o wpQueryIconData
o wpSetIcon
o wpSetIconData
o wpclsQueryIconData
o wpclsQueryIconDataN
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryIconN - Topics ΓòÉΓòÉΓòÉ
Select an item:
Syntax
Parameters
Returns
Remarks
How to Override
Usage
Related Methods
Glossary
ΓòÉΓòÉΓòÉ 4.30. wpclsQueryInstanceFilter ΓòÉΓòÉΓòÉ
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryInstanceFilter - Syntax ΓòÉΓòÉΓòÉ
/*******************************************/
/* This method is called to allow the */
/* class object to specify the file title */
/* filters for instances of its class. */
/*******************************************/
#define INCL_WINWORKPLACE
#include <os2.h>
M_WPFileSystem *somSelf; /* Pointer to the WPFileSystem class object. */
PSZ psuccess; /* Success indicator. */
psuccess = _wpclsQueryInstanceFilter(somSelf);
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryInstanceFilter Parameter - somSelf ΓòÉΓòÉΓòÉ
somSelf (M_WPFileSystem *) - input
Pointer to the WPFileSystem class object.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryInstanceFilter Return Value - psuccess ΓòÉΓòÉΓòÉ
psuccess (PSZ) - returns
Success indicator.
NULL Error occurred.
Other A pointer to a string containing file title filters. This
string can contain several file title filters separated by
commas. For example:
"*.TXT, *.DOC"
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryInstanceFilter - Parameters ΓòÉΓòÉΓòÉ
somSelf (M_WPFileSystem *) - input
Pointer to the WPFileSystem class object.
psuccess (PSZ) - returns
Success indicator.
NULL Error occurred.
Other A pointer to a string containing file title filters. This
string can contain several file title filters separated by
commas. For example:
"*.TXT, *.DOC"
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryInstanceFilter - Remarks ΓòÉΓòÉΓòÉ
It is important that the values returned by this class method are restricted to
class-specific filters. For example, returning a filter of "*.*" could
effectively make the system unstable.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryInstanceFilter - Usage ΓòÉΓòÉΓòÉ
This method can be called at any time in order to determine which file title
filters are used to determine instances of this class.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryInstanceFilter - How to Override ΓòÉΓòÉΓòÉ
This method should be overridden in order to automatically designate file
objects as instances of this class. The value returned by the override method
will replace the current title filter string which is used to designate
instances. If the parent method is called, it should be called first.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryInstanceFilter - Related Methods ΓòÉΓòÉΓòÉ
o wpclsQueryInstanceType
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryInstanceFilter - Example Code ΓòÉΓòÉΓòÉ
This example shows how to designate files ending in an extension of .GIF as
being associated with an instance of a GIFPicture object.
SOM_Scope PSZ SOMLINK gifpicM_wpclsQueryInstanceFilter(M_GIFPicture *somSelf)
{
/* M_GIFPictureData *somThis = M_GIFPictureGetData(somSelf); */
M_GIFPictureMethodDebug("M_GIFPicture","gifpicM_wpclsQueryInstanceFilter");
/* return (parent_wpclsQueryInstanceFilter(somSelf)); Don't call parent */
return ( "*.GIF" );
}
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryInstanceFilter - Topics ΓòÉΓòÉΓòÉ
Select an item:
Syntax
Parameters
Returns
Remarks
How to Override
Usage
Example Code
Related Methods
Glossary
ΓòÉΓòÉΓòÉ 4.31. wpclsQueryInstanceType ΓòÉΓòÉΓòÉ
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryInstanceType - Syntax ΓòÉΓòÉΓòÉ
/*******************************************/
/* This method is called to allow the */
/* class object to specify the file types */
/* for instances of its class. */
/*******************************************/
#define INCL_WINWORKPLACE
#include <os2.h>
M_WPFileSystem *somSelf; /* Pointer to the WPFileSystem class object. */
PSZ psuccess; /* Success indicator. */
psuccess = _wpclsQueryInstanceType(somSelf);
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryInstanceType Parameter - somSelf ΓòÉΓòÉΓòÉ
somSelf (M_WPFileSystem *) - input
Pointer to the WPFileSystem class object.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryInstanceType Return Value - psuccess ΓòÉΓòÉΓòÉ
psuccess (PSZ) - returns
Success indicator.
NULL Error occurred.
Other A pointer to a string containing file types. This string can
contain several file types separated by commas. For example:
"Plain Text,C Code"
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryInstanceType - Parameters ΓòÉΓòÉΓòÉ
somSelf (M_WPFileSystem *) - input
Pointer to the WPFileSystem class object.
psuccess (PSZ) - returns
Success indicator.
NULL Error occurred.
Other A pointer to a string containing file types. This string can
contain several file types separated by commas. For example:
"Plain Text,C Code"
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryInstanceType - Remarks ΓòÉΓòÉΓòÉ
It is recommended that object classes define their own special type strings.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryInstanceType - Usage ΓòÉΓòÉΓòÉ
This method can be called at any time in order to determine which file types
are used to determine instances of this class.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryInstanceType - How to Override ΓòÉΓòÉΓòÉ
This method should be overridden in order to automatically designate file
objects as instances of this class. The value returned by the override method
will replace the current type string which is used to designate instances. If
the parent method is called, it should be called first.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryInstanceType - Related Methods ΓòÉΓòÉΓòÉ
o wpclsQueryInstanceFilter
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryInstanceType - Example Code ΓòÉΓòÉΓòÉ
This example associates two file types as being associated with the Picture
object.
SOM_Scope PSZ SOMLINK PictureM_wpclsQueryInstanceType(M_Picture *somSelf)
{
/* M_PictureData *somThis = M_PictureGetData(somSelf); */
M_PictureMethodDebug("M_Picture","PictureM_wpclsQueryInstanceType");
/* return (parent_wpclsQueryInstanceType(somSelf)); no call to parent */
return ( "JPG File,GIF File" );
}
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryInstanceType - Topics ΓòÉΓòÉΓòÉ
Select an item:
Syntax
Parameters
Returns
Remarks
How to Override
Usage
Example Code
Related Methods
Glossary
ΓòÉΓòÉΓòÉ 4.32. wpclsQueryObject ΓòÉΓòÉΓòÉ
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryObject - Syntax ΓòÉΓòÉΓòÉ
/*******************************************/
/* This class method returns the object */
/* pointer for a given persistent object */
/* handle. */
/*******************************************/
#define INCL_WINWORKPLACE
#include <os2.h>
M_WPObject *somSelf; /* Pointer to the WPObject class object. */
HOBJECT hObject; /* Handle for a given object instance. */
WPObject *object; /* Pointer to the object. */
object = _wpclsQueryObject(somSelf, hObject);
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryObject Parameter - somSelf ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryObject Parameter - hObject ΓòÉΓòÉΓòÉ
hObject (HOBJECT) - input
Handle for a given object instance.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryObject Return Value - object ΓòÉΓòÉΓòÉ
object (WPObject *) - returns
Pointer to the object.
The pointer to the object that corresponds to the given object handle or
NULLHANDLE if that object no longer exists.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryObject - Parameters ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
hObject (HOBJECT) - input
Handle for a given object instance.
object (WPObject *) - returns
Pointer to the object.
The pointer to the object that corresponds to the given object handle or
NULLHANDLE if that object no longer exists.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryObject - Remarks ΓòÉΓòÉΓòÉ
All workplace objects can be uniquely identified by a persistent object handle
within a given machine. Once an object handle is obtained for an object (using
the wpQueryHandle instance method), the handle can be used at any subsequent
time even if the system was powered off in the meantime, provided that the
object instance has not been destroyed. This method is intended for use by
objects that wish to communicate with other objects using method calls. At any
point in time, an object can reestablish contact with another object by using
this method. For example, a WPShadow object will use this method to get the
object pointer to the object it is currently shadowing when it is made awake.
Note that the returned object is locked so that the called object can access
the returned pointer without the risk of the object being made dormant. When
the object pointer is no longer needed, the wpUnlockObject method should be
invoked to permit the system to make that object dormant when all other locks
on it have been released.
Using HOBJECT for .INI files or files in which an application uses a
rename/save/delete sequence is not supported.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryObject - Usage ΓòÉΓòÉΓòÉ
This method can be called at any time.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryObject - How to Override ΓòÉΓòÉΓòÉ
This class method is generally not overridden.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryObject - Related Methods ΓòÉΓòÉΓòÉ
o wpclsObjectFromHandle
o wpclsQueryObjectFromFrame
o wpclsQueryObjectFromPath
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryObject - Topics ΓòÉΓòÉΓòÉ
Select an item:
Syntax
Parameters
Returns
Remarks
How to Override
Usage
Related Methods
Glossary
ΓòÉΓòÉΓòÉ 4.33. wpclsQueryObjectFromFrame ΓòÉΓòÉΓòÉ
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryObjectFromFrame - Syntax ΓòÉΓòÉΓòÉ
/*******************************************/
/* This method is specific to version 3, */
/* or higher, of the OS/2 operating */
/* system. This class method returns a */
/* pointer to the object associated with */
/* the specified frame window handle. */
/*******************************************/
#define INCL_WINWORKPLACE
#include <os2.h>
M_WPDesktop *somSelf; /* Pointer to the WPDesktop class object. */
HWND hwndFrame; /* Handle to the top-level frame window. */
WPObject *Object; /* Pointer to the object associated with hwndFrame. */
Object = _wpclsQueryObjectFromFrame(somSelf,
hwndFrame);
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryObjectFromFrame Parameter - somSelf ΓòÉΓòÉΓòÉ
somSelf (M_WPDesktop *) - input
Pointer to the WPDesktop class object.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryObjectFromFrame Parameter - hwndFrame ΓòÉΓòÉΓòÉ
hwndFrame (HWND) - input
Handle to the top-level frame window.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryObjectFromFrame Return Value - Object ΓòÉΓòÉΓòÉ
Object (WPObject *) - returns
Pointer to the object associated with hwndFrame.
This parameter contains a pointer to the object of which its view has the
given frame window handle as its top-level frame window handle.
A return value of NULL indicates that either an associated object could not
be found or an error occurred.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryObjectFromFrame - Parameters ΓòÉΓòÉΓòÉ
somSelf (M_WPDesktop *) - input
Pointer to the WPDesktop class object.
hwndFrame (HWND) - input
Handle to the top-level frame window.
Object (WPObject *) - returns
Pointer to the object associated with hwndFrame.
This parameter contains a pointer to the object of which its view has the
given frame window handle as its top-level frame window handle.
A return value of NULL indicates that either an associated object could not
be found or an error occurred.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryObjectFromFrame - Remarks ΓòÉΓòÉΓòÉ
This method returns the object for which the handle is a view rather than the
application implementing the view.
For example, if the hwndFrame of a folder's view is passed in, this method
returns the folder object. If the hwndFrame of the system editor is passed in,
this method returns the object which is currently being viewed by the editor.
In this case, if an associated object cannot be found, the system editor
program object is returned. For instance, if the system editor is launched from
the command line and its hwndFrame is passed in, the editor program object is
returned.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryObjectFromFrame - Usage ΓòÉΓòÉΓòÉ
This method can be called at any time.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryObjectFromFrame - How to Override ΓòÉΓòÉΓòÉ
This method should not be overridden.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryObjectFromFrame - Related Methods ΓòÉΓòÉΓòÉ
o wpclsQueryObject
o wpclsObjectFromHandle
o wpclsQueryObjectFromPath
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryObjectFromFrame - Topics ΓòÉΓòÉΓòÉ
Select an item:
Syntax
Parameters
Returns
Remarks
How to Override
Usage
Related Methods
Glossary
ΓòÉΓòÉΓòÉ 4.34. wpclsQueryObjectFromPath ΓòÉΓòÉΓòÉ
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryObjectFromPath - Syntax ΓòÉΓòÉΓòÉ
/*******************************************/
/* This method is specific to version 3, */
/* or higher, of the OS/2 operating */
/* system. This class method returns the */
/* object pointer for a file or directory. */
/*******************************************/
#define INCL_WINWORKPLACE
#include <os2.h>
M_WPFileSystem *somSelf; /* Pointer to the WPFileSystem class object. */
PSZ pszFQPath; /* String containing the fully qualified path name (or object ID). */
WPObject *pObject; /* Pointer to the object that represents the file or directory specified in pszFQPath. */
pObject = _wpclsQueryObjectFromPath(somSelf,
pszFQPath);
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryObjectFromPath Parameter - somSelf ΓòÉΓòÉΓòÉ
somSelf (M_WPFileSystem *) - input
Pointer to the WPFileSystem class object.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryObjectFromPath Parameter - pszFQPath ΓòÉΓòÉΓòÉ
pszFQPath (PSZ) - input
String containing the fully qualified path name (or object ID).
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryObjectFromPath Return Value - pObject ΓòÉΓòÉΓòÉ
pObject (WPObject *) - returns
Pointer to the object that represents the file or directory specified in
pszFQPath.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryObjectFromPath - Parameters ΓòÉΓòÉΓòÉ
somSelf (M_WPFileSystem *) - input
Pointer to the WPFileSystem class object.
pszFQPath (PSZ) - input
String containing the fully qualified path name (or object ID).
pObject (WPObject *) - returns
Pointer to the object that represents the file or directory specified in
pszFQPath.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryObjectFromPath - Remarks ΓòÉΓòÉΓòÉ
The object is initially locked, so there is no risk of the object being made
dormant before the object pointer is obtained.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryObjectFromPath - How to Override ΓòÉΓòÉΓòÉ
This method is generally not overridden.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryObjectFromPath - Related Methods ΓòÉΓòÉΓòÉ
o wpclsQueryObject
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryObjectFromPath - Topics ΓòÉΓòÉΓòÉ
Select an item:
Syntax
Parameters
Returns
Remarks
How to Override
Related Methods
Glossary
ΓòÉΓòÉΓòÉ 4.35. wpclsQueryOpenFolders ΓòÉΓòÉΓòÉ
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryOpenFolders - Syntax ΓòÉΓòÉΓòÉ
/*******************************************/
/* This class method enumerates all open */
/* folders for the specified class. */
/*******************************************/
#define INCL_WINWORKPLACE
#include <os2.h>
M_WPFolder *somSelf; /* Pointer to the WPFolder class object. */
WPFolder *Folder; /* Pointer to a folder object. */
ULONG ulOption; /* Flag indicating the folder to query. */
BOOL fLock; /* Lock the object flag. */
WPFolder *FldrObject; /* Pointer to the specified folder object. */
FldrObject = _wpclsQueryOpenFolders(somSelf,
Folder, ulOption, fLock);
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryOpenFolders Parameter - somSelf ΓòÉΓòÉΓòÉ
somSelf (M_WPFolder *) - input
Pointer to the WPFolder class object.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryOpenFolders Parameter - Folder ΓòÉΓòÉΓòÉ
Folder (WPFolder *) - input
Pointer to a folder object.
This field is ignored unless QC_NEXT is specified in ulOption.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryOpenFolders Parameter - ulOption ΓòÉΓòÉΓòÉ
ulOption (ULONG) - input
Flag indicating the folder to query.
Possible values are described in the following list:
QC_FIRST
Return the first open folder in the open-folder list. This value is
specified on the class object if the passed object is not currently
open.
QC_LAST
Return the last open folder.
QC_NEXT
Return the next open folder after Folder in the list.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryOpenFolders Parameter - fLock ΓòÉΓòÉΓòÉ
fLock (BOOL) - input
Lock the object flag.
Possible values are described in the following list:
TRUE
The new flag will remain active until the caller issues wpUnlockObject
on it.
FALSE
The newly created object will be made dormant whenever the object and
the folder containing the object are closed.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryOpenFolders Return Value - FldrObject ΓòÉΓòÉΓòÉ
FldrObject (WPFolder *) - returns
Pointer to the specified folder object.
A return value of NULL indicates that either an error occurred or QC_NEXT
was requested on the last folder.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryOpenFolders - Parameters ΓòÉΓòÉΓòÉ
somSelf (M_WPFolder *) - input
Pointer to the WPFolder class object.
Folder (WPFolder *) - input
Pointer to a folder object.
This field is ignored unless QC_NEXT is specified in ulOption.
ulOption (ULONG) - input
Flag indicating the folder to query.
Possible values are described in the following list:
QC_FIRST
Return the first open folder in the open-folder list. This value is
specified on the class object if the passed object is not currently
open.
QC_LAST
Return the last open folder.
QC_NEXT
Return the next open folder after Folder in the list.
fLock (BOOL) - input
Lock the object flag.
Possible values are described in the following list:
TRUE
The new flag will remain active until the caller issues wpUnlockObject
on it.
FALSE
The newly created object will be made dormant whenever the object and
the folder containing the object are closed.
FldrObject (WPFolder *) - returns
Pointer to the specified folder object.
A return value of NULL indicates that either an error occurred or QC_NEXT
was requested on the last folder.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryOpenFolders - Usage ΓòÉΓòÉΓòÉ
This method can be called at any time.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryOpenFolders - How to Override ΓòÉΓòÉΓòÉ
This method is generally not overridden.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryOpenFolders - Related Methods ΓòÉΓòÉΓòÉ
o wpContainsFolders
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryOpenFolders - Topics ΓòÉΓòÉΓòÉ
Select an item:
Syntax
Parameters
Returns
How to Override
Usage
Related Methods
Glossary
ΓòÉΓòÉΓòÉ 4.36. wpclsQuerySetting ΓòÉΓòÉΓòÉ
ΓòÉΓòÉΓòÉ <hidden> wpclsQuerySetting - Syntax ΓòÉΓòÉΓòÉ
/*******************************************/
/* This method returns the class object */
/* settings from the Settings notebook. */
/*******************************************/
#define INCL_WINWORKPLACE
#include <os2.h>
M_WPAbstract *somSelf; /* Pointer to the WPAbstract class object. */
PSZ pszSetting; /* Name of the setting that is to be queried. */
PVOID pValue; /* Buffer in which settings values are returned. */
ULONG ulValueLen; /* Length of pValue. */
ULONG ulReturnedData; /* Length of data returned in pValue. */
ulReturnedData = _wpclsQuerySetting(somSelf,
pszSetting, pValue, ulValueLen);
ΓòÉΓòÉΓòÉ <hidden> wpclsQuerySetting Parameter - somSelf ΓòÉΓòÉΓòÉ
somSelf (M_WPAbstract *) - input
Pointer to the WPAbstract class object.
ΓòÉΓòÉΓòÉ <hidden> wpclsQuerySetting Parameter - pszSetting ΓòÉΓòÉΓòÉ
pszSetting (PSZ) - input
Name of the setting that is to be queried.
ΓòÉΓòÉΓòÉ <hidden> wpclsQuerySetting Parameter - pValue ΓòÉΓòÉΓòÉ
pValue (PVOID) - in/out
Buffer in which settings values are returned.
If this parameter is NULL, only the length of the value of the setting is
returned.
ΓòÉΓòÉΓòÉ <hidden> wpclsQuerySetting Parameter - ulValueLen ΓòÉΓòÉΓòÉ
ulValueLen (ULONG) - input
Length of pValue.
ΓòÉΓòÉΓòÉ <hidden> wpclsQuerySetting Return Value - ulReturnedData ΓòÉΓòÉΓòÉ
ulReturnedData (ULONG) - returns
Length of data returned in pValue.
A return value of 0 indicates an error occurred, in which case no data is
returned in pValue.
ΓòÉΓòÉΓòÉ <hidden> wpclsQuerySetting - Parameters ΓòÉΓòÉΓòÉ
somSelf (M_WPAbstract *) - input
Pointer to the WPAbstract class object.
pszSetting (PSZ) - input
Name of the setting that is to be queried.
pValue (PVOID) - in/out
Buffer in which settings values are returned.
If this parameter is NULL, only the length of the value of the setting is
returned.
ulValueLen (ULONG) - input
Length of pValue.
ulReturnedData (ULONG) - returns
Length of data returned in pValue.
A return value of 0 indicates an error occurred, in which case no data is
returned in pValue.
ΓòÉΓòÉΓòÉ <hidden> wpclsQuerySetting - Remarks ΓòÉΓòÉΓòÉ
This is a virtual method and must be overridden by a subclass. Each subclass
documents the possible values for pszSetting and pValue. These settings and
values are specific for each subclass. Note that all settings have safe
defaults, so it is never necessary to pass unnecessary settings to an object.
For a list of settings and their associated values, see the individual classes.
ΓòÉΓòÉΓòÉ <hidden> wpclsQuerySetting - Usage ΓòÉΓòÉΓòÉ
This method should never be called. It is a virtual method and must be
overridden by a subclass.
ΓòÉΓòÉΓòÉ <hidden> wpclsQuerySetting - How to Override ΓòÉΓòÉΓòÉ
This is a virtual method and must be overridden by a subclass.
ΓòÉΓòÉΓòÉ <hidden> wpclsQuerySetting - Related Methods ΓòÉΓòÉΓòÉ
o wpclsSetSetting
ΓòÉΓòÉΓòÉ <hidden> wpclsQuerySetting - Topics ΓòÉΓòÉΓòÉ
Select an item:
Syntax
Parameters
Returns
Remarks
How to Override
Usage
Related Methods
Glossary
ΓòÉΓòÉΓòÉ 4.37. wpclsQuerySettingsPageSize ΓòÉΓòÉΓòÉ
ΓòÉΓòÉΓòÉ <hidden> wpclsQuerySettingsPageSize - Syntax ΓòÉΓòÉΓòÉ
/*******************************************/
/* This class method returns the default */
/* size of a Settings page in dialog units */
/* for instances of this object class. */
/*******************************************/
#define INCL_WINWORKPLACE
#include <os2.h>
M_WPObject *somSelf; /* Pointer to the WPObject class object. */
PSIZEL pSizl; /* Pointer to the default Settings page dimensions. */
BOOL rc; /* Success indicator. */
rc = _wpclsQuerySettingsPageSize(somSelf,
pSizl);
ΓòÉΓòÉΓòÉ <hidden> wpclsQuerySettingsPageSize Parameter - somSelf ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
ΓòÉΓòÉΓòÉ <hidden> wpclsQuerySettingsPageSize Parameter - pSizl ΓòÉΓòÉΓòÉ
pSizl (PSIZEL) - in/out
Pointer to the default Settings page dimensions.
A pointer to the SIZEL structure containing the cx and cy dimensions of the
default Settings page for this class.
ΓòÉΓòÉΓòÉ <hidden> wpclsQuerySettingsPageSize Return Value - rc ΓòÉΓòÉΓòÉ
rc (BOOL) - returns
Success indicator.
TRUE The method class call was successful.
FALSE The method class call was unsuccessful.
ΓòÉΓòÉΓòÉ <hidden> wpclsQuerySettingsPageSize - Parameters ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
pSizl (PSIZEL) - in/out
Pointer to the default Settings page dimensions.
A pointer to the SIZEL structure containing the cx and cy dimensions of the
default Settings page for this class.
rc (BOOL) - returns
Success indicator.
TRUE The method class call was successful.
FALSE The method class call was unsuccessful.
ΓòÉΓòÉΓòÉ <hidden> wpclsQuerySettingsPageSize - Remarks ΓòÉΓòÉΓòÉ
An object class that has abnormally shaped Settings pages (for example, the
pages may be very wide) can use this method to ensure that, when a Settings
notebook is initially displayed for an instance of the object class, that
Settings notebook will be of a suitable size to view the whole Settings page
without clipping it. The size specified by this method is used only the very
first time that a Settings notebook is displayed; thereafter, the Settings
notebook size and position will be saved by the system on a per-object basis.
ΓòÉΓòÉΓòÉ <hidden> wpclsQuerySettingsPageSize - Usage ΓòÉΓòÉΓòÉ
This method can be called at any time.
ΓòÉΓòÉΓòÉ <hidden> wpclsQuerySettingsPageSize - How to Override ΓòÉΓòÉΓòÉ
Object classes with unusual size requirements for their Settings pages must
override this class method and change the cx and cy values as necessary to
accommodate their Settings page sizes.
ΓòÉΓòÉΓòÉ <hidden> wpclsQuerySettingsPageSize - Related Methods ΓòÉΓòÉΓòÉ
o wpOpen
ΓòÉΓòÉΓòÉ <hidden> wpclsQuerySettingsPageSize - Example Code ΓòÉΓòÉΓòÉ
This example changes the size of the Settings page for the Person object. This
size is only used when the settings are initially displayed. After that, the
size and position are saved on a per-object basis.
SOM_Scope BOOL SOMLINK PersonM_wpclsQuerySettingsPageSize(M_Person *somSelf,
PSIZEL pSizl)
{
/* M_PersonData *somThis = M_PersonGetData(somSelf); */
M_PersonMethodDebug("M_Person","PersonM_wpclsQuerySettingsPageSize");
pSizl->Cx = 600;
pSizl->Cy = 1200;
/* return (parent_wpclsQuerySettingsPageSize(somSelf,pSizl)); */
return ( TRUE );
}
ΓòÉΓòÉΓòÉ <hidden> wpclsQuerySettingsPageSize - Topics ΓòÉΓòÉΓòÉ
Select an item:
Syntax
Parameters
Returns
Remarks
How to Override
Usage
Example Code
Related Methods
Glossary
ΓòÉΓòÉΓòÉ 4.38. wpclsQueryStyle ΓòÉΓòÉΓòÉ
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryStyle - Syntax ΓòÉΓòÉΓòÉ
/*******************************************/
/* This method is called to allow the */
/* class object to specify the default */
/* object class style for its instances. */
/*******************************************/
#define INCL_WINWORKPLACE
#include <os2.h>
M_WPObject *somSelf; /* Pointer to the WPObject class object. */
ULONG ulReturn; /* Class style for this object. */
ulReturn = _wpclsQueryStyle(somSelf);
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryStyle Parameter - somSelf ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryStyle Return Value - ulReturn ΓòÉΓòÉΓòÉ
ulReturn (ULONG) - returns
Class style for this object.
CLSSTYLE_DONTTEMPLATE
Do not allow a create-template operation on objects of this class.
CLSSTYLE_NEVERCOPY
Do not allow a copy operation on objects of this class.
CLSSTYLE_NEVERDELETE
Do not allow a delete operation on objects of this class.
CLSSTYLE_NEVERDRAG
Do not allow a drag operation on objects of this class.
CLSSTYLE_NEVERDROPON
Do not allow a dropon operation on objects of this class.
CLSSTYLE_NEVERLINK
Do not allow a create-shadow operation on objects of this class.
CLSSTYLE_NEVERMOVE
Do not allow a move operation on objects of this class.
CLSSTYLE_NEVERPRINT
Do not allow a print of this object.
CLSSTYLE_NEVERRENAME
Do not allow the renaming of objects of this class.
CLSSTYLE_NEVERSETTINGS
Do not allow a settings operation on objects of this class.
CLSSTYLE_NEVERVISIBLE
Make instances of this class always invisible.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryStyle - Parameters ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
ulReturn (ULONG) - returns
Class style for this object.
CLSSTYLE_DONTTEMPLATE
Do not allow a create-template operation on objects of this class.
CLSSTYLE_NEVERCOPY
Do not allow a copy operation on objects of this class.
CLSSTYLE_NEVERDELETE
Do not allow a delete operation on objects of this class.
CLSSTYLE_NEVERDRAG
Do not allow a drag operation on objects of this class.
CLSSTYLE_NEVERDROPON
Do not allow a dropon operation on objects of this class.
CLSSTYLE_NEVERLINK
Do not allow a create-shadow operation on objects of this class.
CLSSTYLE_NEVERMOVE
Do not allow a move operation on objects of this class.
CLSSTYLE_NEVERPRINT
Do not allow a print of this object.
CLSSTYLE_NEVERRENAME
Do not allow the renaming of objects of this class.
CLSSTYLE_NEVERSETTINGS
Do not allow a settings operation on objects of this class.
CLSSTYLE_NEVERVISIBLE
Make instances of this class always invisible.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryStyle - Remarks ΓòÉΓòÉΓòÉ
When an instance is initially created, it has the same object style
(OBJSTYLE_xxx) flags as its class style (CLSSTYLE_xxx).
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryStyle - Usage ΓòÉΓòÉΓòÉ
This method can be called at any time in order to determine the default style
for instances of this class.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryStyle - How to Override ΓòÉΓòÉΓòÉ
This method should be overridden in order to modify the default object style
for instances of this class.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryStyle - Related Methods ΓòÉΓòÉΓòÉ
o wpclsQueryStyle
o wpQueryStyle
o wpSetStyle
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryStyle - Example Code ΓòÉΓòÉΓòÉ
This sample shows how to remove the Print option from the menu for BigObject.
SOM_Scope ULONG SOMLINK BigObjectM_wpclsQueryStyle(M_BigObject *somSelf)
{
/* M_BigObjectData *somThis = M_BigObjectGetData(somSelf); */
M_BigObjectMethodDebug("M_BigObject","BigObjectM_wpclsQueryStyle");
return ( parent_wpclsQueryStyle(somSelf) | CLSSTYLE_NEVERPRINT );
}
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryStyle - Topics ΓòÉΓòÉΓòÉ
Select an item:
Syntax
Parameters
Returns
Remarks
How to Override
Usage
Example Code
Related Methods
Glossary
ΓòÉΓòÉΓòÉ 4.39. wpclsQueryTitle ΓòÉΓòÉΓòÉ
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryTitle - Syntax ΓòÉΓòÉΓòÉ
/*******************************************/
/* This method is called to allow the */
/* class object to specify the default */
/* title for its instances. */
/*******************************************/
#define INCL_WINWORKPLACE
#include <os2.h>
M_WPObject *somSelf; /* Pointer to the WPObject class object. */
PSZ pTitle; /* Pointer to the default title for objects of this class. */
pTitle = _wpclsQueryTitle(somSelf);
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryTitle Parameter - somSelf ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryTitle Return Value - pTitle ΓòÉΓòÉΓòÉ
pTitle (PSZ) - returns
Pointer to the default title for objects of this class.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryTitle - Parameters ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
pTitle (PSZ) - returns
Pointer to the default title for objects of this class.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryTitle - Remarks ΓòÉΓòÉΓòÉ
The title is used as the default for new instances of this class. In addition,
the title is used to describe the class in facilities such as Find, Include,
Details, and Sort. The title can be loaded on wpclsInitData and freed on
wpclsUnInitData.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryTitle - Usage ΓòÉΓòÉΓòÉ
This method can be called at any time in order to determine the default title
for instances of this class.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryTitle - How to Override ΓòÉΓòÉΓòÉ
All classes should override this method, so that new objects and their classes
always have a sensible default title.
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryTitle - Related Methods ΓòÉΓòÉΓòÉ
o wpQueryTitle
o wpclsQueryTitle
o wpSetTitle
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryTitle - Example Code ΓòÉΓòÉΓòÉ
This example overrides this method to provide another title.
SOM_Scope PSZ SOMLINK SampleM_wpclsQueryTitle(M_Sample *somSelf)
{
/* M_SampleData *somThis = M_SampleGetData(somSelf); */
M_SampleMethodDebug("M_Sample","SampleM_wpclsQueryTitle");
return( "My WPS Object" ); /* Return a new title */
}
ΓòÉΓòÉΓòÉ <hidden> wpclsQueryTitle - Topics ΓòÉΓòÉΓòÉ
Select an item:
Syntax
Parameters
Returns
Remarks
How to Override
Usage
Example Code
Related Methods
Glossary
ΓòÉΓòÉΓòÉ 4.40. wpclsRemoveObjects ΓòÉΓòÉΓòÉ
ΓòÉΓòÉΓòÉ <hidden> wpclsRemoveObjects - Syntax ΓòÉΓòÉΓòÉ
/*******************************************/
/* This method is specific to version 3, */
/* or higher, of the OS/2 operating */
/* system. This class method removes all */
/* specified objects from a given */
/* container and the in-use list. */
/*******************************************/
#define INCL_WINWORKPLACE
#include <os2.h>
M_WPObject *somSelf; /* Pointer to the WPObject class object. */
HWND hwndCnr; /* Handle to the container object. */
PVOID *pRecordArray; /* Pointer to an array of MINIRECORDCORE objects that are to be removed. */
ULONG NumRecords; /* Number of records in pRecordArray. */
BOOL RemoveAll; /* Flag indicating whether to remove all records. */
BOOL rc; /* Success indicator. */
rc = _wpclsRemoveObjects(somSelf, hwndCnr,
pRecordArray, NumRecords, RemoveAll);
ΓòÉΓòÉΓòÉ <hidden> wpclsRemoveObjects Parameter - somSelf ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
ΓòÉΓòÉΓòÉ <hidden> wpclsRemoveObjects Parameter - hwndCnr ΓòÉΓòÉΓòÉ
hwndCnr (HWND) - input
Handle to the container object.
ΓòÉΓòÉΓòÉ <hidden> wpclsRemoveObjects Parameter - pRecordArray ΓòÉΓòÉΓòÉ
pRecordArray (PVOID *) - input
Pointer to an array of MINIRECORDCORE objects that are to be removed.
ΓòÉΓòÉΓòÉ <hidden> wpclsRemoveObjects Parameter - NumRecords ΓòÉΓòÉΓòÉ
NumRecords (ULONG) - input
Number of records in pRecordArray.
ΓòÉΓòÉΓòÉ <hidden> wpclsRemoveObjects Parameter - RemoveAll ΓòÉΓòÉΓòÉ
RemoveAll (BOOL) - input
Flag indicating whether to remove all records.
Possible values are described in the following list:
TRUE
All records in the specified container are to be removed, and the
in-use list for each object is to be cleaned up.
FALSE
Only records specified in pRecordArray are to be removed, and the
in-use list is to be cleaned up for the same objects.
ΓòÉΓòÉΓòÉ <hidden> wpclsRemoveObjects Return Value - rc ΓòÉΓòÉΓòÉ
rc (BOOL) - returns
Success indicator.
TRUE
Successful completion.
FALSE
Error occurred.
ΓòÉΓòÉΓòÉ <hidden> wpclsRemoveObjects - Parameters ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
hwndCnr (HWND) - input
Handle to the container object.
pRecordArray (PVOID *) - input
Pointer to an array of MINIRECORDCORE objects that are to be removed.
NumRecords (ULONG) - input
Number of records in pRecordArray.
RemoveAll (BOOL) - input
Flag indicating whether to remove all records.
Possible values are described in the following list:
TRUE
All records in the specified container are to be removed, and the
in-use list for each object is to be cleaned up.
FALSE
Only records specified in pRecordArray are to be removed, and the
in-use list is to be cleaned up for the same objects.
rc (BOOL) - returns
Success indicator.
TRUE
Successful completion.
FALSE
Error occurred.
ΓòÉΓòÉΓòÉ <hidden> wpclsRemoveObjects - Remarks ΓòÉΓòÉΓòÉ
This method provides rapid removal of multiple objects from a container at one
time. wpCnrRemoveObject performs the same function as this method, but it
operates only on one object at a time.
ΓòÉΓòÉΓòÉ <hidden> wpclsRemoveObjects - Usage ΓòÉΓòÉΓòÉ
This method can be called at any time to remove multiple objects from the
container.
ΓòÉΓòÉΓòÉ <hidden> wpclsRemoveObjects - How to Override ΓòÉΓòÉΓòÉ
This method is generally not overridden.
ΓòÉΓòÉΓòÉ <hidden> wpclsRemoveObjects - Related Methods ΓòÉΓòÉΓòÉ
o wpCnrInsertObject
o wpCnrRemoveObject
o wpclsInsertMultipleObjects
ΓòÉΓòÉΓòÉ <hidden> wpclsRemoveObjects - Topics ΓòÉΓòÉΓòÉ
Select an item:
Syntax
Parameters
Returns
Remarks
How to Override
Usage
Related Methods
Glossary
ΓòÉΓòÉΓòÉ 4.41. wpclsSetError ΓòÉΓòÉΓòÉ
ΓòÉΓòÉΓòÉ <hidden> wpclsSetError - Syntax ΓòÉΓòÉΓòÉ
/*******************************************/
/* This class method sets the current */
/* error code within a class object. */
/*******************************************/
#define INCL_WINWORKPLACE
#include <os2.h>
M_WPObject *somSelf; /* Pointer to the WPObject class object. */
ULONG ulErrorId; /* Error code. */
BOOL rc; /* Success indicator. */
rc = _wpclsSetError(somSelf, ulErrorId);
ΓòÉΓòÉΓòÉ <hidden> wpclsSetError Parameter - somSelf ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
ΓòÉΓòÉΓòÉ <hidden> wpclsSetError Parameter - ulErrorId ΓòÉΓòÉΓòÉ
ulErrorId (ULONG) - input
Error code.
ΓòÉΓòÉΓòÉ <hidden> wpclsSetError Return Value - rc ΓòÉΓòÉΓòÉ
rc (BOOL) - returns
Success indicator.
TRUE The error was successfully stored.
FALSE The error was not successfully stored.
ΓòÉΓòÉΓòÉ <hidden> wpclsSetError - Parameters ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
ulErrorId (ULONG) - input
Error code.
rc (BOOL) - returns
Success indicator.
TRUE The error was successfully stored.
FALSE The error was not successfully stored.
ΓòÉΓòÉΓòÉ <hidden> wpclsSetError - Remarks ΓòÉΓòÉΓòÉ
This method can be used when writing class methods for workplace objects that
return BOOLEAN values. When a given class method fails, the class method can
log its error code in the class object so that the caller can later retrieve it
using the wpclsQueryError class method. The function is analogous to the
WinSetErrorInfo function call that is used by Presentation Manager functions to
log their error return codes.
ΓòÉΓòÉΓòÉ <hidden> wpclsSetError - Usage ΓòÉΓòÉΓòÉ
It is recommended that this method be called only by all class methods when
they do not execute successfully and nowhere else.
ΓòÉΓòÉΓòÉ <hidden> wpclsSetError - How to Override ΓòÉΓòÉΓòÉ
Never override this class method.
ΓòÉΓòÉΓòÉ <hidden> wpclsSetError - Related Methods ΓòÉΓòÉΓòÉ
o wpclsQueryError
ΓòÉΓòÉΓòÉ <hidden> wpclsSetError - Example Code ΓòÉΓòÉΓòÉ
This example finds all occurrences of an object type in a folder.
VOID clsFindEverybody(SOMAny *self)
{
BOOL rc; /* Return from methods */
HFIND hFind = 0; /* Handle for repeated finds */
CLASS Class[2]; /* List of classes to look for */
OBJECT Object[10]; /* Objects returned from search */
ULONG ulCount = 10; /* Count of objects to find / or found */
WPFolder *folder = 0; /* Pointer to folder for search */
ULONG errorid = 0; /* Error returned from previous search */
CHAR sz[CCHMAXPATH]; /* Title string to look for */
PSZ title = sz;
Class[0] = _WPFolder;
Class[1] = NULL;
/* Get the pointer to the desktop (since that is where we are looking) */
folder = _wpclsQueryFolder( _WPFolder, "<WP_DESKTOP>", TRUE );
_wpclsSetError( _WPObject, 0 ); /* Reset the error indicators */
rc = 0;
/* Attempt to find the first 10 objects matching our criteria */
ulCount = 10;
rc =_wpclsFindObjectFirst(_WPObject, /* Class self pointer */
Class, /* Pointer to array of class objects */
&hFind, /* Handle for wpclsFindObjectNext */
NULL, /* Find EVERYTHING */
folder, /* Pointer to folder of interest */
TRUE, /* Search all folders in tree */
NULL, /* No extended criteria */
Object, /* Array of object pointers */
&ulCount ); /* Number requested and number found */
errorid = _wpclsQueryError( _WPObject); /* Get errorid (may still be OK) */
if ((!rc && (errorid == WPERR_BUFFER_OVERFLOW)) || rc) {
/***** Process objects found here ******/
} else {
somPrintf(" _wpclsFindObjectFirst failed, errorid=%u\n", errorid );
return;
} /* endif */
do {
_wpclsSetError( _WPObject, 0 ); /* Reset error indicators */
rc = 0;
/* Look for next 10 objects */
rc =_wpclsFindObjectNext(_WPObject, /* Self */
hFind, /* Handle from previous Find */
Object, /* Objects found */
&ulCount ); /* Number to look for. On
return, number found */
errorid = _wpclsQueryError( _WPObject );
if ((!rc && (errorid == WPERR_BUFFER_OVERFLOW)) || rc) {
/***** Process objects found here ******/
} else {
somPrintf("_wpclsFindObjectNext failed, errorid=%u\n", errorid);
return;
} /* endif */
} while ( errorid == WPERR_BUFFER_OVERFLOW ); /* enddo */
_wpclsSetError( _WPObject, 0 ); /* Reset error indicators */
rc = 0;
/* Indicate find complete */
rc =_wpclsFindObjectEnd( _WPObject, hFind );
if (!rc) {
errorid = _wpclsQueryError( _WPObject );
somPrintf( "_wpclsFindObjectEnd failed, errorid=%u\n", errorid );
return;
}
return;
}
ΓòÉΓòÉΓòÉ <hidden> wpclsSetError - Topics ΓòÉΓòÉΓòÉ
Select an item:
Syntax
Parameters
Returns
Remarks
How to Override
Usage
Example Code
Related Methods
Glossary
ΓòÉΓòÉΓòÉ 4.42. wpclsSetIcon ΓòÉΓòÉΓòÉ
ΓòÉΓòÉΓòÉ <hidden> wpclsSetIcon - Syntax ΓòÉΓòÉΓòÉ
/*******************************************/
/* This method is specific to version 3, */
/* or higher, of the OS/2 operating */
/* system. This class method sets the */
/* icon handle for a given object. */
/*******************************************/
#define INCL_WINWORKPLACE
#include <os2.h>
M_WPObject *somSelf; /* Pointer to the WPObject class object. */
HPOINTER hptrNewIcon; /* Icon handle to be set for the object. */
BOOL rc; /* Success indicator. */
rc = _wpclsSetIcon(somSelf, hptrNewIcon);
ΓòÉΓòÉΓòÉ <hidden> wpclsSetIcon Parameter - somSelf ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
ΓòÉΓòÉΓòÉ <hidden> wpclsSetIcon Parameter - hptrNewIcon ΓòÉΓòÉΓòÉ
hptrNewIcon (HPOINTER) - input
Icon handle to be set for the object.
ΓòÉΓòÉΓòÉ <hidden> wpclsSetIcon Return Value - rc ΓòÉΓòÉΓòÉ
rc (BOOL) - returns
Success indicator.
TRUE Successful completion.
FALSE Error occurred.
ΓòÉΓòÉΓòÉ <hidden> wpclsSetIcon - Parameters ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
hptrNewIcon (HPOINTER) - input
Icon handle to be set for the object.
rc (BOOL) - returns
Success indicator.
TRUE Successful completion.
FALSE Error occurred.
ΓòÉΓòÉΓòÉ <hidden> wpclsSetIcon - Remarks ΓòÉΓòÉΓòÉ
The class default icon can be loaded using wpclsInitData and freed using
wpclsUnInitData.
ΓòÉΓòÉΓòÉ <hidden> wpclsSetIcon - Usage ΓòÉΓòÉΓòÉ
This method can be called at any time to set the object's default icon.
ΓòÉΓòÉΓòÉ <hidden> wpclsSetIcon - How to Override ΓòÉΓòÉΓòÉ
This method is generally not overridden.
ΓòÉΓòÉΓòÉ <hidden> wpclsSetIcon - Related Methods ΓòÉΓòÉΓòÉ
o wpclsQueryIcon
o wpQueryIcon
o wpQueryIconData
o wpSetIcon
o wpSetIconData
o wpclsQueryIcon
o wpclsQueryIconData
ΓòÉΓòÉΓòÉ <hidden> wpclsSetIcon - Topics ΓòÉΓòÉΓòÉ
Select an item:
Syntax
Parameters
Returns
Remarks
How to Override
Usage
Related Methods
Glossary
ΓòÉΓòÉΓòÉ 4.43. wpclsSetIconData ΓòÉΓòÉΓòÉ
ΓòÉΓòÉΓòÉ <hidden> wpclsSetIconData - Syntax ΓòÉΓòÉΓòÉ
/*******************************************/
/* This method is specific to version 3, */
/* or higher, of the OS/2 operating */
/* system. This class method sets the */
/* icon information for a given object. */
/*******************************************/
#define INCL_WINWORKPLACE
#include <os2.h>
M_WPObject *somSelf; /* Pointer to the WPObject class object. */
PICONINFO pIconInfo; /* Pointer to the icon information structure. */
BOOL rc; /* Success indicator. */
rc = _wpclsSetIconData(somSelf, pIconInfo);
ΓòÉΓòÉΓòÉ <hidden> wpclsSetIconData Parameter - somSelf ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
ΓòÉΓòÉΓòÉ <hidden> wpclsSetIconData Parameter - pIconInfo ΓòÉΓòÉΓòÉ
pIconInfo (PICONINFO) - input
Pointer to the icon information structure.
ΓòÉΓòÉΓòÉ <hidden> wpclsSetIconData Return Value - rc ΓòÉΓòÉΓòÉ
rc (BOOL) - returns
Success indicator.
TRUE
Successful completion.
FALSE
Error occurred.
ΓòÉΓòÉΓòÉ <hidden> wpclsSetIconData - Parameters ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
pIconInfo (PICONINFO) - input
Pointer to the icon information structure.
rc (BOOL) - returns
Success indicator.
TRUE
Successful completion.
FALSE
Error occurred.
ΓòÉΓòÉΓòÉ <hidden> wpclsSetIconData - Usage ΓòÉΓòÉΓòÉ
This method can be called at any time to set icon information.
ΓòÉΓòÉΓòÉ <hidden> wpclsSetIconData - How to Override ΓòÉΓòÉΓòÉ
ΓòÉΓòÉΓòÉ <hidden> wpclsSetIconData - Related Methods ΓòÉΓòÉΓòÉ
o wpclsQueryIcon
o wpQueryIcon
o wpQueryIconData
o wpSetIcon
o wpSetIconData
o wpclsQueryIconData
ΓòÉΓòÉΓòÉ <hidden> wpclsSetIconData - Topics ΓòÉΓòÉΓòÉ
Select an item:
Syntax
Parameters
Returns
How to Override
Usage
Related Methods
Glossary
ΓòÉΓòÉΓòÉ 4.44. wpclsSetSetting ΓòÉΓòÉΓòÉ
ΓòÉΓòÉΓòÉ <hidden> wpclsSetSetting - Syntax ΓòÉΓòÉΓòÉ
/*******************************************/
/* This method sets the class object */
/* settings in the Settings notebook. */
/*******************************************/
#define INCL_WINWORKPLACE
#include <os2.h>
M_WPAbstract *somSelf; /* Pointer to the WPAbstract class object. */
PSZ pszSetting; /* Name of the setting that is to be set. */
PVOID pValue; /* Buffer which contains setting values. */
BOOL rc; /* Success indicator. */
rc = _wpclsSetSetting(somSelf, pszSetting,
pValue);
ΓòÉΓòÉΓòÉ <hidden> wpclsSetSetting Parameter - somSelf ΓòÉΓòÉΓòÉ
somSelf (M_WPAbstract *) - input
Pointer to the WPAbstract class object.
ΓòÉΓòÉΓòÉ <hidden> wpclsSetSetting Parameter - pszSetting ΓòÉΓòÉΓòÉ
pszSetting (PSZ) - input
Name of the setting that is to be set.
ΓòÉΓòÉΓòÉ <hidden> wpclsSetSetting Parameter - pValue ΓòÉΓòÉΓòÉ
pValue (PVOID) - input
Buffer which contains setting values.
ΓòÉΓòÉΓòÉ <hidden> wpclsSetSetting Return Value - rc ΓòÉΓòÉΓòÉ
rc (BOOL) - returns
Success indicator.
TRUE
Successful completion.
FALSE
Error occurred.
ΓòÉΓòÉΓòÉ <hidden> wpclsSetSetting - Parameters ΓòÉΓòÉΓòÉ
somSelf (M_WPAbstract *) - input
Pointer to the WPAbstract class object.
pszSetting (PSZ) - input
Name of the setting that is to be set.
pValue (PVOID) - input
Buffer which contains setting values.
rc (BOOL) - returns
Success indicator.
TRUE
Successful completion.
FALSE
Error occurred.
ΓòÉΓòÉΓòÉ <hidden> wpclsSetSetting - Remarks ΓòÉΓòÉΓòÉ
This is a virtual method and must be overridden by a subclass. Each object
subclass documents the possible values for pszSetting and pValue. These
settings and values are specific for each subclass. Note that all settings have
safe defaults, so it is never necessary to pass unnecessary settings to an
object.
For a list of settings and their associated values, see the individual classes.
ΓòÉΓòÉΓòÉ <hidden> wpclsSetSetting - Usage ΓòÉΓòÉΓòÉ
This method should never be called. It is a virtual method and must be
overridden by a subclass.
ΓòÉΓòÉΓòÉ <hidden> wpclsSetSetting - How to Override ΓòÉΓòÉΓòÉ
This is a virtual method and must be overridden by a subclass.
ΓòÉΓòÉΓòÉ <hidden> wpclsSetSetting - Related Methods ΓòÉΓòÉΓòÉ
o wpclsSetSetting
ΓòÉΓòÉΓòÉ <hidden> wpclsSetSetting - Topics ΓòÉΓòÉΓòÉ
Select an item:
Syntax
Parameters
Returns
Remarks
How to Override
Usage
Related Methods
Glossary
ΓòÉΓòÉΓòÉ 4.45. wpclsSetSettingsPageSize ΓòÉΓòÉΓòÉ
ΓòÉΓòÉΓòÉ <hidden> wpclsSetSettingsPageSize - Syntax ΓòÉΓòÉΓòÉ
/*******************************************/
/* This method is specific to version 3, */
/* or higher, of the OS/2 operating */
/* system. This class method returns the */
/* default Settings page size. */
/*******************************************/
#define INCL_WINWORKPLACE
#include <os2.h>
M_WPObject *somSelf; /* Pointer to the WPObject class object. */
PSIZEL pSizel; /* Pointer to the structure containing the default width and height of the Settings page. */
BOOL rc; /* Success indicator. */
rc = _wpclsSetSettingsPageSize(somSelf, pSizel);
ΓòÉΓòÉΓòÉ <hidden> wpclsSetSettingsPageSize Parameter - somSelf ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
ΓòÉΓòÉΓòÉ <hidden> wpclsSetSettingsPageSize Parameter - pSizel ΓòÉΓòÉΓòÉ
pSizel (PSIZEL) - input
Pointer to the structure containing the default width and height of the
Settings page.
ΓòÉΓòÉΓòÉ <hidden> wpclsSetSettingsPageSize Return Value - rc ΓòÉΓòÉΓòÉ
rc (BOOL) - returns
Success indicator.
TRUE
Successful completion.
FALSE
Error occurred.
ΓòÉΓòÉΓòÉ <hidden> wpclsSetSettingsPageSize - Parameters ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
pSizel (PSIZEL) - input
Pointer to the structure containing the default width and height of the
Settings page.
rc (BOOL) - returns
Success indicator.
TRUE
Successful completion.
FALSE
Error occurred.
ΓòÉΓòÉΓòÉ <hidden> wpclsSetSettingsPageSize - How to Override ΓòÉΓòÉΓòÉ
This method is generally not overridden.
ΓòÉΓòÉΓòÉ <hidden> wpclsSetSettingsPageSize - Topics ΓòÉΓòÉΓòÉ
Select an item:
Syntax
Parameters
Returns
How to Override
Glossary
ΓòÉΓòÉΓòÉ 4.46. wpclsUnInitData ΓòÉΓòÉΓòÉ
ΓòÉΓòÉΓòÉ <hidden> wpclsUnInitData - Syntax ΓòÉΓòÉΓòÉ
/*******************************************/
/* This method is called to allow the */
/* class object to free allocated */
/* resources. */
/*******************************************/
#define INCL_WINWORKPLACE
#include <os2.h>
M_WPObject *somSelf; /* Pointer to the WPObject class object. */
wpclsUnInitData(somSelf);
ΓòÉΓòÉΓòÉ <hidden> wpclsUnInitData Parameter - somSelf ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
ΓòÉΓòÉΓòÉ <hidden> wpclsUnInitData - Return Value ΓòÉΓòÉΓòÉ
There is no return value for this method.
ΓòÉΓòÉΓòÉ <hidden> wpclsUnInitData - Parameters ΓòÉΓòÉΓòÉ
somSelf (M_WPObject *) - input
Pointer to the WPObject class object.
There is no return value for this method.
ΓòÉΓòÉΓòÉ <hidden> wpclsUnInitData - Usage ΓòÉΓòÉΓòÉ
This method is generally called only by the system when the class object is
made dormant. The class object is made dormant when the last instance of this
class is made dormant.
ΓòÉΓòÉΓòÉ <hidden> wpclsUnInitData - How to Override ΓòÉΓòÉΓòÉ
Any class that overrides the wpclsInitData method to allocate resources for its
metaclass instance variables should override this method to deallocate those
resources. It is essential to pass this method onto the parent class object
after performing override processing.
ΓòÉΓòÉΓòÉ <hidden> wpclsUnInitData - Related Methods ΓòÉΓòÉΓòÉ
o wpclsInitData
ΓòÉΓòÉΓòÉ <hidden> wpclsUnInitData - Example Code ΓòÉΓòÉΓòÉ
This example overrides the method to free any data associated with the class.
SOM_Scope void SOMLINK BearsM_wpclsUnInitData(M_Bears *somSelf)
{
APIRET rc = NO_ERROR; /* Return code from Dos API */
M_BearsData *somThis = M_BearsGetData(somSelf);
M_BearsMethodDebug("M_Bears","myfM_wpclsUnInitData");
rc = DosFreeMem( _pBearClassData );
parent_wpclsUnInitData(somSelf);
}
ΓòÉΓòÉΓòÉ <hidden> wpclsUnInitData - Topics ΓòÉΓòÉΓòÉ
Select an item:
Syntax
Parameters
Returns
How to Override
Usage
Example Code
Related Methods
Glossary