Mac OS 9
ControlStrip.h File Reference

Control Strip (for Powerbooks and Duos) Interfaces. More...

#include <MacTypes.h>
#include <Menus.h>
#include <Dialogs.h>

Go to the source code of this file.

Enumerations

enum  {
  sdevInitModule = 0 , sdevCloseModule = 1 , sdevFeatures = 2 , sdevGetDisplayWidth = 3 ,
  sdevPeriodicTickle = 4 , sdevDrawStatus = 5 , sdevMouseClick , sdevSaveSettings ,
  sdevShowBalloonHelp
}
 
enum  { sdevWantMouseClicks = 0 , sdevDontAutoTrack = 1 , sdevHasCustomHelp = 2 , sdevKeepModuleLocked = 3 }
 
enum  { sdevResizeDisplay = 0 , sdevNeedToSave = 1 , sdevHelpStateChange , sdevCloseNow = 3 }
 
enum  { sdevFileType = FOUR_CHAR_CODE('sdev') }
 
enum  { sdevMenuItemMark = 0xA5 }
 
enum  { BarGraphSlopeLeft = -1 , BarGraphFlatRight = 0 , BarGraphSlopeRight = 1 }
 

Functions

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)
 

Detailed Description

Control Strip (for Powerbooks and Duos) Interfaces.

Introduced In: ControlStrip 1.4
Avaliable From: Universal Interfaces 3.4.1
Copyright: © 1992-2001 by Apple Computer, Inc. All rights reserved.

For bug reports, consult the following page on the World Wide Web:

http://developer.apple.com/bugreporter/

Enumeration Type Documentation

◆ anonymous enum

anonymous enum
Enumerator
sdevCloseModule 

initialize the module

sdevFeatures 

clean up before being closed

sdevGetDisplayWidth 

return feature bits

sdevPeriodicTickle 

returns the width of the module's display

sdevDrawStatus 

periodic tickle when nothing else is happening

sdevMouseClick 

update the interface in the Control Strip

sdevSaveSettings 

user clicked on the module's display area in the Control Strip

sdevShowBalloonHelp 

saved any changed settings in module's preferences file

◆ anonymous enum

anonymous enum
Enumerator
sdevDontAutoTrack 

notify the module of mouseDown events

sdevHasCustomHelp 

call the module to do mouse tracking

sdevKeepModuleLocked 

module provides its own help messages

◆ anonymous enum

anonymous enum
Enumerator
sdevNeedToSave 

resize the module's display

sdevHelpStateChange 

need to save changed settings, when convenient

sdevCloseNow 

need to update the help message because of a state change

◆ anonymous enum

anonymous enum

direction values for SBDrawBarGraph

Enumerator
BarGraphFlatRight 

max end of sloping bar graph is on the left

BarGraphSlopeRight 

max end of flat bar graph is on the right

Function Documentation

◆ SBDrawBarGraph()

void SBDrawBarGraph ( short  level,
short  barCount,
short  direction,
Point  barGraphTopLeft 
)

SBDrawBarGraph()

Non-Carbon CFM: in ControlStripLib 1.0 and later
Carbon Lib: not available
Mac OS X: not available

◆ SBEnableShowHideHotKey()

OSErr SBEnableShowHideHotKey ( Boolean  enabled)

SBEnableShowHideHotKey()

Non-Carbon CFM: in ControlStripLib 1.2 and later
Carbon Lib: not available
Mac OS X: not available

◆ SBGetBarGraphWidth()

short SBGetBarGraphWidth ( short  barCount)

SBGetBarGraphWidth()

Non-Carbon CFM: in ControlStripLib 1.0 and later
Carbon Lib: not available
Mac OS X: not available

◆ SBGetControlStripFontID()

OSErr SBGetControlStripFontID ( short *  fontID)

The following routines are available in Control Strip 1.2 and later. SBGetControlStripFontID()

Non-Carbon CFM: in ControlStripLib 1.2 and later
Carbon Lib: not available
Mac OS X: not available

◆ SBGetControlStripFontSize()

OSErr SBGetControlStripFontSize ( short *  fontSize)

SBGetControlStripFontSize()

Non-Carbon CFM: in ControlStripLib 1.2 and later
Carbon Lib: not available
Mac OS X: not available

◆ SBGetDetachedIndString()

void SBGetDetachedIndString ( StringPtr  theString,
Handle  stringList,
short  whichString 
)

SBGetDetachedIndString()

Non-Carbon CFM: in ControlStripLib 1.0 and later
Carbon Lib: not available
Mac OS X: not available

◆ SBGetDetachIconSuite()

OSErr SBGetDetachIconSuite ( Handle *  theIconSuite,
short  theResID,
unsigned long  selector 
)

SBGetDetachIconSuite()

Non-Carbon CFM: in ControlStripLib 1.0 and later
Carbon Lib: not available
Mac OS X: not available

◆ SBGetShowHideHotKey()

OSErr SBGetShowHideHotKey ( short *  modifiers,
unsigned char *  keyCode 
)

SBGetShowHideHotKey()

Non-Carbon CFM: in ControlStripLib 1.2 and later
Carbon Lib: not available
Mac OS X: not available

◆ SBHitTrackSlider()

short SBHitTrackSlider ( const Rect moduleRect,
short  ticksOnSlider,
short  initialValue,
Boolean hit 
)

The following routines are available in Control Strip 1.4 and later. SBHitTrackSlider()

Non-Carbon CFM: in ControlStripLib 1.4 and later
Carbon Lib: not available
Mac OS X: not available

◆ SBIsControlStripVisible()

Boolean SBIsControlStripVisible ( void  )

SBIsControlStripVisible()

Non-Carbon CFM: in ControlStripLib 1.0 and later
Carbon Lib: not available
Mac OS X: not available

◆ SBIsShowHideHotKeyEnabled()

OSErr SBIsShowHideHotKeyEnabled ( Boolean enabled)

SBIsShowHideHotKeyEnabled()

Non-Carbon CFM: in ControlStripLib 1.2 and later
Carbon Lib: not available
Mac OS X: not available

◆ SBLoadPreferences()

OSErr SBLoadPreferences ( ConstStr255Param  prefsResourceName,
Handle *  preferences 
)

SBLoadPreferences()

Non-Carbon CFM: in ControlStripLib 1.0 and later
Carbon Lib: not available
Mac OS X: not available

◆ SBModalDialogInContext()

void SBModalDialogInContext ( ModalFilterUPP  filterProc,
short *  itemHit 
)

SBModalDialogInContext()

Non-Carbon CFM: in ControlStripLib 1.0 and later
Carbon Lib: not available
Mac OS X: not available

◆ SBOpenModuleResourceFile()

short SBOpenModuleResourceFile ( OSType  fileCreator)

SBOpenModuleResourceFile()

Non-Carbon CFM: in ControlStripLib 1.0 and later
Carbon Lib: not available
Mac OS X: not available

◆ SBSafeToAccessStartupDisk()

Boolean SBSafeToAccessStartupDisk ( void  )

SBSafeToAccessStartupDisk()

Non-Carbon CFM: in ControlStripLib 1.0 and later
Carbon Lib: not available
Mac OS X: not available

◆ SBSavePreferences()

OSErr SBSavePreferences ( ConstStr255Param  prefsResourceName,
Handle  preferences 
)

SBSavePreferences()

Non-Carbon CFM: in ControlStripLib 1.0 and later
Carbon Lib: not available
Mac OS X: not available

◆ SBSetControlStripFontID()

OSErr SBSetControlStripFontID ( short  fontID)

SBSetControlStripFontID()

Non-Carbon CFM: in ControlStripLib 1.2 and later
Carbon Lib: not available
Mac OS X: not available

◆ SBSetControlStripFontSize()

OSErr SBSetControlStripFontSize ( short  fontSize)

SBSetControlStripFontSize()

Non-Carbon CFM: in ControlStripLib 1.2 and later
Carbon Lib: not available
Mac OS X: not available

◆ SBSetShowHideHotKey()

OSErr SBSetShowHideHotKey ( short  modifiers,
unsigned char  keyCode 
)

SBSetShowHideHotKey()

Non-Carbon CFM: in ControlStripLib 1.2 and later
Carbon Lib: not available
Mac OS X: not available

◆ SBShowHelpString()

OSErr SBShowHelpString ( const Rect moduleRect,
StringPtr  helpString 
)

SBShowHelpString()

Non-Carbon CFM: in ControlStripLib 1.0 and later
Carbon Lib: not available
Mac OS X: not available

◆ SBShowHideControlStrip()

void SBShowHideControlStrip ( Boolean  showIt)

SBShowHideControlStrip()

Non-Carbon CFM: in ControlStripLib 1.0 and later
Carbon Lib: not available
Mac OS X: not available

◆ SBTrackPopupMenu()

short SBTrackPopupMenu ( const Rect moduleRect,
MenuRef  theMenu 
)

SBTrackPopupMenu()

Non-Carbon CFM: in ControlStripLib 1.0 and later
Carbon Lib: not available
Mac OS X: not available

◆ SBTrackSlider()

short SBTrackSlider ( const Rect moduleRect,
short  ticksOnSlider,
short  initialValue 
)

SBTrackSlider()

Non-Carbon CFM: in ControlStripLib 1.0 and later
Carbon Lib: not available
Mac OS X: not available