fbsdk/fbdeck.h File Reference
 
 
 
fbsdk/fbdeck.h File Reference
#include <kaydaradef.h>
#include <fbsdk/fbcomponent.h>

File Description

Contains abstract deck class to interface with a deck.

Definition in file fbdeck.h.

Classes

class   FBDeck
  Interface to a tape deck. More...
class   FBPropertyListDeck
  PropertyList: Deck More...

Defines

#define  FBSDK_DLL   K_DLLIMPORT
  Be sure that FBSDK_DLL is defined only once...
#define  FBRegisterDeck(UniqueNameStr, ClassName, Label, Description, IconFilename)
  Deck class registration.
#define  FBDeckDeclare(ClassName)
  Deck class declaration.
#define  FBDeckImplementation(ThisComponent)   FBClassImplementation( ThisComponent )
  Deck class implementation.

Enumerations

enum   FBDeckTransportMode { kFBDeckTransportNone, kFBDeckTransportSlave, kFBDeckTransportMaster }
  FBDeckTransportMode. More...

Functions

  __FB_FORWARD (FBDeck)
  FB_DEFINE_ENUM (K_DLLIMPORT, DeckTransportMode)
  FB_DEFINE_COMPONENT (K_DLLIMPORT, Deck)

Define Documentation

#define FBSDK_DLL   K_DLLIMPORT

Be sure that FBSDK_DLL is defined only once...

Definition at line 48 of file fbdeck.h.

#define FBRegisterDeck (   UniqueNameStr,
  ClassName,
  Label,
  Description,
  IconFilename 
)
Value:
HIObject RegisterDeck##ClassName( HIObject /*pOwner*/,const char* pName,void * /*pData*/) \
        { \
          ClassName *Class = new ClassName(pName); \
                Class->UniqueName = UniqueNameStr; \
                if (Class->FBCreate()) { \
                        Class->ThreadSync();    \
                        return Class->GetHIObject(); \
                } else { \
                        delete Class; \
                        return NULL; \
                } \
        } \
        FBLibraryModule( ClassName )    \
        {       \
                FBRegisterObject( ClassName,"Decks",Label,Description,RegisterDeck##ClassName, true, IconFilename );    \
        }

Deck class registration.

Parameters:
UniqueNameStr Unique name of deck.
ClassName Name of deck class.
Label Short description.
Description Long description.
IconFilename Filename of associated icon.

Definition at line 64 of file fbdeck.h.

#define FBDeckDeclare (   ClassName )
Value:
FBClassDeclare( ClassName,FBDeck ); \
  public: \
        ClassName(const char* pName):FBDeck(pName) { FBClassInit; } \
  private:

Deck class declaration.

Parameters:
ClassName Name of deck class.

Definition at line 85 of file fbdeck.h.

#define FBDeckImplementation (   ThisComponent )    FBClassImplementation( ThisComponent )

Deck class implementation.

Parameters:
ThisComponent Class to implement.

Definition at line 94 of file fbdeck.h.


Enumeration Type Documentation

FBDeckTransportMode.

Enumerator:
kFBDeckTransportNone 

No transport interaction.

kFBDeckTransportSlave 

Slave to transport controls.

kFBDeckTransportMaster 

Transport master.

Definition at line 104 of file fbdeck.h.


Function Documentation

__FB_FORWARD ( FBDeck  )
FB_DEFINE_ENUM ( K_DLLIMPORT  ,
DeckTransportMode   
)
FB_DEFINE_COMPONENT ( K_DLLIMPORT  ,
Deck   
)

Go to the source code of this file.