GuiCOBOL objects are used to gather properties, methods and events for elements that are either common to many controls, such as the RenderText and Font objects, or that are repeated many times within a control. The one exception is the Form object that has a single instance and can be used and referenced much like any of the controls.
The objects are usually referred to as a property of the containing control. The syntax for referring to a property of an object is:
move “Property-name” OF “Object-name” to {COBOL FIELD}
Here the list of the objects’s properties, methods, and events.
| Legend of ALL items |
| NameType (method or property) < Class Description of the action Example of usage |
| addbutton method BUTTON WIDGET add a button invoke object “addbutton” RETURNING object |
| addbuttonto method BUTTON WIDGET add a button with on click procedure invoke parent “addbuttonto” using “testo” “procedure” RETURNING object |
| addcheck method CHECK WIDGET add a check invoke parent “addcheck” using “testo” RETURNING object |
| addcheckto method CHECK WIDGET add a check with on click procedure invoke parent “addcheckto” using “testo” “procedure” RETURNING object |
| addchild method FORM WIDGET add a child form to the ancestor invoke form “addchild” returning achildform |
| addcombo method COMBOWIDGET add a combo invoke object “addcombo” using “testo” RETURNING object |
| addevent method event WIDGET bind an evento to a procedure invoke object “addevent” using event procedure |
| addfixed method FIXED CONTAINERS add a fixed container invoke parent “addfixed” RETURNING object |
| addform method FORM FORM add a form invoke super “addform” RETURNING object |
| addframe method FRAME CONTAINERS add a frame (vertical) invoke parent “addframe” RETURNING object |
| addhoriz method FRAME WIDGET add a vertical frame invoke object “addHoriz” |
| additem method COMBO RADIOWIDGET add an item to the appropriate widget invoke widget “additem” using text |
| addlabel method LABEL WIDGET add a label invoke parent “addlabel” using “text” RETURNING object |
| addlink method MENU WIDGET add a menu with an onclick procedure invoke menu “addlink” using “text” procedure returning anode |
| addmenu method MENU WIDGET add a name of menu invoke object “addmenu” RETURNING object |
| addmenuitem method MENU WIDGET add an item of the menu (dynamic) invoke menu “addmenueitem” using agar-text returning anode |
| addnode method MENU WIDGET add a node under the appropriate menu object invoke menu “addnode” using agar-text returning anode |
| addnumeric method NUMERIC WIDGET add a numeric invoke parent “addnumeric” using “testo” RETURNING object |
| addpane method PANEC ONTAINERS add a pane structure (with two box) invoke parent “addpane” using “vertic”/”horizonal” RETURNING side1 side2 |
| addprogress method PROGRESS WIDGET add a progressive bar invoke parent “addprogress” returning agar-object. |
| addproperty method ANY WIDGET add a generic property to the object invoke widget “addproperty” using “name” value returning agar-object. |
| addradio method RADIO WIDGET add a radio invoke parent “addradio” RETURNING object |
| addradioto method RADIO WIDGET add a radio with onlclick procedure invoke parent “addradioto” using “ThisEventProcedure” RETURNING object |
| addscroll method SCROLL CONTAINERS add a scroll (horizzontal)invoke parent “addscroll” returning object. (horizzontal) |
| addscrollv method SCROLL CONTAINERS add a verfical scroll invoke parent “addscrollv” returning object. (horizzontal) |
| addscrollview method SCROLL CONTAINERS add a scroll bar invoke parent “addscrollview” returning object. (horizzontal) |
| addslider method SLIDER WIDGET add a slider invoke widget “addslider” returning agar-object. (horizzontal) |
| addsliderv method SLIDER WIDGET add a vertical slider invoke widget “addsliderv” returning agar-object. (vertical) |
| addspaceshoriz method FORM WIDGET add a space after the object invoke widget “addspacehoriz” |
| addspacesvertic method FORM WIDGET add a space in vertical after the object invoke widget “addspacevertic” |
| addtext method TEXT WIDGET add a textbox invoke parent “addtext” using “text” RETURNING object |
| addvertic method FORM WIDGET add a vertical cosmetic separator invoke widget “addvertic” |
| close method RUN WIDGET close the instance invoke self “close” |
| closed event FORM FORM invoke a callback procedure on closed invoke self “closed” using procedure |
| connect method TEXT WIDGET bind a text to a working storage field invoke widget “connect” using buffer |
| disable method ANY WIDGET disable the object invoke widget “disable” |
| DisableDebug method GENERIC FORM stop the internal guicobol debugger from this method invoke self “disabledebug” |
| enable method ANY WIDGET enable the object invoke widget “enable” |
| EnableDebug method GENERIC FORM enable the internal guicobol debugger from this method invoke self “enabledebug” |
| expand event FORM FORM expand the widget according the actual form size invoke object “expand” |
| expandheight event FORM SELF expand the widgets for heght invoke object “expandheight” |
| expandwidth event FORM FORMexpnad the widgets for width invoke object “expandwidth” |
| find method FORM FORM find the object for the given name invoke parent “find” using “name” RETURNING object |
| get-caption property LABEL FORM TEXTWIDGET sets a caption to the appropriate object move “caption” of self TO VARIABLE |
| get-class property ANY WIDGET returns the class inherance for the object move “class” of object to agar-class |
| get-cursor property TEXT WIDGET gets the cursor position inside the field move “cursor” of object to integer |
| get-focused property ANY WIDGET obtains the focus for the widget move “focused” of self to widget |
| get-height property ANY WIDGET returns the heigh of the widget move “height” of object to agar-height |
| get-left property ANY WIDGET returns the left position for the widget (x coordinate) move “left” of object to agar-height |
| get-max property NUMERIC WIDGET returns the max value acceptable for the widget move “max” of widget to value |
| get-min property NUMERIC WIDGET returns the minimu value acceptable for the widget move “min” of widget to value |
| get-name property ANY WIDGET returns the name for the widget move “name” of object to agar-text |
| get-node property MENU WIDGET get the node object for the menu MOVE “node”” of menu TO VARIABLE |
| get-objectpropertyANYWIDGETreturns the object for the called name widgetmove “object” of nome to agar-object |
| get-parent property ANY WIDGET returns the parents for the object move “parent” of object to agar-parent |
| get-root property ANY WIDGET returns the root for the object move “root” of object to agar-object |
| get-text property TEXT WIDGET gets the text for the textbox move “text” of object to agar-text |
| get-top property ANY WIDGET gets the cursor position inside the field move “top” of object to integer |
| get-value property TEXT COMBO CHECK WIDGET gets the current value move “value” of check to value |
| get-width property ANY WIDGET gets the width value move “width object to integer |
| getproperty property ANY WIDGET get the property for the object (custom definition) invoke widget “getproperty” using “nome” returning valore |
| gotfocus method ANY WIDGET sets the onfocus procedure for the widget invoke object “gotfocus” |
| hide method ANY WIDGET hide the instanced widget invoke object “hide” |
| keydown TEXT WIDGET WIDGET sets the procedure while downling a keyboard invoke object “keydown” using procedure |
| keyreturn TEXT WIDGET WIDGET sets the procedure while returnign a keyboard invoke object “keydown” using procedure |
| keyup TEXT WIDGET WIDGET sets the procedure while updown a keyboardinvoke object “keyup” using procedure |
| maximize method FORM FORM maximizes the form invoke self “maximize” |
| menusection method MENU FORM add a section menu (only text information) invoke menuobject “menusection” usign “this is a section” |
| menuseparator method MENUFORM add a menu separator (cosmetic features) invoke menuobject “menuseparator” |
| minimize method FORM WIDGET minimizes the current form invoke self “minimize” |
| move method ANY WIDGET move the object at X Y coordinates invoke widget “move” using 100 200 |
| refresh method ANY WIDGET force e rendering for the widget invoke object “refresh” |
| remove method MENU WIDGET remove the node from the menu invoke menuobject “remove” using this-node |
| run method FORM FORM run the main event loop invoke object “run” |
| set-backcolor property ANY WIDGET sets a back color for the widget move “red” to “backcolor” of widget |
| set-bordercolor property ANY WIDGET sets a border color for the widget move “red” to “bordercolor” of widget |
| set-caption propert LABEL FORM TEXT WIDGET sets a caption to the appropriate object move “tittle” to “caption” of object |
| set-color property ANY WIDGET sets a color for the widget move “red” to “color” of widget |
| set-cursor property TEXT WIDGET sets a specific position for the cursor inside the text move Integer to “cursor” of object |
| set-decimal property NUMERIC WIDGET binds a decimal to the numeric widget move “decimal” of numeric to buffer |
| set-disposition property RADIO WIDGET sets disposition for the form move “horizontal” to “disposition” of radio |
| set-error event FORM FORM invoke an error message upon the form move “severe error!!!” to “error” of self |
| set-font property ANY WIDGET changes the font property move “courier” to “font” of widget (inline) |
| set-fontsize property ANY WIDGET changes the font size move “100%” to “fontsize” of widget |
| set-fontstyle property ANY WIDGET changes the font style move “italic” to “fontstyle” of widget |
| set-fontweight property ANY WIDGET changes the font weight move “bold” to “fontweight” of widget (INLINE CODE) |
| set-height property ANY WIDGET changes the forn height move 10 to “height” of object |
| set-homogenous property FORM FORM arranges the widgets with homogenous space move agar-true to “homogenous” of widget |
| set-increment property NUMERIC WIDGET sets a specific numeric increment for the widget move 2 to “increment” of widget |
| set-incrementdecimal property NUMERIC WIDGET sets a float increment for the widget move 2.5 to “incrementdecimal” of widget |
| set-info event FORM WIDGET invoke an information message move “ciao” to “warning” of self |
| set-isdecimal property NUMERIC WIDGET returns a boolean value for the decimal widget move agar-true to “isdecimal” of widget |
| set-isnumeric property NUMERIC WIDGET returns a boolean value for the numeric widget move agar-true to “isnumeric” of widget |
| set-left property ANY WIDGET sets the appropriate x coordinates for the widget move 10 to “left” of object |
| set-max property NUMERIC WIDGET sets a max value for the widget move 100 to “max” of object |
| set-maxdecimal property NUMERIC WIDGET sets a max decimal value for the widget move 100 to “maxdecimal” of object |
| set-maxitem property NUMERIC WIDGET sets the max number for allowed items move 10 to “maxitem” of widget |
| set-min property NUMERIC WIDGET sets the minimum value for the widget move 100 to “min” of object |
| set-mindecimal property NUMERIC WIDGET set the minimum flat value for the widget move 100 to “mindecimal” of object |
| set-name property ANY WIDGET sets the name property for the widget move “this is the name” to “name” of object |
| set-numeric property NUMERIC WIDGET sets the numeric binding the the widget move “numeric” of widget to thisfield |
| set-position property FORM FORM sets the position for the form move position to “position” of window |
| set-prompt property TEXT WIDGET sets a prompt value for the empty text move “insert a valid name” to “prompt” of object |
| set-render property EDIT COMBO WIDGET forces the render to a specific pattern move “x(6)” to “render” of object |
| set-size property SLIDER WIDGET sets the specific size value move 100 to “size” of object use for slider !!!! |
| set-text property TEXT WIDGET sets the value of the text property move “valore” to “text” of text |
| set-textcolor property ANY WIDGET sets the text color for the widget move “red” to “textcolor” of widget |
| set-top property ANY WIDGET set the top (y coordinates) position move 10 to “top” of object |
| set-value property COMBO NUMERIC WIDGET sets the value for the widget move agar-true to “value” of check |
| set-visible property ANY WIDGET puts the widget visible move agar-true to “visible” of object |
| set-warning event FORM FORM display a warning message upon the form move “stay quiet” to “warning” of self |
| set-width property ANY WIDGET assignes the appropriate width to the widget move 10 to “width” of object |
| show method FORM FORM shows the form (force rendering) invoke object “show” |
| size property ANY WIDGET sets the appropriate size for the widget invoke widget “size” using 100 200 |
| stoprun event FORMFORM perform a stop run invoke super “stoprun” |
| zoomin event FORM FORM zoomin all widgets inside the form (reduce) invoke super “zoomin” |
| zoomout event FORM FORM zooout all widgets inside the form (enlarge) invoke super “zoomout” |
| zoomreset event FORM FORM reset the normal widgets size invoke super “zoomreset” |