21.28 TabControl Interface

ORIGIN '~beta/guienv/guienv';
LIB_DEF 'guienvutilstabctrl' '../../lib';
BODY 'private/tabControlBody';
(*
 * COPYRIGHT
 *       Copyright (C) Mjolner Informatics, 1997-98
 *       All rights reserved.
 *)

-- windowLib: attributes --

tabControl: canvas
  (# <<SLOT tabControlLib: attributes>>;
     
     resourceAllocationError:< exception
       (# errorMsg: ^text;
       enter errorMsg[]
       do INNER;
       #);
     
     apiError:< exception
       (# errorMsg: ^text;
       enter errorMsg[]
       do INNER;
       #);
     
     useError:< exception
       (# errorMsg: ^text;
       enter errorMsg[]
       do INNER;
       #);
     
     multiLine:<
       (* if multiLine is TRUE the tabControl displays multiple  
        * rows of tabs, if necessary, so all tabs are visible at once.   
        *)
       booleanValue;
     
     tab:
       (# label:
            (# theLabel: ^text;
            enter (# enter theLabel[] ... #)
            exit (# ... exit theLabel[] #)
            #);
          icon:
            (# theIcon: ^pixmap;
            enter (# enter theIcon[] ... #)
            exit (# ... exit theIcon[] #)
            #);
          page:      
            (# thePage: ^canvas;
            enter (# enter thePage[] ... #)
            exit (# ... exit thePage[] #)
            #);
          
          open:<(# ... #);
          
          close:<
            (# ... #);
          
          select:
            (# ... #);   
          
          onSelect:<
            (* Called when the selection has been changed by the end user *)
            (# 
            do INNER onSelect; 
            #); 
          
          tabPrivate: @...;
          
       #);
     
     tabs: @
       (# 
          size: integerValue
            (# ... #);
          
          scan:
            (# current: ^tab;
            ...
            #);
          
          tabsPrivate: @...;
       #);
     
     open::<
       (# create::<
            (# ... #);
       ... 
       #);
     
     close::<
       (# ... #);
     
     onBeforeSelectionChange:<
       (* Called when the selection is about to change;
        * Assign FALSE to allow to prevent the selection from changing.
        *)
       (# allow: @boolean;
       do TRUE -> allow;
          INNER; 
       exit allow
       #);
     
     selection:
       (# theTab: ^tab;
       enter (# enter theTab[] ... #)
       exit (# ... exit theTab[] #)
       #);
     
     eventHandler::<
       (# onMouseUp::<
            (# ... #);
          onMouseDown::<
            (# ... #);
          onFatherFrameChanged::<
            (# ... #);
          onActivate::<
            (# ... #);
                 onRefresh::<
                     (# ... #);
       #);
     private: @...;
  #)