ControlStrip.h

Go to the documentation of this file.

 
#ifndef __CONTROLSTRIP__
#define __CONTROLSTRIP__
 
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
 
#ifndef __MENUS__
#include <Menus.h>
#endif
 
#ifndef __DIALOGS__
#include <Dialogs.h>
#endif
 
#if PRAGMA_ONCE
#pragma once
#endif
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#if PRAGMA_IMPORT
#pragma import on
#endif
 
#if PRAGMA_STRUCT_ALIGN
#pragma options align = mac68k
#elif PRAGMA_STRUCT_PACKPUSH
#pragma pack(push, 2)
#elif PRAGMA_STRUCT_PACK
#pragma pack(2)
#endif
 
    /**********************************************************************************************
 
        messages passed to the modules
 
    *********************************************************************************************/
    enum
    {
        sdevInitModule = 0,      
        sdevCloseModule = 1,     
        sdevFeatures = 2,        
        sdevGetDisplayWidth = 3, 
        sdevPeriodicTickle = 4,  
        sdevDrawStatus = 5,      
        sdevMouseClick =
            6, 
        sdevSaveSettings =
            7, 
        sdevShowBalloonHelp =
            8 
    };
 
    /**********************************************************************************************
 
        Features supported by the module.  If a bit is set, it means that feature is
    supported. All undefined bits are reserved for future use by Apple, and should
    be set to zero.
 
    *********************************************************************************************/
    enum
    {
        sdevWantMouseClicks = 0, 
        sdevDontAutoTrack = 1,   
        sdevHasCustomHelp = 2,   
        sdevKeepModuleLocked = 3 
    };
 
    /**********************************************************************************************
 
        Result values returned by the sdevPeriodicTickle and sdevIconMouseClick
    selectors. If a bit is set, the module can request that a specific function is
    performed by the Control Strip.  A result of zero will do nothing.  All
    undefined bits are reserved for future use by Apple, and should be set to zero.
 
    *********************************************************************************************/
    enum
    {
        sdevResizeDisplay = 0, 
        sdevNeedToSave = 1,    
        sdevHelpStateChange =
            2,           
        sdevCloseNow = 3 
    };
 
    /**********************************************************************************************
 
        miscellaneous
 
    *********************************************************************************************/
    enum
    {
        sdevFileType = FOUR_CHAR_CODE('sdev') 
    };
 
    enum
    {
        sdevMenuItemMark = 0xA5 
    };
 
    enum
    {
        BarGraphSlopeLeft = -1, 
        BarGraphFlatRight = 0,  
        BarGraphSlopeRight = 1  
    };
 
/**********************************************************************************************
 
    utility routines to provide standard interface elements and support for
common functions
 
*********************************************************************************************/
#if CALL_NOT_IN_CARBON
    Boolean
    SBIsControlStripVisible(void);
 
    void
    SBShowHideControlStrip(Boolean showIt);
 
    Boolean
    SBSafeToAccessStartupDisk(void);
 
    short
    SBOpenModuleResourceFile(OSType fileCreator);
 
    OSErr
    SBLoadPreferences(ConstStr255Param prefsResourceName, Handle *preferences);
 
    OSErr
    SBSavePreferences(ConstStr255Param prefsResourceName, Handle preferences);
 
    void
    SBGetDetachedIndString(StringPtr theString, Handle stringList,
                           short whichString);
 
    OSErr
    SBGetDetachIconSuite(Handle *theIconSuite, short theResID,
                         unsigned long selector);
 
    short
    SBTrackPopupMenu(const Rect *moduleRect, MenuRef theMenu);
 
    short
    SBTrackSlider(const Rect *moduleRect, short ticksOnSlider, short initialValue);
 
    OSErr
    SBShowHelpString(const Rect *moduleRect, StringPtr helpString);
 
    short
    SBGetBarGraphWidth(short barCount);
 
    void
    SBDrawBarGraph(short level, short barCount, short direction,
                   Point barGraphTopLeft);
 
    void
    SBModalDialogInContext(ModalFilterUPP filterProc, short *itemHit);
 
    OSErr
    SBGetControlStripFontID(short *fontID);
 
    OSErr
    SBSetControlStripFontID(short fontID);
 
    OSErr
    SBGetControlStripFontSize(short *fontSize);
 
    OSErr
    SBSetControlStripFontSize(short fontSize);
 
    OSErr
    SBGetShowHideHotKey(short *modifiers, unsigned char *keyCode);
 
    OSErr
    SBSetShowHideHotKey(short modifiers, unsigned char keyCode);
 
    OSErr
    SBIsShowHideHotKeyEnabled(Boolean *enabled);
 
    OSErr
    SBEnableShowHideHotKey(Boolean enabled);
 
    short
    SBHitTrackSlider(const Rect *moduleRect, short ticksOnSlider,
                     short initialValue, Boolean *hit);
 
#endif 
#if PRAGMA_STRUCT_ALIGN
#pragma options align = reset
#elif PRAGMA_STRUCT_PACKPUSH
#pragma pack(pop)
#elif PRAGMA_STRUCT_PACK
#pragma pack()
#endif
 
#ifdef PRAGMA_IMPORT_OFF
#pragma import off
#elif PRAGMA_IMPORT
#pragma import reset
#endif
 
#ifdef __cplusplus
}
#endif
 
#endif