PCE version 4C man_modulenamespaceid_tablemodified current_idOIxNobjectsN referenceC hash_tablerefersizeOIxNbothI1sNO.arg1Cman_object_card identifiermodule last_modifiednamesummary descriptionsee_alsoinheritOIxNO.arg1RICdateOIx,N@arg1nCstringOIxThe var objects (function objects) @arg1 ... @arg10 are used to pass context arguments when code objects are executed using `code ->forward'. The example below shows this mechanism: ?- new(@m, and(message(@prolog, write, @arg1), message(@prolog, nl))). ?- send(@m, forward, hello). hello They are also used to describe the arguments to user-defined method objects. See also @receiver, @event, class var, class function, class method and `send_method ->send'.CchainsizeOIxI eN$class/obtain$C.?eNO.eventeN O.receiverENO.arg10eNO.arg9eNO.arg8eNO.arg7eNO.arg6eNO.arg5eNO.arg4eNO.arg3eNO.arg2XnsNO.typesOIxNO.typesRIOIx;N@typesnOI xThe hash_table object @types maps `type <-name' onto type objects. This method is used by `type <-lookup' and `type <-convert'. It may also be used to enumerate the existing instances of class type.nnsNO.not_obtainedOI xNO.not_obtainedRIOI x5@N @not_obtainednOI xTUsed by class_variable objects to indicate the real value has not yet been resolved.nnsN O.white_imageOI xN O.white_imageRIOIx)IN @white_imageOIxImage filled with only 0'snOIxIEN $topics$23XOIxIEN O.black_imageXsNO.arg10OIxNO.arg10RIOIx,WN@arg10nnOIxIENO.arg1XOIxIENO.arg1XsNO.class_defaultOIxNO.class_defaultRIOIx5>N@class_defaultnOIxmInstance of class constant used for access to instance variables guarded by a class_variable object. The object-allocation will any slot for which a class-variable is defined to this slot. First access to the slot will replace the value with the current binding of the class-variable. See also `object <-class_variable_value', `object ->obtain_class_variables'.nnsNO.open_socketsOIxNO.open_socketsRIOIx9|N @open_socketsnOIxThis chain represents all sockets that are currently open. It is maintained by `socket->listen', `socket->connect' and `socket ->close'. Its primary usage is to enable XPCE to do a graceful shutdown of all active network connections at `@pce ->die'.nnsNO.colour_displayOIxNO.colour_displayRIOIx5}WiN@colour_displaynOIxMPredefined executable code object that succeeds if the attached default display @display is a colour display. Defined as: new(@colour_display, @display?depth > 1). Commonly used for conditional Default specifications: text_cursor.colour: when(@colour_display, red, black) See also `@display <-visual_type', `@display <-depth'.nnsNO.arg4OIxNO.arg4RIOI x,WN@arg4nnOI!xIENO.arg1XOI"xIENO.arg1XsNO.arg9OI#xNO.arg9RIOI$x,WN@arg9nnOI%xIENO.arg1XOI&xIENO.arg1XsN O.reporteeOI'xN O.reporteeRIOI(x6[N @reporteenOI)xAThe var object @reportee is managed by `visual ->report' for avoiding cycles, as well as be able to `graphical ->alert' the origin of the message. It contans a chain object. The `chain <-head' is the original receiver of the `visual ->report', the other elements are visuals visited while trying to deliver the message.OI*xIEN$class/visual$M.visual.S.reportXnsNO.arg8OI+xNO.arg8RIOI,x,WN@arg8nnOI-xIENO.arg1XOI.xIENO.arg1XsNO.grey75_imageOI/xNO.grey75_imageRIOI0x)AN @grey75_imageOI1xImage filled with 75% 1'snOI2xIEN $topics$23XOI3xIEN O.black_imageXsNO.onOI4xNO.onRIOI5x,]UN@onnnnOI6xIENO.offXsNO.arg7OI7xNO.arg7RIOI8x,WN@arg7nnOI9xIENO.arg1XOI:xIENO.arg1XsNO.arg6OI;xNO.arg6RIOIxIENO.arg1XsNO.grabbed_windowsOI?xNO.grabbed_windowsRIOI@x?dwN@grabbed_windowsnOIAxChain object holding windows that claimed the pointer using `window->grab_pointer'. New windows are added to the front of this chain. A call to `window->grab_pointer: @off' re-enables the grabbing on the previous window.nnsNO.arg5OIBxNO.arg5RIOICx,WN@arg5nnOIDxIENO.arg1XOIExIENO.arg1XsNO.running_processesOIFxNO.running_processesRIOIGx*-N@running_processesOIHx,Chain holding all running inferior processesOIIxVThis chain is managed by `process ->open', `process ->stopped', `process ->killed' and `process ->exited'. It contains all those processes that have pid not equal to @nil (i.e. the process objects that have a living Unix counterpart). This chain may be used to check whether there are any living subprocesses associated to this PCE process.OIJxIEN$class/process$M.process.S.killXnsNO.grey25_imageOIKxNO.grey25_imageRIOILx) N @grey25_imageOIMxImage filled with 25% 1'snOINxIEN $topics$23XOIOxIEN O.black_imageXsNO.arg3OIPxNO.arg3RIOIQx,WN@arg3nnOIRxIENO.arg1XOISxIENO.arg1XsNO.cursor_namesOITxNO.cursor_namesRIOIUx(g+N @cursor_namesOIVx#Map X-cursor names on X-cursor id'sOIWxThe global and predefined sheet @cursor_names maps the names of the X-cursors onto the entry-id in the X-cursor font. Thus, get(@cursor_names, attribute_names, Chain) returns a list of all available cursor names.OIXxIeN $class/display$V.display.cursorsEN$class/cursor$C.cursorXnsN O.end_of_fileOIYxN O.end_of_fileRIOIZx5?iN @end_of_filenOI[x.Used by class tokeniser to signal end-of-file.nnsNO.errorsOI\xNO.errorsRIOI]x,}FN@errorsnOI^xThe hash_table object @errors maps error-id's into error objects. The available errors may be examined using the `Errors' tool from the `Browsers' menuOI_xIEN $tools$17XnsNO.offOI`xNO.offRIOIax,]N@offnOIbxThe bool objects @on and @off represent `true' and `false'. PCE converts various other values into one of these objects if the requested type is `bool'. See `bool <-convert'. See also class bool and class constant.OIcxIEN$class/image$V.image.kindXnsN O.cursorsOIdxN O.cursorsRIOIex,{fN@cursorsnOIfxrA hash_table object that maps cursor names onto cursor objects. Used by `cursor <-lookup' and `cursor <-convert'.nnsN O.coloursOIgxN O.coloursRIOIhx,{^GN@coloursnOIixA hash_table object mapping colour names into colour objects. This table only holds actually used colours. A list of predefined colour names is normally available from the file /usr/lib/X11/rgb.txt The exact location of this file may be different on your X11 installation.nnsNO.arg2OIjxNO.arg2RIOIkx,WN@arg2nnOIlxIENO.arg1XOImxIENO.arg1XsN O.elevationsOInxN O.elevationsRIOIox.KN @elevationsnOIpxeHash_table object maintained by class elevation. It maps `elevation <-name's onto elevation objects.nnsNO.display_managerOIqxNO.display_managerRIOIrx0e+N@display_managernOIsxoThe global object @display_manager the single instance of class display_manager. The display manager manages the set of available displays. On the Win32 platforms, there is only one display called @display. On X11, @display refers to the default display, but multiple displays on different computers may be managed by XPCE. See also `display_manager <-members'.nnsNO.grey12_imageOItxNO.grey12_imageRIOIux)N @grey12_imageOIvxImage filled with 12% 1'snOIwxIEN $topics$23XOIxxIEN O.black_imageXsNO.space_rubberOIyxNO.space_rubberRIOIzx8(dN @space_rubbernOI{xRubber object normally used to render spaces. Attributes: `rubber<-stretch': 100 `rubber<-shrink': 1 `rubber<-level': 1 `rubber<-linebreak': allow. Used by `tbox <-space'.nnsN O.event_treeOI|xN O.event_treeRIOI}x.N @event_treeOI~x$SubsuMption hierarchy of event-typesOIx@event_tree describes the event-type hierarchy. This hierarchy is used by `event ->is_a'. This method is used by class handler to verify the type of the event. The demo program `events' may be used to examine the event hierarchy.OIxIeN$class/handler$C.handlereN$class/event$M.event.S.is_aEN$class/event_tree$C.event_treeXnsN O.classesOIxN O.classesRIOIx.0N@classesOIx"Hash-table of class-name --> ClassOIx_The hash_table object @classes maps class-names into class objects. Application programs that wish to map a class-name into a class object better use `@pce <-convert': get(@pce, convert, point, class, X). X = @point_class Using `@pce <-convert' will generate an exception if the class does not exist. See also the Prolog predicate pce_autoload/2.OIxIEN$predicates$17XnsNO._not_returnedOIxNO._not_returnedRIOIx5?N@_not_returnednOIx1Internally used constant. See `frame <-confirm'.nnsNO.pceOIxNO.pceRIOIx,^N@pceOIx%Access to the overall PCE environmentOIxThe object @pce is the only instance of class pce. It defines methods for which there is no clear receiver as well as overall access to the PCE system.OIxIEN$class/pce$C.pceXnsN O.defaultOIxN O.defaultRIOIx5 N@defaultOIxRepresents `default value'OIxvThe constant object @default represents defaulting. @default is normally used for arguments you do not wish to specify when sending a message or creating an object. @default is also used as filler for a slot. In this case it normally means `when this slot is needed; compute a sensible default from the environment'. The interpretation of @default is handled by the code that handles the arguments or attribute-value. When too few arguments are presented to a method and the method has defined it is willing to accept @default (indicated by putting the type between square brackets; `[int]' refers to an integer or @default) for the remaining arguments, @default is passed for all remaining arguments. For example, the arguments to `Graphical ->set' are `[int], [int], [int], [in]', which makes send(Box, set, 40, 40) equivalent to send(Box, set, 40, 40, @default, @default).OIxIeNO.nilEN $topics$115XnsNO.nilOIxNO.nilRIOIx/"N@nilOIxRepresents `nothing'OIxThe constant @nil is used to indicate `not-filled' or `nothing'. It is used very frequently in PCE. When a new instance is created by PCE's virtual machine, all slots are initialised to @nil, after which `object ->initialise' is invoked on the new instance. When an object is destroyed by PCE's virtual machine, all slots that are filled with true objects are reset to @nil. See `object ->unlink'.OIxIEN O.defaultXnsN O.displayOIxN O.displayRIOIx5~ZN@displayOIxAccess to the X-displayOIxIThe global object @display refers to the default display object. This display resides by default at the address specified by the environment variable DISPLAY. The object @display is normally used for the methods `@display ->inform', `@display ->confirm' and `@display <-size'. See also class display and class display_manager.OIxIeIeN$class/visual$C.visualEN$class/display$C.displayXnsNO.prologOIxNO.prologRIOIx5N@prologOIx#Access to Prolog (notably callback)OIxThe object @prolog is the only instance of class host and provides access (calling predicates) to the hosting language. On Lisp systems this object is called @lisp. See also @pce.OIxIeN$class/host$C.hostEN $topics$14XnsN O.modifiersOIxN O.modifiersRIOIx,N @modifiersnOIxTable mapping modifiers specified as a name holding `s', `c' and or 'm' into modifier objects. See `modifier <-convert'. Do not modify modifiers in this table.nnsN O.black_imageOIxN O.black_imageRIOIx,XN @black_imageOIxImage filled with only 1'sOIxPredefined images of `image <-kind: bitmap' of 16x16 pixels. These bitmaps are frequently used to fill graphicals. See `graphical ->fill_pattern'.OIxIEN $topics$23XnsN O.receiverOIxN O.receiverRIOIx6\N @receiverOIxReceiver of event/messageOIxyThe var object @receiver refers to the object that is receiving an event. A new value of receiver is pushed if a message is invoked from a gesture object or handler object. In this case, @receiver refers to the (graphical) object that received the event. See `handler ->event', @event and `@event <-receiver'. @receiver is commonly used to create reusable gestures. For example: ?- new(@clicked, click_gesture(left, '', single, message(@receiver, clicked))). If this recogniser object is associated to a graphical object, the object will receive a ->clicked message when the user left-clicks the object.OIxIeNO.arg1EIXnsNO.imagesOIxNO.imagesRIOIx)N@imagesOIxTable of reusable imagesOIx The hash_table @images maps names of images into images. It is used by `Image ->initialise: name'. If the name already exists in this table, new/2 returns the existing image. Otherwise a new image is created from the named file and this image is added to @images.OIxIeN$class/image$V.image.nameEN!$class/image$M.image.S.initialiseXnsNO.classOIxNO.classRIOIx0N@classnOIx_PCE var object that points to the currently compiling class. Pushed/popped by pce_begin_class/3 and pce_end_class/0. Intended for directives on the class that are not converted by the Prolog preprocessor. For example: :- pce_begin_class(myclass, object). :- send(@class, save_style, external). ... :- pce_end_class. See also pce_compiling/1.nnsNO.eventOIxNO.eventRIOIx,\N@eventOIxCurrently processed eventOIxThe var object @event provides a reference to the currently executing event. It works similar to @arg1 ..., @receiver, etc. The current event is pushed by `event ->post'. @event provides a reference to the event that caused this behaviour to execute, regardless of where you are in your code. Note that a window maintains a variable `window <-current_event' in which the event currently processed by this window is stored.OIxIeN$class/event$M.event.S.posteNO.arg1eN$$class/window$V.window.current_eventEN$class/event$C.eventXnsNO.fontsOIxNO.fontsRIOIx5}WxN@fontsOIxHash-table with defined fontsOIxThe hash_table @fonts maps font reference names (e.g. screen_roman_13) onto font objects. Thus, all available fonts may be listed using: send(@fonts, for_all, message(@pce, write_ln, @arg2)). The demo-program `FontViewer' may be used to examine the available fonts. NOTE: The table @fonts is initially empty. The standard fonts are created from display.font_families using the method `display->load_fonts'.OIxIeN$class/font$C.fontEN"$clasc.display$R.display.font_listXnsNO.key_bindingsOIxNO.key_bindingsRIOIx,AN @key_bindingsnOIxHash_table object mapping key_binding names to key_binding objects. Any named key_binding object is inserted in this table. The standard `editable' object (class text, class text_item and class editor) have default key_binding tables with names `text', `text_item' and `editor'.OIxIEN*$class/key_binding$M.key_binding.G.convertXnsNO.grey50_imageOIxNO.grey50_imageRIOIx);N @grey50_imageOIxImage filled with 50% 1'snOIxIEN $topics$23XOIxIEN O.black_imageXXaCnumberOIxx