TABLE OF CONTENTS checkbox.gadget/--datasheet-- checkbox.gadget/CHECKBOX_GetClass checkbox.gadget/--datasheet-- checkbox.gadget/--datasheet-- NAME checkbox.gadget -- Create checkbox BOOPSI objects SUPERCLASS gadgetclass REQUIRES bevel.image, glyph.image, sysiclass DESCRIPTION The checkbox gadget class is used to create toggling check buttons. Selection of an associated option is denoted by the gadget being "checked" or in other words, containing a checkmark with in the checkbox. Unlike GadTools, GA_Height and GA_Width do not specify the checkbox size but rather the entire hit box area which includes the text label. The checkbox will maintain its aspect ratio when possible. METHODS OM_NEW -- Passed to superclass, defaults set then OM_SET. OM_DISPOSE -- Passed to superclass. OM_SET -- Passed to superclass then custom tags set & render. OM_GET -- Returns requested setting or passed to superclass. OM_UPDATE -- Passed to superclass then custom tags set & render. OM_NOTIFY -- Tag set then passed to superclass. GM_DOMAIN -- Returns GDOMAIN_MINIMUM, GDOMAIN_NOMINAL and GDOMAIN_MAXIMUM dimensions. GM_GOACTIVE -- Passed to superclass then check activated. GM_GOINACTIVE -- Passed to superclass then check deactivated. GM_HANDLEINPUT -- Overrides superclass. GM_HITTEST -- Overrides superclass, returns GMR_HITTEST. GM_RENDER -- Renders or erases checkmark glyph. GM_HELPTEST -- Determine if gadget help was hit. GM_LAYOUT -- Calculate relative gadget coordinates. GM_EXTENT -- Reports gadget rendering extent. GM_CLIPRECT -- Installs ClipRect for virtual group support. GM_KEYGOACTIVE -- Handle keyboard activation. (V53.3) GM_KEYGOINACTIVE -- Handle keyboard deactivation. (V53.3) All other methods are passed to the superclass. ATTRIBUTES GA_ID (uint16) Unique ID number for the gadget. Defaults to 0. Applicability is (OM_NEW, OM_SET, OM_GET, OM_UPDATE, OM_NOTIFY) GA_Text (CONST_STRPTR) Used to set the text label for the checkbox. Defaults to NULL. Applicability is (OM_NEW, OM_SET, OM_GET, OM_UPDATE) GA_Underscore (uint8) Underscore/escape character for keyboard shortcuts. Defaults to the '_' character. Applicability is (OM_NEW, OM_SET, OM_GET, OM_UPDATE) GA_TextAttr (struct TextAttr *) Used to set the text font to render the checkbox label. Defaults to RPort->Font, which is often the screen or window font. Applicability is (OM_NEW, OM_SET, OM_GET, OM_UPDATE) GA_Selected (BOOL) Used to set the checkmark state via application control. Defaults to FALSE. Applicability is (OM_NEW, OM_SET, OM_GET, OM_UPDATE, OM_NOTIFY) GA_Disabled (BOOL) Used to disable the gadget and render a disable ghost pattern of the checkbox. Defaults to FALSE. Applicability is (OM_NEW, OM_SET, OM_GET, OM_UPDATE) GA_Image (struct Image *) The image object to use for the label instead of a text string. GA_Text overrides this attribute. Defaults to NULL. Applicability is (OM_NEW, OM_SET, OM_GET, OM_UPDATE) GA_ReadOnly (BOOL) Sets the gadget to read-only or not. Defaults to FALSE. Applicability is (OM_NEW, OM_SET, OM_GET, OM_UPDATE) GA_BackFill (struct Hook *) A layer backfill hook to provide a more complex background pattern. See InstallLayerHook() for more details about the backfill hook. Defaults to NULL. Applicability is (OM_NEW, OM_SET, OM_UPDATE) GA_HintInfo (CONST_STRPTR) Specify the text to use as the hint info for this gadget. You can change this attribute at any time, and it will over- ride any text specified in the windows HintInfo array. See window.class autodoc for more information. Defaults to NULL. Applicability is (OM_NEW, OM_SET). CHECKBOX_TextPen (uint16) Pen number used to render the text label. Defaults to TEXTPEN. Applicability is (OM_NEW, OM_SET, OM_UPDATE) CHECKBOX_BackgroundPen (uint16) Pen number used to render the gadget background. Defaults to BACKGROUNDPEN. Applicability is (OM_NEW, OM_SET, OM_UPDATE) CHECKBOX_TextPlace (uint16) Location of checkbox text label. Supported values are: PLACETEXT_RIGHT PLACETEXT_LEFT Defaults to PLACETEXT_RIGHT. Applicability is (OM_NEW, OM_SET, OM_UPDATE) CHECKBOX_Invert (BOOL) (V50) Invert the state of the checkbox so that TRUE is FALSE and FALSE is now TRUE. Defaults to FALSE. Applicability is (OM_NEW, OM_SET, OM_UPDATE) checkbox.gadget/CHECKBOX_GetClass checkbox.gadget/CHECKBOX_GetClass NAME CHECKBOX_GetClass -- Gets pointer to the checkbox class. SYNOPSIS Class * class = CHECKBOX_GetClass(); FUNCTION This function is deprecated as of V52. Use the "checkbox.gadget" public class ID instead. RESULT class - Pointer to the checkbox class.