Index by Topic
Index by Topic
The above list is
incomplete and will be extended.
Atables
General
Access of member variables - atable.def_access
Creating - atable command
Global atable - global
Local atables -local
Searching atables for member variables - idir command
Atable files
Listing external references - atextern external utility
Restoring atables from file - atable command
Saving atables to file - unload command
Scope and search rules
Finding the atable of a variable - which function
Setting scope for new variables - scope
Search path for variable look-up - atable.search_path
General
Setting the master volume - gain
Turning audio facilities on/off - audio
Playback
Playing an audio file - sound command
Replaying the last audio file - pardon command
Recording
Creating an audio file (recording) - record command
Retrieving a list of available audio formats - audio_formats command
Retrieving the current recording state - recording
Accessing a blob's attributes - blob structure
Accessing a blob's byte values - blob.values function
Byte-swapping the contents of a blob - blob.byteswap function
Bit-inverting the contents of a blob - blob.invert function
Blob data type enumerations - blob.datatype
Converting a blob to a string array - fload function
Creating a blob variable - blob command
Creating a blob from file contents - fileblob function
Creating a blob from numeric values - datablob function
Creating a blob from string values - textblob function
Creating a zero-filled blob - zeroblob function
Extending a blob's attributes - blob.customize procedure
Extracting part of a blob - blob.part function
Finding a blob's length in bytes - blob.size
Merging multiple blobs - blob.append, blob.insert and blob.replace
Saving a blob to file - blob.savefile procedure
Communicating with the browser - see here
Displaying text in the browser's status bar - browser.status
Evaluating a Javascript expression in the browser - browser.eval
Retrieving a system property from the browser Java VM - browser.get
Retrieving text of an error incurred in the browser - browser.error
Retrieving the value of an applet parameter - browser.param
Setting a system property in the browser Java VM - browser.set
Showing a new page in the browser - browser.show
Registering a dynamic library - dynlib command
Caret strings - see Dynamic string substitution
Fire command line options - see here
Executing a macro on startup - fire -start
Retrieving command line option values - config
Accessing the cut/paste buffer - stuff
Accessing atables and identifiers - identbox command
Activating the symbolic debugger - debug command
Echoing macro commands to the monitor window - echoing
Forcing an interrupt during macro execution - interrupt
Listing system statistics - sysdump command
Pausing a macro - pause
Stepping through macro commands in the monitor window - stepping
Suspending a macro for a given time interval - sleep command
Viewing errors - errlog command
Color selection dialog - choosecolor function
Creating a value selection dialog - choice command
Creating a value request dialog - ask command
Creating a yes/no dialog - ifyes and ifno commands
Creating a custom dialog - see Panel windows
Displaying a pop-up message - message command
Displaying a pop-up message and waiting for a graphic point selection - hint command
Directory/folder selection dialog - choosedir function
File selection dialog - choosefile function
Font selection dialog - choosefont function
Print setup dialog - print -set command
Printing the contents of a window - print -dia command
Setting the position of a dialog - menu_position
Creating a directory - mkdir command
Deleting a directory - rmdir command
Displaying the current working directory - pwd
Listing contents of a directory - dir command
Retrieving the current working directory - current_dir
Selecting a directory - choosedir function
Setting the current working directory - path or cd command
Testing for existence of a directory - dexist function
Accessing a display window's attributes - see here
Creating a display window - wdisplay command
Generic window operations - see Windows
Restricting display to a clipped portion - window.clip and the -clip creation switch
Setting the angle of the image - window.angle and the -ang creation switch
Setting the resolution of the image - window.resolution and the -res creation switch
Downloading a file - httpget command
Fetching via HTTP GET - httpget command
Fetching via HTTP POST - httppost command
Handling outbound traffic via a proxy server - MXPROXY
Retrieving HTTP header information - httpget -os command
Setting HTTP parameters for internet access - httpset command
Handling file drops in a window - window.drop_files callback
Substituting a string variable inline - see here
Substituting a string variable within a function definition - see here
Creating environment variables - env command
Fire in-built environment variables - see here
Overriding Fire environment variables - fire -env or fire -root
Retrieving environment variable values - envval function
Using environment variables in file names - see here
Variables used by licensing system - see here
Clearing the contents - errlog -cl command
Directing error output to a channel - errlog -ch command
Directing error output to the monitor window - errlog -mon command
Displaying the error log window - errlog command
Invoking from the keyboard (Control E) - sys_control_e
Retaining the error log file on shutdown - errlog -k command
Setting the size of the scrollable buffer - errlog -r command
Suppressing the beep - errlog -q command
General
Changing the file name extension - chext function
Converting to a blob - fileblob function
Converting to a string array - fload function
Copying - copy command
Deleting - delete command
Finding the last modified date/time of a file - ftime function
Finding the number of lines in a text file - flines function
Finding the size of a file in bytes - fsize function
Memory-mapping a file - mapfile and unmapfile commands
Printing a text file - print command
Renaming - rename command
Selecting a file - choosefile function
Setting the access rights of a file - protect command
Showing the contents of a text file in an alpha window - walpha command
Showing the contents of a text file in the monitor window - type command
Testing for existence of a file - fexist function
Path names
Converting a file path into local OS convention - flocal function
Finding the directory from a file path - fpath function
Finding the extension from a file path - fext function
Finding the simple name from a file path - fname function
Finding the full path name from a file name - full function
Reading/writing/editing
Appending to the contents of a text file - open a and write commands
Converting text file contents to lower case - lower command
Converting text file contents to upper case - upper command
Merging the contents of multiple files - merge command
Reading one line from an open text file - lread function
Reading the contents of a text file - open r and read commands
Searching through the contents of a text file for a string - search command
Sorting the contents of a text file - sort command
Testing for end-of-file on read - channel.eof
Writing the contents of a text file - open w and write commands
Writing a text file with token substitution - writefile command
Getting/setting its value - gc
Suppressing its display in a graphic window - wgraphic -no_gc window creation switch, or window.gc_display
Suppressing its display in all windows - gc_display
Using with instance entities - get -i command
Using with new compound objects - see here
General
Creating - rasdump command
Editing - rasclip command
Setting the image in the icontray - icontray_image
Supported file types - see here
Enquiries
Finding the pixel dimensions of an image file - raspix function
Finding the number of images in a multiple image file - imageframes function
Finding geo-reference information of an image file - rasgeo function
Graphic windows
Simple draw operation - rasdraw command
Using as a background cloth - wcloth command
Using as an entity - cell command
Using as marker symbology - markerstyle and node commands
Using as fill symbology - fillstyle, tile and polygon commands
Image windows
Creating - wdisplay command
Panel windows
Changing in a gui panel - panel.image
Using in a gui check-button - check_button -cr panel
Using in a gui dial - dial -cr panel
Using in a gui label - label -cr panel
Using in a gui options menu - options -cr panel
Using in a gui push-button - button -cr panel
Using in a gui radio-box - radio_box -cr panel
Accessing the menubar of the monitor window - monitor_menubar
Accessing the help button on a menubar - window.help
Adding a menubar to a window - the -mb window creation switch
Adding a drop down menu to a button - pulldown command
Adding/removing a button - window.buttons callback
Assigning an action to a button - window.buttons callback
Setting the text of button - window.button_labels
Accessing the predefined messagefiles - sys_message_file and user_message_file
Building a message file (.mes) - genmess external utility
Creating a messagefile identifier from a .mes file - messagefile command
Creating a multi-language message file (.mes) - see here
Finding the languages within a messagefile - messagefile.current_language
Retrieving/setting messagefile attributes - messagefile.languages
Retrieving text from a messagefile - messagefile.text function
Setting the current language - messagefile.current_language
Using parameterized text in a messagefile - messagefile.text function
Displaying the message window - message command
Displaying the message window with a button - message -but command
Extending the text in the message window - message -a command
Generic window operations - see Windows
Assignment operators - see here
Available punctuation symbols - see here
Conditional operators - see here
Boolean operators (in conditions) - see here
Numeric operators (in expressions) - see here
Point operators (in expressions) - see here
String operators (in expressions) - see here
Wildcard characters - see here
Utility operators - see here
Accessing sub-panels (controls) - window.panels
Creating a panel window - wpanel command
Extending a panel window (adding more controls) - paneladd command
Panel (control) types - see here
Setting the keyboard traversal order of sub-panels - window.traversal
Accessing the default projection - mapping
Applying a longlat datum shift - projection.datum
Available earth models (ellipsoids) - see here
Available projection types - see here
Creating a projection - projection command
EPSG projections - epsg#
EPSG projections, getting a list of available epsg's - sysdump epsg command
Longitude/latitude projection - ll_proj
Oracle projections - srid#
Oracle projections, getting a list of available srid's - sysdump srid command
Projecting point arrays and entities - project command
Projecting single points - cart and longlat functions
Projecting single points across earth models - from_wgs84 and to_wgs84 functions
Retrieving/setting projection attributes - projection structure
Saving entities as cartographic entity files - save -ll command
Setting the transformation used in a longlat datum shift - projection.datum_transform
Testing for a WGS64 based projection - is_wgs84 function
Punctuation - see Operators & Punctuation
Creating registry keys - register command
Fire in-built registry entries - see here
Registering the Fire system - fire -reg
Retrieving registry key value(s) - registry function
Retrieving registry sub-key names - regkeys function
Setting registry key value(s) - register command
General
Creating a string variable - string command
Creating sub-strings - see here
Decoding a string into a series of variables - decode command
Dynamic (caret) string sunstitution - see Dynamic string substitution
Encoding/formatting a series of variables into a string value - encode command
String Functions
Converting a numeric value to a string - ns function
Converting a numeric value to a string with leading zeros - niz function
Converting wide character numeric values to a string - char function
Converting a point value to a string - ps function
Converting a point value to a string with precision - pnob function
Converting a string to lower case - low function
Converting a string to a word-capitalized form - wcap function
Converting a string to show control characters - ctrls function
Converting a string to upper case - upp function
Converting a string to wide character values - charval function
Decoding an html-encoded string - html_decode function
Decoding a url-encoded string - url_decode function
Encoding a string value for use within a url - url_encode function
Encoding a string value for use within html tags - html_encode function
Enclosing a string value within quotes - qs function
Formatting a numeric value to a string with precision - fmt function
Reading a single character from the keyboard - kbchar function
Removing white space from a string - nowhite function
Replacing character sequences - srep function
Scrambling a string value for security purposes - fxencode function
Stripping leading and trailing white space from a string - strim function
Wild character matching - match function
Minimizations
Defining a window as a master window - the -mas window creation switch
Minimizing windows to the task bar - the -tb window creation switch
Setting the text of the minimized fire - icontray_title
Icon Tray
Assigning an action to the fire icon - icontray_exec callback
Setting the image of the fire icon - icontray_image
Setting the tooltip text of the fire icon - icontray_toooltip
Suppressing the fire icon - icontray_display
Accessing the current time/date - current_time/now and current_date/today
Accessing other inbuilt dates - session_start, tomorrow and yesterday
Changing to UTC time - utc_mode
Creating a time variable - time command
Retrieving/setting time attributes - time structure
Retrieving the difference between local time and UTC - tzdiff
Retrieving the last-modified time of a file - ftime function
Retrieving the last-modified time of a variable - ident.time
Retrieving the number of seconds since the epoch - time.ticks
Rounding a time to the nearest minute, day etc. - time.granularity
Suspending a macro for a given time interval - sleep command
Window and treenodes
Accessing a tree window's attributes - see here
Accessing a tree window's treenodes - window.nodes and treenode.child
Accessing a treenode's attributes - treenode structure
Clearing a tree window - window.reset procedure
Creating a tree window - wtree command
Finding the currently-selected treenode - window.selected_node
Finding the selected treenode on a mouse right-click event - window.context_node
Generic window operations - see Windows
Making a treenode the current treenode - treenode.focus procedure
Populating a tree window with treenodes - window.add_node
Populating a treenode with child treenodes - treenode.add_child, window.add_sibling and window.insert_sibling functions
Removing a treenode from a tree window - treenode.kill procedure
Removing all treenodes from a tree window - window.reset procedure
Setting client values for a treenode - treenode.nvalue and treenode.tvalue
Setting the image for a treenode - treenode.image
Setting the tooltip for a treenode - treenode.tooltip
Treenode class
Creating a treenode class - treenode_define command
Extending a treenode class - treenode.extend procedure
Defining the characteristics/behavior of a treenode class - see here
Event callbacks
Assigning an action for the contraction of a treenode - treenode.contract callback
Assigning an action for the de-selection of a treenode - treenode.deselect callback
Assigning an action for the dynamic population of a treenode - treenode.populate callback
Assigning an action for the expansion of a treenode - treenode.expand callback
Assigning an action for the selection of a treenode - treenode.select callback
Catching a <delete> key event on a treenode - treenode.delete callback
Catching a <return> key event on a treenode - treenode.exec callback
Catching a mouse-over event on a treenode - window.track callback
Catching a mouse right-click event in a tree window - window.exec callback
Treenodes - see Tree windows
Accessing a web window's attributes - see here
Accessing the history of visited url's - window.history and window.history_titles
Calling fire commands from within a web window - see here
Catching a change-of-page event - window.pre_navigate and window.post_navigate callbacks
Creating a web window - wweb command
Generic window operations - see Windows
Loading/retrieving the current web page - window.url and window.url_title
Navigating back/forward/home - window.go_back, window.go_forward and window.go_home procedures
Refreshing the current page - window.refresh procedure
Stopping the load of the current page - window.stop procedure
General
Accessing a window's generic attributes - window structure
Adding scrollbars to a window - the -sc creation switch
Creating window variables - window command
Deleting a window - wdelete command
Defining a window as a master window - the -mas creation switch
Defining a window as initially minimized - the -ic creation switch
Defining a window as non-resizable - the -fix creation switch
Defining a window with a menubar - the -mb creation switch
Defining a window with an associated atable - the -at creation switch
Defining a window with restricted frame decoration - see here and the -dec creation switch
Exposing a window - wexpose command
Extending a window's attributes - window.customize procedure
Flashing a window - window.flash procedure
Ghosting a window - window.ghosted and the -gh creation switch
Minimizing a window - wclose command
Moving a window - wmove command
Normalizing a window - wopen command
Obscuring a window - whide command
Resizing a window - wsize command
Scrolling a window - wscroll command
Setting the geometry of a window - window.inrect, window.outrect and the -geo creation switch
Setting the title of a window - window.title and the -tit creation switch
Setting the visibility of a window - window.visibility and the -inv creation switch
Setting the z-order of a window - window.z_order
Suppressing the window number in the banner - window_numbers and the -no_num creation switch
Using window slot numbers - win#
Event callbacks
Assigning an action for a window delete - window.delete callback
Assigning an action for a window drag'n drop - window.drop_files callback
Assigning an action for a window minimize - window.iconify callback
Assigning an action for a window move - window.move callback
Assigning an action for a window normalize - window.deiconify callback
Assigning an action for a window resize - window.resize callback
Assigning an action for a window scroll - window.scroll callback
Avoiding unnecessary resize events - window.resize callback
Dialog windows - see Dialog windows
Display windows - see Display windows
Error log window- see Error log window
Message window- see Message window
Panel windows - see Panel windows
Tree windows - see Tree windows
Web windows - see Web windows
Defining an image backcloth for a graphic window - wcloth command
Reading an xml file - xmlread command
Oracle srid projection file - projections.xml
Overriding tag names when reading - ident.xml_tag
Testing an xml file for validity - xmltest function
Creating a zip file - zip command
Unzipping a zip file - unzip command
Unzipping during a download - httpget -z command