/*
 * $Id: button.txt 500 2011-02-28 10:28:37Z xxxxxx $
 */


/*  $DOC$
    $NAME$
        Button

    $CATEGORY$
        Control

    $SYNTAX STANDART$
        @ <nRow> ,<nCol>
            BUTTON <ControlName>
            [ OF | PARENT <ParentWindowName> ]
            CAPTION <cCaption>
            PICTURE <cPictureName> [ TOP | BOTTOM | LEFT | RIGHT ]
            ACTION | ONCLICK | ON CLICK <ActionProcedureName> | <bBlock>
            [ WIDTH <nWidth> HEIGHT <nHeight> ]
            [ FONT <cFontName> SIZE <nFontSize> ]
            [ BOLD ] [ ITALIC ] [ UNDERLINE ] [ STRIKEOUT ]
            [ TOOLTIP <cToolTipText> ]
            [ FLAT ]
            [ NOTRANSPARENT ]
            [ ON GOTFOCUS <OnGotFocusProcedur> | <bBlock> ]
            [ ON LOSTFOCUS <OnLostFocusProcedure> | <bBlock> ]
            [ NOTABSTOP ]
            [ HELPID <nHelpId> ]
            [ INVISIBLE ]
            [ MULTILINE ]

    $SYNTAX ALTERNATE$
        DEFINE BUTTON <ButtonName>
           PARENT <ParentWindowName>
           ROW <nValue>
           COL <nValue>
           CAPTION <cValue>
           PICTURE <cValue>
           PICTALIGNMENT Top | Left | Right | Bottom
           ONCLICK <ActionProcedure>
           WIDTH <nValue>
           HEIGHT <nValue>
           FONTNAME <cValue>
           FONTSIZE
           FONTBOLD
           FONTITALIC
           FONTUNDERLINE
           FONTSTRIKEOUT
           TOOLTIP
           FLAT
           TRANSPARENT
           ONGOTFOCUS
           ONLOSTFOCUS
           TABSTOP
           HELPID
           VISIBLE
           MULTILINE
        END BUTTON

    $SYNTAX WITH OBJECT$
        WITH OBJECT <oName> := Button():New()
           :ROW  <nValue>
           :COL  <nValue>
           :WIDTH  <nValue>
           [...]
        END WITH

    $SYNTAX OOP$
        <oName> := Button():New()
        <oName>:Row ( <nValue> )
        [...]

    $ARGUMENTS$

    $RETURNS$

    $DESCRIPTION$

    $SAMPLE$
        /samples/button

    $PROPERTIES$
        - Enabled     $LINK$ enabled      link to page enabled property
        - Visible     $LINK$ visible
        - Row         $LINK$ row
        - Col         $LINK$ col
        - Width       $LINK$ width
        - Height
        - Caption
        - FontName
        - FontSize
        - FontBold
        - FontItalic
        - FontUnderline
        - FontStrikeout
        - ToolTip
        - Picture
        - Name (R)
        - Parent (D)
        - Flat (D)
        - TabStop (D)
        - HelpId (D)
        - Transparent (D)
        - PictAlignment (D)
        - MultiLine (D)
        - PictAlignment   $HMG4 EXTENSION$    $LINK$ pictalignment

        D: Available at control definition only
        R: Read-Only

    $METHODS$
        - Show            $LINK$  Show
        - Hide            $LINK$  Hide
        - SetFocus        $LINK$  SetFocus
        - Release         $LINK$  Release

    $EVENTS$
        - OnGotFocus      $LINK$ OnGotFocus
        - OnLostFocus     $LINK$ OnLostFocus
        - OnClick         $LINK$ OnClick

    $SOURCE$
        /source/button

    $SEEALSO$
        checkbutton       $LINK$ checkbutton

    $HINTS$

    $NOTES$
        Transparence in picture buttons requires 256 or less color depth bitmaps.

    $STATUS$

    $END$
 */


