These are the setup strings for the new WPUrl objects in WARP 4. In WARP 3 you should use the object class WebExplorer_Url. (see also Default Settings for WPUrl Objects and Getting the filename of WPDatafile objects)
Class WPUrl
Key Name Value Description
----------------------------------------------------------------------
BROWSER name or This specifies the executable that
pathname will be invoked to display the web
page designated in the "Url" field.
This field can be either a pathname
or a name of a browser in the PATH.
EXPLORE.EXE is the default browser
for OS/2 WARP. The Java applet
viewer (APPLET.EXE) can be used here
to view Java applets with the URL
object, but be sure to set the
"Integrated browser" check box on
the Browser page to NO, because
APPLET.EXE does not understand the
URL-specific browser options.
DEFAULTBROWSER name or This sets the default value for
pathname BROWSER for all URL objects. This
value will be placed in the "Path
and file name" field on the Browser
page of a URL's properties notebook
when the Default push button is
pressed and when the URL object is
first created.
Also see the definition for BROWSER.
DEFAULTDISPLAYIMAGES
YES This sets the default value for
DISPLAYIMAGES for all URL objects.
This value is used for the "Display
images while loading" check box of a
URL's properties notebook when the
Default push button is pressed or
when the URL object is first
created. When this keyname is set
to YES, the "Display images while
loading" check box is checked.
Also see the definition for
DISPLAYIMAGES.
NO The "Display images while loading"
check box is unchecked.
Also see the definition for
DISPLAYIMAGES.
DEFAULTEMAILADDRESS
address This sets the default value for
EMAILADDRESS for all URL objects.
This value will be placed in the
"Electronic mail address" field on
the Server page of a URL's
properties notebook when the Default
push button is pressed and when the
URL object is first created.
Also see the definition for
EMAILADDRESS.
DEFAULTENABLEPROXY
YES This sets the default value for
ENABLEPROXY for all URL objects.
The "Proxy gateway" check box on the
Server page of a URL's properties
notebook is checked when the Default
push button is pressed and when the
URL object is first created.
Also see the definition for
ENABLEPROXY.
NO The "Proxy gateway" check box is
unchecked.
Also see the definition for
ENABLEPROXY.
DEFAULTENABLESOCKS
YES This sets the default value for
ENABLESOCKS for all URL objects.
The "Socks server" check box on the
Server page of a URL's properties
notebook is checked when the Default
push button is pressed or when the
URL object is first created.
Also see the definition for
ENABLESOCKS.
NO The "Socks server" check box is
unchecked.
Also see the definition for
ENABLESOCKS.
DEFAULTINTEGRATEDBROWSER
YES This sets the default value for
INTEGRATEDBROWSER for all URL
objects. The "Integrated browser"
check box on the Browser page of a
URL's properties notebook is checked
when the Default push button is
pressed or when the URL object is
first created.
Also see the definition for
INTEGRATEDBROWSER.
NO The "Proxy gateway" check box is
unchecked.
Also see the definition for
INTEGRATEDBROWSER.
DEFAULTLOADGRAPHICS
YES This sets the default value for
LOADGRAPHICS for all URL objects.
The "Load graphics" check box on the
Browser page of a URL's properties
notebook is checked when the Default
push button is pressed or when the
URL object is first created.
Also see the definition for
LOADGRAPHICS.
NO The "Load graphics" check box is
unchecked.
Also see the definition for
LOADGRAPHICS.
DEFAULTNEWSSERVER
newsserver This sets the default value for
NEWSERVER for all URL objects. This
value will be placed in the
"Newsserver" field on the Server
page of a URL's properties notebook
when the Default push button is
pressed and when the URL object is
first created.
Also see the definition for
NEWSERVER.
DEFAULTPALETTEAWARE
YES This sets the default value for
PALETTEAWARE for all URL objects.
The "Palette aware" check box on the
Web page of a URL's properties
notebook is checked when the Default
push button is pressed or when the
URL object is first created.
Also see the definition for
PALETTEAWARE.
NO The "Palette aware" check box is
unchecked.
Also see the definition for
PALETTEAWARE.
DEFAULTPARAMETERS
parameters This sets the default value for
PARAMETERS for all URL objects.
This value will be placed in the
"Parameters" field on the Browser
page of a URL's properties notebook
when the Default push button is
pressed and when the URL object is
first created.
Also see the definition for
PARAMETERS.
DEFAULTPRESENTATIONMODE
YES This sets the default value for
PRESENTATIONMODE for all URL
objects. The "Presentation mode"
check box on the Web page of a URL's
properties notebook is checked when
the Default push button is pressed
or when the URL object is first
created.
Also see the definition for
PRESENTATIONMODE.
NO The "Presentation mode" check box is
unchecked.
Also see the definition for
PRESENTATIONMODE.
DEFAULTPROXYGATEWAY
proxy This sets the default value for
PROXYGATEWAY for all URL objects.
This value will be placed in the
"Proxy gatewway" field on the Server
page of a URL's properties notebook
when the Default push button is
pressed and when the URL object is
first created.
Also see the definition for
PROXYGATEWAY.
DEFAULTSOCKSSERVER
socks This sets the default value for
SOCKSERVER for all URL objects.
This value will be placed in the
"Socks server" field on the Server
page of a URL's properties notebook
when the Default push button is
pressed and when the URL object is
first created.
Also see the definition for
SOCKSERVER.
DEFAULTWORKINGDIR
directory This sets the default value for
WORKINGDIR for all URL objects.
This value will be placed in the
"Working directory" field on the
Server page of a URL's properties
notebook when the Default push
button is pressed and when the URL
object is first created.
Also see the definition for
WORKINGDIR.
DISPLAYIMAGES YES This specifies that the browser show
the images as they are being
constructed on the page while being
received from the server. This is
the default value for the "Display
images while loading" check box on
the Web page.
NO The "Display images while loading"
check box is unchecked. This
specifies that the browser show the
page when all of the images have
been received from the server.
EMAILADDRESS address This is a required field. This
specifies the user's return e-mail
address to be used by the browser
when responding to other users on
mail-to fields of web pages or
newsgroup articles. This should be
the complete internet e-mail
address. For example:
marysmith.@ibm.net
Leaving this field blank will
prevent you from responding to
mail-to fields and newsgroup
articles.
ENABLEPROXY YES This sets the default value for
PROXYGATEWAY for all URL objects.
If the "Enable proxy?" check box on
the Server page is checked. the
proxy server will be used.
NO If the "Enable proxy?" check box is
not checked, the proxy server will
not be used.
INTEGRATEDBROWSER
YES This sets the default value for
BROWSER for all URL objects. If the
"Integrated browser" check box on
the Browser page is checked, this
specified that the designated
executable has been integrated with
the URL object.
For example, the IBM WebExplorer
browser has been integrated, you
would specify YES if you are using
EXPLORE.EXE. The Java Applet viewer
is not integrated if you are using
APPLET.EXE.
Other browsers might not be
integrated with the URL object.
Check the documentation provided
with your browser.
NO If the "Integrated browser" check
box is not checked, you will be
unable to use certain browser
parameters (for example, Palette
Aware, Presentation Mode, and Load
Graphics) because a non-integrated
browser cannot interpret these
command-line arguments.
LOADGRAPHICS YES This specifies that you can load
graphics and images on the web page
specified by the URL if the "Load
graphics" check box on the Web page
is checked.
NO If the "Load graphics" check box is
not checked, will only be able to
view text, but not graphics, on a
web page. This will speed up page
downloads if you specific not to
load graphics.
LOCATOR url This specifies the Uniform Resource
Locator that uniquely identifies
each web page designated in the
"Uniform Resource Locator (URL)"
field on the Web page.
The URL is the address for the page
on the web. For example:
http://www.ibm.net
The keywords LOCATOR and URL can be
used interchangeably.
NEWSERVER news This specifies the host name or IP
address of the server that handles
newsgroups for the user's company or
account. The first example is a
host name and the second example is
an IP address:
news.company.com
or
128.35.89.2
PALETTEAWARE YES This is the default value for
BROWSER for all URL objects. This
value will be placed in the
"Paletteaware" check box on the Web
page. This specifies that the OS/2
palette be used to display pages and
images.
NO The "Paletteaware" check box on the
Web page will not be checked. If
color problems are detected while
displaying web pages with your
browser, set this value to NO.
PARAMETERS params This specifies strings to be
included on the command line
invocation of (passed to) the
executable designated when it is
started. If the browser being used
permits optional parameters, declare
them using this value.
This sets the default value for
BROWSER for all URL objects. This
value will be placed in the
"Parameters" field on the Browser
page.
PRESENTATIONMODE
YES This specifies that the browser use
the full-screen (nonwindowed) mode.
This mode is generally used for
presentations. This value is used
for the "Presentation mode" check
box on the Web page. This is the
default value, which specifies that
the executable use the OS/2 palette
to display its pages and images.
NO The "Presentation mode" check box
will not be checked. If color
problems are detected while
displaying web pages with your
browser, set this value to NO.
PROXYGATEWAY proxy This specifies the URL of the server
that handles the interface to the
web for the user's company or
account. It is the firewall for
insulation of a company from the
outside world. A proxy port can
also be appended to the end of the
proxy string if the proxy server
supports it. For example:
http://proxy.company.com/
or
http://128.35.89.2/
A proxy port can also be appended to
the end of the proxy string if the
proxy server supports it. For
example:
http://proxy.company.com:80/
This value will be placed in the
"Proxy gateway" field on the Server
page. The slash on the end is
required syntax.
Contact your system administrator
for details about using a proxy
gateway server on your system.
SOCKSERVER socks This specifies the socks support
that will provide access the web
through a firewall, which provides
for insulation of a company from the
outside world. This value is placed
in the "Socks server" field on the
Server page.
For example:
http://socks.company.com/
or
http:/socks.company.com:80/
The slash on the end is required
syntax.
WORKINGDIR directory This specifies OS/2 working
directory for the executable, if
required, and sets the default value
for BROWSER for all URL objects.
This value will be placed in the
"Working directory" field on the
Browser page. A working directory
is required if the specified browser
requires DLLs or other files from a
directory not specified in the
LIBPATH or other environment
variables.
URL url This specifies the Uniform Resource
Locator that uniquely identifies
each web page designated in the
"Uniform Resource Locator (URL)"
field on the web page.
The URL is the address for a page on
the web. For example, an URL might
be:
http:/www.ibm.net
The keywords URL and LOCATOR can be
used interchangeably.
Source: Workplace Shell Programming Reference (OS/2 WARP Toolkit)