HELP PWMNAMES                                    Gareth Palmer, Sep 1989

This file describes the naming scheme used by the Poplog Window Manager
(HELP * PWM). This scheme has been rationalised for version 13.7,
resulting in a number of changes to existing procedures. A full list of
procedure names is given, indicating where changes have occurred.


CONTENTS - (Use <ENTER> g to access required sections)

 -- The PWM Naming Scheme
 -- List Of Procedure Names And Changes Organised By Help File
 -- HELP * PWMGENERAL
 -- HELP * PWMWINDOWS
 -- HELP * PWMGRAPHICS
 -- HELP * PWMMENUS
 -- HELP * PWMCOLOURS
 -- HELP * PWMFONTS
 -- HELP * PWMRASTERS
 -- HELP * PWMINPUT
 -- HELP * PWM_TRACK_MOUSE
 -- HELP * PWMITEMS

-- The PWM Naming Scheme -----------------------------------------------

Since there are a large number of procedures available to the PWM
programmer, an attempt has been made to provide a consistent naming
scheme.  Although the scheme is very simple, it should make it easier to
guess the name of the procedure you want.

Most procedure names start with 'pwm_', e.g.

    pwm_screenheight  pwm_close_window

Most other identifiers start with just 'pwm', e.g.

    pwmgfxsurface  pwmstdcursor

The only exceptions to this occur when an identifier is specific to Sun
workstations, or is named according to another convention, e.g.

    pwmsun_kill_cms  checkpwmuserwin

Where the identifier contains a verb, this is followed by an underscore,
e.g.

    pwm_open_window  pwm_kill_window

Where there is no verb, there is no underscore, e.g.

    pwm_windowheight  pwm_windowcursor


-- List Of Procedure Names And Changes Organised By Help File ----------

For version 13.7, a large number (about 2/3) of PWM procedure names have
been changed.  Programs written using the old names will still work, of
course, but at a small cost in space efficiency.  There are three
possible reasons for any name change:

Firstly, to make it easier to guess where the underscores go, e.g.

    pwm_setselection --> pwm_set_selection
    pwm_icon_label --> pwm_iconlabel

Secondly, the letters 'gfx' (for graphics) have been removed from a
number of names where they are redundant, e.g.

    pwm_gfxdrawline --> pwm_draw_line

Finally, a few names have been changed completely to make them more like
others in the system, e.g.

    remove_pwmitem --> pwm_kill_item

In two cases this has meant replacing an ordinary procedure, used to set
some value, with an updater:

    pwm_setwincursor --> pwm_windowcursor

    pwm_gfxgetmapentry
    pwm_gfxsetmapentry --> pwm_colourmapentry


If you know the old name for a procedure, the information in this file
should help you guess whether it has changed, and what to.  You can also
find out the new name by doing

    <ENTER> ?? <old name>

(See HELP * QUERY for further information.)

Here is a full list of procedure names.  Where the name has changed, the
old version is given on the right.  Non-procedure identifiers are only
listed where they have changed.

-- HELP * PWMGENERAL ---------------------------------------------------

islivepwm_id
ispwm_id
pwm_idtype              pwmid_type
pwm_screendepth
pwm_screenheight
pwm_screenwidth
pwm_workstation
pwm_setselection        pwm_set_selection
pwm_getselection        pwm_get_selection


-- HELP * PWMWINDOWS ---------------------------------------------------

pwm_close_window
pwm_expose_window
pwm_hide_window
pwm_refresh_window
pwm_resize_window
pwm_move_window
pwm_open_window
pwm_kill_window         pwm_killwindow
pwm_scan_windows        pwmwindowscan
pwm_make_gfxwin         pwm_makegfxwin
pwm_make_txtwin         pwm_maketxtwin
pwm_mark_textarea       pwm_marktextarea
pwm_winexternalsize     pwm_win_externalsize
pwm_wininternalsize     pwm_win_internalsize
pwm_winopenstate        pwm_win_openstate
pwm_iconlabel           pwm_icon_label
pwm_iconlocation        pwm_icon_location
pwm_windowlabel         pwm_window_label
pwm_windowlocation      pwm_window_location
pwm_windowcursor        pwm_setwincursor
pwm_windowheight
pwm_windowwidth
pwm_windowiconic
pwm_windowtype
checkpwmcursid
checkpwmsurfid
checkpwmuserwin
checkpwmwinid


-- HELP * PWMGRAPHICS --------------------------------------------------

pwm_copy_raster         pwm_gfxcopyraster
pwm_draw_arc            pwm_gfxdrawarc
pwm_draw_ellipse        pwm_gfxdrawellipse
pwm_draw_line           pwm_gfxdrawline
pwm_kill_page           pwm_gfxkillpage
pwm_make_page           pwm_gfxnewpage
pwm_pixel               pwm_gfxpixel
pwm_wipe_area           pwm_gfxwipearea
pwmpaintnum             pwmgfxpaintnum
pwmrasterop             pwmgfxrasterop


-- HELP * PWMMENUS -----------------------------------------------------

pwm_kill_menu           pwm_killmenu
pwm_make_menu           pwm_definemenu
pwm_display_menu        pwm_displaymenu
pwm_make_menucall       pwm_menucall


-- HELP * PWMCOLOURS ---------------------------------------------------

pwmsun_kill_cms         pwmsun_gfxkillcms
pwmsun_make_cms         pwmsun_gfxnewcms
pwmsun_use_cms          pwmsun_gfxusecms
pwm_colourmapentry      pwm_gfxgetmapentry, pwm_gfxsetmapentry


-- HELP * PWMFONTS -----------------------------------------------------

pwm_fontbaseline
pwm_fontheight
pwm_fontwidth
pwm_kill_font           pwm_gfxkillfont
pwm_load_font           pwm_gfxloadfont
pwm_draw_text           pwm_gfxtext


-- HELP * PWMRASTERS ---------------------------------------------------

pwm_make_rasterarray    newpwmrasterarray
pwm_dump_raster         pwm_gfxdumpraster
pwm_load_raster         pwm_gfxloadraster
pwm_read_rasterfile     pwm_gfxreadrasterfile
pwm_write_rasterfile    pwm_gfxwriterasterfile
pwm_rasterdepth         pr_depth
suniconfile
sunrasterfile


-- HELP * PWMINPUT -----------------------------------------------------

pwm_force_input         pwm_forceinput
pwm_reset_input         pwm_resetinput
pwm_get_oneinput        pwm_getoneinput
pwm_eventhandler        pwmeventhandler
pwm_inputcatcher        pwminputcatcher
pwm_itemhandler         pwmitemhandler
pwm_quit_window         pwmquitwindow
pwm_wait_inevent        pwmwaitinevent
pwm_prompt_user         pwm_promptuser


-- HELP * PWM_TRACK_MOUSE ----------------------------------------------

pwm_track_mouse         pwm_trackmouse


-- HELP * PWMITEMS -----------------------------------------------------

pwm_make_cycleitem      pwmcycleitem
pwm_make_execitem       pwmexecitem
pwm_make_radioitem      pwmradioitem
pwm_make_toggleitem     pwmtoggleitem
pwm_itemarea            pwmitem_area
pwm_itemvalue           pwmitem_valof
pwm_kill_item           remove_pwmitem


--- C.pwm/help/pwmnames
--- Copyright University of Sussex 1990. All rights reserved. ----------
