APDL Public Domain 1

home *** CD-ROM | disk | FTP | other *** search

/ APDL Public Domain 1 / APDL_PD1A.iso / program / basic / eventshell / Docs / Icons < prev next >

Wrap

Text File | 1996-04-11 | 16.5 KB | 705 lines

FNshell_IconGetCommand() => int pointer to validation string str validation command <= str command string See also FNshell_IconGetValidation. -------------------------------------------------------- PROCshell_IconSelectAll() => int window handle Selects all of the icons contained in the specified window. -------------------------------------------------------- PROCshell_IconDeselectAll() => int window handle Deselects all of the icons contained in the specified window. -------------------------------------------------------- PROCshell_IconDelete() => int window handle int icon handle This call frees any memory used for indirected data and validation strings. The window area covered by the icon (including any 3D borders) is not redrawn. Use PROCshell_IconDelete2 to delete the icon and redraw the window area. -------------------------------------------------------- PROCshell_IconDelete2() => int window handle int icon handle This call frees any memory used for indirected data and validation strings. The window area covered by the icon (including any 3D borders) is redrawn. When a large number of icons are to be deleted it is better to use PROCshell_IconDelete and then redraw the window afterwards as this will be quicker. -------------------------------------------------------- FNshell_IconMove2() => int window handle int icon handle int x displacement int y displacement <= int icon handle Allows an icon to be moved around the window. As the icon has to be deleted and then recreated it returns the new icon handle (which should be the same as the old handle). The icon is redrawn after moving, taking account of any 3D borders. See also FNshell_IconMove -------------------------------------------------------- FNshell_IconMove() => int window handle int icon handle int min x coord int min y coord int max x coord int may y coord <= int icon handle Allows the redefinition of an icon's bounding box. As the icon has to be deleted and then recreated it returns the new icon handle (which should be the same as the old handle). The icon is redrawn after resizing, taking account of any 3D borders. -------------------------------------------------------- FNshell_IconGetData() => int window handle int icon handle <= str icon text Should the WimpEXT module be loaded its SWIs will be used for reading icon data (this will be about twice as fast as the usual routine). See also PROCshell_IconPutData. -------------------------------------------------------- PROCshell_IconbarSetText() => int window handle int icon handle str text under icon From v1.41 of the library this routine now handles redraws of the icon/text correctly under RISC OS 2 and 3. Note that the icon must be wide enough to ensure that the text is redrawn (add extra 'mask' pixels to the right and left of the icon). This is because only the area of the icon bar covered by the icon itself is redrawn. -------------------------------------------------------- PROCshell_IconPutData() => int window handle int icon handle str text to insert into icon int redraw flag An error is generated if the text is too long to fit in the icon. If the text to insert is the same as the existing text then no action is taken, avoiding any flickering of the icon. If the redraw flag is TRUE wimp poll is called immediately to update the icon contents. Note that if the window is not open (for example if you are calling this routine in a pre-open function) then the redraw flag should be FALSE as the whole window will be redrawn when it is opened. Should the WimpEXT module be loaded its SWIs will be used for reading icon data (this will be about twice as fast as the usual routine). -------------------------------------------------------- PROCshell_IconPutDataNow() => int window handle int icon handle str text to insert into icon An error is generated if the text is too long to fit in the icon. This call is similar to PROCshell_IconPutData, the difference being that PROCshell_EnsurePoll is called to make sure that the icon is updated immediately. This is important if your program is performing some non multi tasking operation and you want an icon to show a status message. -------------------------------------------------------- PROCshell_IconRedraw() => int window handle int icon handle Force a redraw of the screen area covered by the given icon (including any 3D borders). -------------------------------------------------------- PROCshell_IconPutValidation() => int window handle int icon handle str new validation string See also FNshell_IconGetValidation. -------------------------------------------------------- PROCshell_IconSelect() => int window handle int icon handle Make the specified icon selected. -------------------------------------------------------- PROCshell_IconDeselect() => int window handle int icon handle -------------------------------------------------------- PROCshell_IconUnselectable() => int window handle int icon handle -------------------------------------------------------- PROCshell_IconSetBGColour() => int window handle int icon handle int background colour An error is generated if the colour number is outside the range 0-15. See also PROCshell_IconSetFGColour. -------------------------------------------------------- PROCshell_IconSetFGColour() => int window handle int icon handle int foreground colour An error is generated if the colour number is outside the range 0-15. See also PROCshell_IconSetBGColour. -------------------------------------------------------- PROCshell_IconSetButtonType() => int window handle int icon handle int button type An error is generated if the button type is outside the range 0-11,14-15. -------------------------------------------------------- PROCshell_IconSetESG() => int window handle int icon handle int Exclusive Selection Group number An error is generated if the esg number is outside the range 0-31. -------------------------------------------------------- PROCshell_IconSetText() => int window handle int icon handle bool state (0 to clear text bit, non-0 to set it) -------------------------------------------------------- PROCshell_IconSetSprite() => int window handle int icon handle bool state (0 to clear sprite bit, non-0 to set it) -------------------------------------------------------- PROCshell_IconSetBorder() => int window handle int icon handle bool sate (0 to clear border bit, -0 to set it) -------------------------------------------------------- PROCshell_IconSetHCentred() => int window handle int icon handle bool state (0 to clear horizontally centred bit, non-0 to set it) -------------------------------------------------------- PROCshell_IconSetVCentred() => int window handle int icon handle bool state (0 to clear vertically centred bit, non-0 to set it) -------------------------------------------------------- PROCshell_IconSetRightJust() => int window handle int icon handle bool state (0 to clear right justified bit, non-0 to set it) -------------------------------------------------------- PROCshell_IconSetLeftJust() => int window handle int icon handle -------------------------------------------------------- PROCshell_IconSetFilled() => int window handle int icon handle bool state (0 to clear filled bit, non-0 to set it) -------------------------------------------------------- PROCshell_IconSetUsesOutlineFont() => int window handle int icon handle bool state (0 to clear 'uses font' bit, non 0 to set it) Note this call does not actually change the font used by the icon. Use the routine FNshell_IconSetFont for this. -------------------------------------------------------- PROCshell_IconSetFont() => int window handle int icon handle int font handle to use Use FNshell_Fonts_FindFont to obtain the handle of the outline font. -------------------------------------------------------- PROCshell_CaretSetPosition() => int window handle int icon handle int x offset in icon (usually -1) int y offset in icon (usually -1) int height (usually -1) int index Allows the caret to be positioned within an icon. the index parameter is the number of characters before the caret. See also PROCshell_CaretSetRight. -------------------------------------------------------- PROCshell_CaretSetRight() => int window handle int icon handle Positions the caret at the right hand end of any text in the specified icon. See also PROCshell_CaretSetPosition. -------------------------------------------------------- PROCshell_CaretReadPosition() => int window handle int icon handle int x offset into string int y offset into string int index All of the parameters are updated. -------------------------------------------------------- FNshell_Iconbar() => int -1 for right side of bar, -2 for left side str sprite name str text under icon int width of icon/text (set to maximum width required) str menu name bool shift flag (not implemented) bool ctrl flag (not implemented) bool alt flag (not implemented) Note that if there is to be text under the icon the sprite must be in the wimp sprite area (i.e. in the !Sprites file and !Sprites22 if you have one). If there is no text under it, it can be in the Sprites and Sprites22 files. The shift, ctrl and alt flags are for future enhancements to the library and should be set to 0 on this release. -------------------------------------------------------- FNshell_IconGetValidation() => int window handle int icon handle <= str validation string See also PROCshell_IconPutValidation. -------------------------------------------------------- FNshell_IconNewSprite() => int window handle int icon handle str new sprite name int redraw flag <= int new icon handle -------------------------------------------------------- FNshell_IsIconSelected() => int window handle int icon handle <= bool TRUE if selected, FALSE otherwise -------------------------------------------------------- FNshell_IconIsDraggable() => int window handle int icon handle <= bool TRUE if draggable, FALSE otherwise -------------------------------------------------------- FNshell_IconIsWritable() => int window handle int icon handle <= bool TRUE if writable, FALSE otherwise -------------------------------------------------------- FNshell_IconIsSprite() => int window handle int icon handle <= bool TRUE if sprite, FALSE otherwise -------------------------------------------------------- FNshell_IconCreate() => int window handle int min x coord of icon int min y coord of icon int width of icon int height of icon int foreground colour int background colour int icon flags str text to insert into icon int address of indirected data (ignored when not indirected) int length of indirected buffer (ignored when not indirected) str validation string <= int handle of new icon This routine is only used when the application needs to create icons itself rather than loading them as part of a window definition in a template. It does not redraw the area of the window occupied by the new icon. If the window is open it may be necessary to call PROCshell_IconRedraw to update the window area covered by the icon. -------------------------------------------------------- PROCshell_IconSet() => int window handle int icon handle bool state (0 for deselected, non 0 for selected) This call is used to select or deselect icons depending on the value of the state flag -------------------------------------------------------- PROCshell_IconSetSelected() => int window handle int icon handle bool state (0 for deselected, non 0 for selected) This call is used to select or deselect icons depending on the value of the state flag -------------------------------------------------------- PROCshell_IconSetUnselectable() => int window handle int icon handle bool state (0 to make icon selectable, non 0 to make it unselectable) This call is used to make icons unselectable (i.e. greyed out) depending on the value of the state flag. If the icon contains the caret when it is made unselectable, the caret is lost. -------------------------------------------------------- FNshell_IconResize() => int window handle int icon handle int min x coord int min y coord int max x coord int max y coord <= int icon handle Allows the redefinition of an icon's bounding box. As the icon has to be deleted and then recreated it returns the new icon handle (which should be the same as the old handle). The icon is redrawn after resizing, taking account of any 3D borders. -------------------------------------------------------- PROCshell_CaretPutFirstIcon() => int window handle Allows the caret to be positioned within the first writable icon in a window. If the caret is not in the window, it is placed there and if there are no writable icons no error occurs. -------------------------------------------------------- PROCshell_CaretPutLastIcon() => int window handle Allows the caret to be positioned within the last writable icon in a window. If the caret is not in the window, or there are no writable icons no error occurs. Note that this call does not claim the caret, i.e. the caret must already be in the window. -------------------------------------------------------- PROCshell_CaretPutNextIcon() => int window handle Allows the caret to be positioned within the next writable icon in a window. If the caret is not in the window, or there are no writable icons no error occurs. Note that this call does not claim the caret, i.e. the caret must already be in the window. -------------------------------------------------------- PROCshell_CaretPutPrevIcon() => int window handle Allows the caret to be positioned within the previous writable icon in a window. If the caret is not in the window, or there are no writable icons no error occurs. Note that this call does not claim the caret, i.e. the caret must already be in the window. -------------------------------------------------------- FNshell_IconGetBGColour() => int window handle int icon handle <= int background colour (0-15) See also PROCshell_IconSetBGColour. -------------------------------------------------------- FNshell_IconGetFGColour() => int window handle int icon handle <= int foreground colour (0-15) See also PROCshell_IconSetFGColour. -------------------------------------------------------- FNshell_IconRadioSelection() => int window handle int esg group (0-31) <= int icon handle Returns the handle of the radio icon which is selected in the specified esg. -------------------------------------------------------- FNshell_IconHasCaret() => int window handle int icon handle <= bool TRUE or FALSE -------------------------------------------------------- PROCshell_IconGetSelectedIcons() => int window handle int esg (0-31) int icon selection block (updated on return) You must supply a heap block as the third parameter which must be large enough to contain the returned values. You need 4 bytes for each icon handle plus 4 bytes for the -1 terminator. -------------------------------------------------------- FNshell_IconGetButtonType() => int window handle int icon handle <= int button type (0-15) -------------------------------------------------------- PROCshell_IconClearAllWritables() => int window handle Clears all the writable icons in the specified window to "". No error occurs if no writable icons are present in the window. -------------------------------------------------------- PROCshell_IconSetAllWritables() => int window handle str text string to place in icons Sets all the writable icons in the specified window to the given string. No error occurs if no writable icons are present in the window. -------------------------------------------------------- PROCshell_IconDisallowWritableDrags => None Turns off the automatic handling of writable icon drags (i.e. moving, copying etc between icons) for Style Guide purists. -------------------------------------------------------- PROCshell_IconAllowWritableDrags => None Turns on the automatic handling of writable icon drags. -------------------------------------------------------- FNshell_IconWritableDragStatus => None <= bool TRUE if writable icon dragging is enabled, FALSE otherwise Default is when the application starts is TRUE. -------------------------------------------------------- PROCshell_IconEnsureVisible() => int window handle int icon handle This routine tries to ensure that the icon is wholly within the visible area of the specified window by scrolling it. This is mainly of use for writable icons in that EvntShell can automatically scroll the window as the caret moves between writable icons. --------------------------------------------------------