Scrap.h

Go to the documentation of this file.

 
#ifndef __SCRAP__
#define __SCRAP__
 
#ifndef __MIXEDMODE__
#include <MixedMode.h>
#endif
 
#ifndef __MACERRORS__
#include <MacErrors.h>
#endif
 
#ifndef __CFSTRING__
#include <CFString.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
 
    typedef FourCharCode ScrapFlavorType;
    enum
    {
        kScrapFlavorTypePicture =
            FOUR_CHAR_CODE('PICT'),                    
        kScrapFlavorTypeText = FOUR_CHAR_CODE('TEXT'), 
        kScrapFlavorTypeTextStyle =
            FOUR_CHAR_CODE('styl'),                     
        kScrapFlavorTypeMovie = FOUR_CHAR_CODE('moov'), 
        kScrapFlavorTypeSound =
            FOUR_CHAR_CODE('snd '), 
        kScrapFlavorTypeUnicode =
            FOUR_CHAR_CODE('utxt'), 
        kScrapFlavorTypeUnicodeStyle =
            FOUR_CHAR_CODE('ustl') 
    };
 
    OSStatus
    LoadScrap(void);
 
    OSStatus
    UnloadScrap(void);
 
#if CALL_NOT_IN_CARBON
    struct ScrapStuff
    {
        SInt32 scrapSize;
        Handle scrapHandle;
        SInt16 scrapCount;
        SInt16 scrapState;
        StringPtr scrapName;
    };
    typedef struct ScrapStuff ScrapStuff;
    typedef ScrapStuff *PScrapStuff;
    typedef ScrapStuff *ScrapStuffPtr;
#endif 
#if CALL_NOT_IN_CARBON
 
    ScrapStuffPtr
    InfoScrap(void);
 
    long
    GetScrap(Handle destination, ScrapFlavorType flavorType, SInt32 *offset);
 
    OSStatus
    ZeroScrap(void);
 
    OSStatus
    PutScrap(SInt32 sourceBufferByteCount, ScrapFlavorType flavorType,
             const void *sourceBuffer);
 
#endif 
    enum
    {
        kScrapFlavorSizeUnknown = -1
    };
 
    enum
    {
        kScrapReservedFlavorType = FOUR_CHAR_CODE('srft')
    };
 
    enum
    {
        kScrapFlavorMaskNone = 0x00000000,
        kScrapFlavorMaskSenderOnly = 0x00000001,
        kScrapFlavorMaskTranslated = 0x00000002
    };
 
    typedef UInt32 ScrapFlavorFlags;
    struct ScrapFlavorInfo
    {
        ScrapFlavorType flavorType;
        ScrapFlavorFlags flavorFlags;
    };
    typedef struct ScrapFlavorInfo ScrapFlavorInfo;
    typedef struct OpaqueScrapRef *ScrapRef;
#define kScrapRefNone ((ScrapRef)NULL)
#define kScrapClipboardScrap CFSTR("com.apple.scrap.clipboard")
#define kScrapFindScrap CFSTR("com.apple.scrap.find")
 
    enum
    {
        kScrapGetNamedScrap = 0, 
        kScrapClearNamedScrap =
            (1L << 0) 
    };
 
    OSStatus
    GetScrapByName(CFStringRef name, OptionBits options, ScrapRef *scrap);
 
    OSStatus
    GetCurrentScrap(ScrapRef *scrap);
 
    OSStatus
    GetScrapFlavorFlags(ScrapRef scrap, ScrapFlavorType flavorType,
                        ScrapFlavorFlags *flavorFlags);
 
    OSStatus
    GetScrapFlavorSize(ScrapRef scrap, ScrapFlavorType flavorType, Size *byteCount);
 
    OSStatus
    GetScrapFlavorData(ScrapRef scrap, ScrapFlavorType flavorType, Size *byteCount,
                       void *destination);
 
    OSStatus
    ClearCurrentScrap(void);
 
    OSStatus
    ClearScrap(ScrapRef *inOutScrap);
 
    OSStatus
    PutScrapFlavor(ScrapRef scrap, ScrapFlavorType flavorType,
                   ScrapFlavorFlags flavorFlags, Size flavorSize,
                   const void *flavorData); 
    typedef CALLBACK_API(OSStatus,
                         ScrapPromiseKeeperProcPtr)(ScrapRef scrap,
                                                    ScrapFlavorType flavorType,
                                                    void *userData);
    typedef STACK_UPP_TYPE(ScrapPromiseKeeperProcPtr) ScrapPromiseKeeperUPP;
    ScrapPromiseKeeperUPP
    NewScrapPromiseKeeperUPP(ScrapPromiseKeeperProcPtr userRoutine);
#if !OPAQUE_UPP_TYPES
    enum
    {
        uppScrapPromiseKeeperProcInfo = 0x00000FF0
    }; 
#ifdef __cplusplus
    inline ScrapPromiseKeeperUPP
    NewScrapPromiseKeeperUPP(ScrapPromiseKeeperProcPtr userRoutine)
    {
        return (ScrapPromiseKeeperUPP)NewRoutineDescriptor(
            (ProcPtr)(userRoutine), uppScrapPromiseKeeperProcInfo,
            GetCurrentArchitecture());
    }
#else
#define NewScrapPromiseKeeperUPP(userRoutine)                                   \
    (ScrapPromiseKeeperUPP) NewRoutineDescriptor((ProcPtr)(userRoutine),        \
                                                 uppScrapPromiseKeeperProcInfo, \
                                                 GetCurrentArchitecture())
#endif
#endif
 
    void
    DisposeScrapPromiseKeeperUPP(ScrapPromiseKeeperUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
    inline void DisposeScrapPromiseKeeperUPP(ScrapPromiseKeeperUPP userUPP)
    {
        DisposeRoutineDescriptor((UniversalProcPtr)userUPP);
    }
#else
#define DisposeScrapPromiseKeeperUPP(userUPP) DisposeRoutineDescriptor(userUPP)
#endif
#endif
 
    OSStatus
    InvokeScrapPromiseKeeperUPP(ScrapRef scrap, ScrapFlavorType flavorType,
                                void *userData, ScrapPromiseKeeperUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
    inline OSStatus InvokeScrapPromiseKeeperUPP(ScrapRef scrap,
                                                ScrapFlavorType flavorType,
                                                void *userData,
                                                ScrapPromiseKeeperUPP userUPP)
    {
        return (OSStatus)CALL_THREE_PARAMETER_UPP(
            userUPP, uppScrapPromiseKeeperProcInfo, scrap, flavorType, userData);
    }
#else
#define InvokeScrapPromiseKeeperUPP(scrap, flavorType, userData, userUPP)  \
    (OSStatus)                                                             \
        CALL_THREE_PARAMETER_UPP((userUPP), uppScrapPromiseKeeperProcInfo, \
                                 (scrap), (flavorType), (userData))
#endif
#endif
 
#if CALL_NOT_IN_CARBON || OLDROUTINENAMES
#define NewScrapPromiseKeeperProc(userRoutine) \
    NewScrapPromiseKeeperUPP(userRoutine)
#define CallScrapPromiseKeeperProc(userRoutine, scrap, flavorType, userData) \
    InvokeScrapPromiseKeeperUPP(scrap, flavorType, userData, userRoutine)
#endif 
    OSStatus
    SetScrapPromiseKeeper(ScrapRef scrap, ScrapPromiseKeeperUPP upp,
                          const void *userData);
 
    OSStatus
    GetScrapFlavorCount(ScrapRef scrap, UInt32 *infoCount);
 
    OSStatus
    GetScrapFlavorInfoList(ScrapRef scrap, UInt32 *infoCount,
                           ScrapFlavorInfo info[]);
 
    OSStatus
    CallInScrapPromises(void);
 
#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 
* /