view
view(
t_file
[ g_boxSpec ]
[ g_title ]
[ g_autoUpdate ]
[ l_iconPosition ]
[ g_deviceMode ]
)
=> w_windowId / nil
Description
Creates a viewfile window, inserts the menu bar, sets the window and icon names, specifies how to load the file in the window, and displays the file in the window. view is a wrapper function.
Arguments
|
t_file
|
File name to view. This is the only required argument for this function.
|
|
g_boxSpec
|
Screen coordinates of the lower left and upper right corners of the window (assuming 0:0 to be the lower left corner of the screen). If g_boxSpec is nil, either you are prompted with a rubberbanding box to enter a window size, or a default size is used, depending on the value of the global variable hivWinStyle. The ’default and ’interactive symbols are also acceptable values for the g_boxSpec argument. If g_boxSpec is a window ID, the widget type of the window is changed to text, if it isn’t already.
|
|
g_title
|
Title for the window. This title appears in the window manager banner of the viewfile window. If not specified, the file name is used.
|
|
g_autoUpdate
|
Determines whether continuous updating of the display from the file is desired. If not specified or nil, the display does not reflect changes made by appending to the end of the file. If t, the display is updated when text is appended to the end of the file. Changes to the file other than appending to the end are not displayed. Setting g_autoUpdate to t is equivalent to calling hiEnableTailViewfile.
|
|
l_iconPosition
|
This argument is passed to hiCreateWindow.
|
|
g_deviceMode
|
Specifies the method that is to be used to load the text file. You can choose from the following methods: LoadAll or Sparse.
|
Value Returned
|
w_windowId
|
The window ID of the created viewfile window.
|
|
nil
|
The viewfile window could not be created. An error message is also issued.
|
Related Topics
Functions of Viewfile Window
hiEnableTailViewfile
Text Device Mode
Viewfile Management
Return to top
