Main Page | Modules | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

CP_DrawerWindow Class Reference

CP_Window class to provide support for MacOS drawer windows.

Inheritance diagram for CP_DrawerWindow:

CP_Window CP_Window_Imp CP_View CP_ScriptableObject CP_View_Imp CP_M_SubViewHandler CP_ScriptableObject_Imp CP_M_Persist CP_M_CommandHandler CP_M_DragSource CP_M_DragTarget CP_Object CP_SigSlot::CP_SlotObject CP_NoCopy List of all members.

Containers

CP_ScriptableObject_ImpGetSuperScriptableObject () const
virtual void SetSuperScriptableObject (CP_ScriptableObject_Imp *inSuperScriptableObject)
CP_ScriptableObject_ImpGetDefaultSubScriptableObject () const
void SetDefaultSubScriptableObject (CP_ScriptableObject_Imp *inObject)
CP_ScriptableObject_ImpGetDefaultSuperScriptableObject () const
void SetDefaultSuperScriptableObject (CP_ScriptableObject_Imp *inObject)
static void SetDefaultObject (CP_ScriptableObject_Imp *inDefaultObject)
static CP_ScriptableObject_ImpGetDefaultObject ()
static CP_ScriptableObject_ImpGetScriptableObjectFromToken (const AEDesc &inToken)

Drag Target

virtual void OnDragEnter (CP_DragDrop &inDragDrop, bool inDragHasLeftSender)
virtual void OnDragLeave (CP_DragDrop &inDragDrop)
virtual void OnDragTrack (CP_DragDrop &inDragDrop)
static CP_M_DragTargetFindDragTarget (OSWindow inOSWindow, CP_Point &inMouseLocation, CP_DragDrop &inDragDrop)

Public Member Functions

void Flush ()
void InitFromOSControl (CP_View *inSuperview, OSControl inOSControl)
virtual void SetForeBackColors ()
CP_ViewBackgroundGetViewBackground ()
void SetViewBackground (CP_ViewBackground *inViewBackground)
void SetID (FourCharCode inIdentifier)
FourCharCode GetID ()
void RegisterSignal (const CP_SignalHolder &inSignal)
CP_DataValueSignalFindSignal (const CP_String &inSignalName)
UInt32 GetNumberSignals ()
CP_String GetNthSignalName (UInt32 inSignalIndex)
void RegisterSlot (const CP_SlotHolder &inSlot)
CP_DataValueSlot FindSlot (const CP_String &inSlotName)
UInt32 GetNumberSlots ()
CP_String GetNthSlotName (UInt32 inSlotIndex)
template<class R, class P1, class P2>
CP_CommandHandlerSignalConnect (CPLAT::CP_CommandNo cmd, void(R::*handler)(P1, P2), SInt32 mode)
template<class R, class P1, class P2>
void Connect (CP_Object *control, const CPLAT::CP_String &signalName, void(R::*handler)(P1, P2))
void disconnect_all ()
void signal_connect (CP_Signal *inSender)
void signal_disconnect (CP_Signal *inSender)
Constructor / Destructor
 CP_DrawerWindow (CP_Window *inParent)
 Constructor.
virtual ~CP_DrawerWindow () throw ()
 Destructor.
Appearance
virtual void Show ()
virtual void Hide ()
void Open (SInt16 inEdge=CP_E_DrawerEdge_WindowEdgeDefault)
void Close ()
void Toggle ()
Getters
virtual void InitEventHandler (CP_EventHandler &inEventHandler)
Getters
UInt32 GetPreferredEdge () const
UInt32 GetEdge () const
void GetOffsets (float &outLeadingOffset, float &outTrailingOffset) const
Parent
CP_WindowGetParent ()
void SetParent (CP_Window *inParent)
Setters
void SetPreferredEdge (UInt32 inEdge)
void SetOffsets (float inLeadingOffset, float inTrailingOffset) const
Testers
bool IsOpen ()

Static Public Member Functions

static void Connect (CP_Object *sender, const CP_String &signalName, CP_Object *receiver, const CP_String &slotName, const bool reciprocal=false)
static void Connect (CP_Object *sender, CP_Object *receiver, const bool reciprocal=false, const CP_String &signalName=kCP_Signal_ValueChanged, const CP_String &slotName=kCP_Slot_SetValue)

Protected Member Functions

virtual void FinishInitFromOSControl (OSControl)
virtual bool PtInDropArea (CP_Point &inGlobalPoint)
virtual bool OnCanAcceptDrag (UInt32 inItem, CP_DragDrop &inDragDrop)=0

Protected Attributes

CP_WindowfParentWindow
CP_DataValueSignal fDrawerOpeningSignal
CP_DataValueSignal fDrawerOpenedSignal
CP_DataValueSignal fDrawerClosingSignal
CP_DataValueSignal fDrawerClosedSignal
CP_DataValueSignal fWindowClosingSignal
CP_WindowTypeBase fWindowTypeBase
CP_Size fMinSize
CP_Size fMaxSize
CP_Size fIdealSize
SInt32 fWindowData
bool fIsContainer
CP_Point fPrintLocation
CP_Size fPrintSize
bool fIsFocused
CP_DataValueSignal fFocusChangedSignal
CP_View_Imp_BasefViewImpBase
CP_EventHandler fDummyEventHandler
UInt32 fCommandID
CP_SmartPtr< CP_FrameAdapterfFrameAdapter
UInt32 fFlags
CP_ViewBackgroundfViewBackground
CP_DataValueSignal fBoundsChangedSignal
CP_DataValueSignal fShowSignal
CP_DataValueSignal fHideSignal
CP_DataValueSignal fActivateSignal
CP_DataValueSignal fDeactivateSignal
CP_DataValueSignal fEnableSignal
CP_DataValueSignal fDisableSignal
CP_DataValueSlot fShowSlot
CP_DataValueSlot fHideSlot
CP_DataValueSlot fActivateSlot
CP_DataValueSlot fDeactivateSlot
CP_DataValueSlot fEnableSlot
CP_DataValueSlot fDisableSlot
CP_Signals_ArrayfSignals
CP_Slots_ArrayfSlots
FourCharCode fObjectID
CP_Commands_ArrayfCommands
CP_MenuSelectionSignalfMennuSelectionSignal
sender_set fSenders
CP_WindowfWindow
bool fDropAreaIsHilited
bool fCanAcceptCurrentDrag
CP_SubViews_ListfSubViews
CP_AppleEventHandler_Map fEventHandlers
CP_ScriptableObject_ImpfSuperScriptableObject
CP_ScriptableObject_ImpfDefaultSubScriptableObject
CP_ScriptableObject_ImpfDefaultSuperScriptableObject

Static Protected Attributes

static FourCharCode fObjectIDCount = 0
static CP_DragTarget_ListfsDragTargetList = NULL
static CP_M_DragTargetfsCurrentDragTarget = NULL
static bool fsDragHasLeftSender = false
static CP_ScriptableObject_ImpgDefaultObject = NULL
static bool gInited = false

Private Member Functions

void HandleDrawerOpeningEvent (CP_Event_Base &inEvent)
void HandleDrawerOpenedEvent (CP_Event_Base &inEvent)
void HandleDrawerClosingEvent (CP_Event_Base &inEvent)
void HandleDrawerClosedEvent (CP_Event_Base &inEvent)

Constructor & Destructor Documentation

CPLAT_Begin_Namespace_CPLAT CP_DrawerWindow::CP_DrawerWindow CP_Window inParent  ) 
 

Constructor.

CP_DrawerWindow::~CP_DrawerWindow  )  throw () [virtual]
 

Destructor.


Member Function Documentation

void CP_DrawerWindow::Show  )  [virtual]
 

Reimplemented from CP_Window.

void CP_DrawerWindow::Hide  )  [virtual]
 

Reimplemented from CP_Window.

void CP_DrawerWindow::Open SInt16  inEdge = CP_E_DrawerEdge_WindowEdgeDefault  ) 
 

void CP_DrawerWindow::Close  ) 
 

void CP_DrawerWindow::Toggle  ) 
 

void CP_DrawerWindow::InitEventHandler CP_EventHandler inEventHandler  )  [virtual]
 

Initialize the event handler for events that this class will handle.

Parameters:
inEventHandler CP_EventHandler that handles events for this class.
Exceptions:
none 
Returns:
void

Reimplemented from CP_Window_Imp.

UInt32 CP_DrawerWindow::GetPreferredEdge  )  const
 

UInt32 CP_DrawerWindow::GetEdge  )  const
 

void CP_DrawerWindow::GetOffsets float &  outLeadingOffset,
float &  outTrailingOffset
const
 

CP_Window* CP_DrawerWindow::GetParent  ) 
 

void CP_DrawerWindow::SetParent CP_Window inParent  ) 
 

void CP_DrawerWindow::SetPreferredEdge UInt32  inEdge  ) 
 

void CP_DrawerWindow::SetOffsets float  inLeadingOffset,
float  inTrailingOffset
const
 

bool CP_DrawerWindow::IsOpen  ) 
 

void CP_DrawerWindow::HandleDrawerOpeningEvent CP_Event_Base inEvent  )  [private]
 

void CP_DrawerWindow::HandleDrawerOpenedEvent CP_Event_Base inEvent  )  [private]
 

void CP_DrawerWindow::HandleDrawerClosingEvent CP_Event_Base inEvent  )  [private]
 

void CP_DrawerWindow::HandleDrawerClosedEvent CP_Event_Base inEvent  )  [private]
 

CP_M_Persist * CP_Window::PersistCreator  )  [static, inherited]
 

CP_M_Persist function to create an instance of this button. Called from our CP_PersistManager class to create persistant object from a stream.

Exceptions:
none 
Returns:
CP_M_Persist * Returns a pointer to a new CP_Window object.

Reimplemented from CP_View.

Reimplemented in CP_DocumentWindow.

void CP_Window::Create const CP_Point inUpperLeft,
const CP_Size inContentSize,
const CP_String inWindowTitle,
const CP_WindowTypeBase inWindowType
[inherited]
 

Create the platforms window. This will call on the individual implementation class to actualy create the window implementation.

Parameters:
inUpperLeft Top left coordinate to plaWin window at.
inContentSize Size of the content area of the window.
inWindowTitle Title of the window.
inWindowType CP_WindowTypeBase class that descibes the type of this window.
Exceptions:
none 
Returns:
void

OSWindow CP_Window::GetOSWindow  )  const [inherited]
 

Return the underlying OSs platform window object.

Exceptions:
none 
Returns:
OSWindow const Underlying platforms window object.

CP_Window * CP_Window::GetContainingWindow  )  [virtual, inherited]
 

Return ourselves since we are the outtermost container.

Exceptions:
none 
Returns:
CP_Window * Returns a pointer to this object.

Reimplemented from CP_View_Imp.

void CP_Window::SetLocation const CP_Point inLocation  )  [virtual, inherited]
 

Reimplemented from CP_Window_Imp.

void CP_Window::SetSize const CP_Size inSize  )  [virtual, inherited]
 

Reimplemented from CP_Window_Imp.

void CP_Window::SetOSWindow OSWindow  inWindow  )  [inherited]
 

Sets the underlying OSs platform window object.

Exceptions:
none 
Returns:
void.

void CP_Window::OnInitPersist CP_View inSuperview,
CP_DataValueList inDataValueList
[protected, virtual, inherited]
 

Called from the persistance classes once an object has been created, and now needs to be initialized. This method is used to initialize the data members of the class from the passed in CP_DataValueList which contains fields to initialize a data member.

Once the data members have been initialized, a platforms implementation is created through the CreatePlatformImp() method.

Parameters:
inSubViewHandler The superview that contains this push button.
inDataValueList List of the values for setting the data members of this class to.
Exceptions:
none 
Returns:
void

Reimplemented from CP_View.

void CP_Window_Imp::Select  )  [inherited]
 

Selects this window.

Exceptions:
none 
Returns:
void

void CP_Window_Imp::DoAE_GetData const DescType  inPropertyType,
const AEDesc &  inValue,
AppleEvent &  inOutReply
[virtual, inherited]
 

Handles the get data Apple Event to return some type of data about this window.

Parameters:
inPropertyType The DescType of property we are getting.
inValue Any value of data to get.
inOutReply The AppleEvent where the reply will be placed.
Exceptions:
none 
Returns:
void

Reimplemented from CP_ScriptableObject_Imp.

void CP_Window_Imp::DoAE_SetData const DescType  inPropertyType,
const AEDesc &  inValue,
AppleEvent &  inOutReply
[virtual, inherited]
 

Handles the set data Apple Event to set some type of data about this window.

Parameters:
inPropertyType The DescType of property we are setting.
inValue Any value of data to set.
inOutReply The AppleEvent where the reply will be placed.
Exceptions:
none 
Returns:
DescType typeNull class id.

Reimplemented from CP_ScriptableObject_Imp.

bool CP_Window_Imp::IsCollapseable  )  const [inherited]
 

Returns true if this window is able to be closed.

Exceptions:
none 
Returns:
bool const True if the window can be closed.

bool CP_Window_Imp::IsCollapsed  )  const [inherited]
 

Returns true if this window is collapsed.

Exceptions:
none 
Returns:
bool const True if the window is collapsed.

bool CP_Window_Imp::IsCloseable  )  const [inherited]
 

Returns true if this window is able to be closed.

Exceptions:
none 
Returns:
bool const True if the window can be closed.

bool CP_Window_Imp::IsFloating  )  const [inherited]
 

Returns true if this window is of the floating window class.

Exceptions:
none 
Returns:
bool const True if the window is of the floating window class.

bool CP_Window_Imp::IsModal  )  const [inherited]
 

Returns true if this window is of the modal or moveable modal window classes.

Exceptions:
none 
Returns:
bool const True if the window is of the modal or moveable modal window classes.

bool CP_Window_Imp::IsResizeable  )  const [inherited]
 

Returns true if this window is able to be resized.

Exceptions:
none 
Returns:
bool const True if the window is able to be resized.

bool CP_Window_Imp::IsZoomable  )  const [inherited]
 

Returns true if this window is able to be zoomed.

Exceptions:
none 
Returns:
bool const True if the window is able to be zoomed.

bool CP_Window_Imp::IsZoomed  )  const [inherited]
 

Returns true if this window is zoomed.

Exceptions:
none 
Returns:
bool const True if the window is zoomed.

void CP_Window_Imp::HandleCloseUpdateCommandStatusCommand CP_CommandStatus inOutCommandStatus,
bool &  inOutWasHandled,
CP_CommandNo inCommandNo
[inherited]
 

void CP_Window_Imp::HandleCloseCommand OSStatus inOutStatus,
CP_CommandNo inCommandNo
[virtual, inherited]
 

Called when the user wants to close the window. This will call the OnClose() method to handle the actual closing of the window.

Parameters:
inOutStatus Not used.
inCommandNo Not used.
Exceptions:
none 
Returns:
void

void CP_Window_Imp::PortToGlobal CP_Point inPoint  )  [virtual, inherited]
 

Converts the passed in point from port to global coordinates.

Parameters:
inPoint The point to convert to global coordinates.
Exceptions:
none 
Returns:
void

Reimplemented from CP_View_Imp.

void CP_Window_Imp::PortToGlobal CP_Rect inRect  )  [virtual, inherited]
 

Converts the passed in rect from port to global coordinates.

Parameters:
inRect The rect to convert to global coordinates.
Exceptions:
none 
Returns:
void

Reimplemented from CP_View_Imp.

void CP_Window_Imp::GlobalToPort CP_Point inOutGlobalPoint  )  [virtual, inherited]
 

Converts the passed in point from global coordinates to port coordinates.

Parameters:
inGlobalPoint The global point to convert, and return the result in.
Exceptions:
OSStatusException CP_paramErr if the OS window is NULL.
Returns:
CP_Size const Returns the size of this window.

Reimplemented from CP_View_Imp.

void CP_Window_Imp::GlobalToPort CP_Rect inRect  )  [virtual, inherited]
 

Converts the passed in point from global to local coordinates.

Parameters:
inGlobalPoint The point to convert to local coordinates.
Exceptions:
none 
Returns:
void

void CP_Window_Imp::Flush  )  [inherited]
 

Causes the windows contents to be drawn immediately.

Exceptions:
none 
Returns:
void

OSStatus CP_Window_Imp::GetData UInt32  inTagName,
SInt32  inDataSize,
void *  inData
[virtual, inherited]
 

Sets some user data for this view. This is used to allow users to attach some data to a CP_View object.

Parameters:
inTagName Tag name for the data.
inDataSize Size of the data.
inData The data to be set.
Exceptions:
OSErrExceptions 
Returns:
void

Reimplemented from CP_View_Imp.

void CP_Window_Imp::SetData UInt32  inTagName,
SInt32  inDataSize,
const void *  inData
[virtual, inherited]
 

Sets some user data for this view. This is used to allow users to attach some data to a CP_View object.

Parameters:
inTagName Tag name for the data.
inDataSize Size of the data.
inData The data to be set.
Exceptions:
OSErrExceptions 
Returns:
void

Reimplemented from CP_View_Imp.

void CP_Window_Imp::Refresh  )  [virtual, inherited]
 

Causes the window to be updated.

Exceptions:
none 
Returns:
void

Reimplemented from CP_View_Imp.

void CP_Window_Imp::SendCloseEvent  )  [inherited]
 

Sends the window a close even to itself. This is a handy way to close and delete the window when you want to close it from an event handler, such as the press of a button.

Exceptions:
none 
Returns:
void

void CP_Window_Imp::InstallMouseMovedEventHandler  )  [inherited]
 

CP_Rect CP_Window_Imp::GetLocalBounds  )  [virtual, inherited]
 

Return the local bounds of this window. This will always have the top left corner at location 0, 0.

Exceptions:
none 
Returns:
CP_Rect Returns the bounds of this window.

Reimplemented from CP_View_Imp.

CP_Rect CP_Window_Imp::GetPortBounds  )  [virtual, inherited]
 

Return the port bounds of this window.

Exceptions:
none 
Returns:
CP_Rect Returns the bounds of this window.

Reimplemented from CP_View_Imp.

CP_Rect CP_Window_Imp::GetContentBounds  )  [virtual, inherited]
 

Returns the content bounds of this window. This is the area available to the user for placing views in.

Exceptions:
none 
Returns:
CP_Rect The content area of the window.

Reimplemented from CP_View_Imp.

CP_Rect CP_Window_Imp::GetGlobalBounds  )  [virtual, inherited]
 

Return the global bounds of this window.

Exceptions:
none 
Returns:
CP_Rect Returns the bounds of this bounds. The bounds will be in global coordinates.

CP_Size CP_Window_Imp::GetSize  )  const [virtual, inherited]
 

Return the size of the window.

Exceptions:
none 
Returns:
CP_Size const Returns the size of this window.

Reimplemented from CP_View_Imp.

CP_Point CP_Window_Imp::GetLocation  )  const [virtual, inherited]
 

Return the location of this window.

Exceptions:
none 
Returns:
CP_Point const Returns the location of this window.

Reimplemented from CP_View_Imp.

CP_Size CP_Window_Imp::GetMinSize  )  const [inherited]
 

Return the minimum size a window can shrink to.

Exceptions:
none 
Returns:
CP_Size const The minimum size a window is allowed to shrink to.

CP_Size CP_Window_Imp::GetMaxSize  )  const [inherited]
 

Return the maximum size a window can grow to.

Exceptions:
none 
Returns:
CP_Size const The maximumm size a window is allowed to grow to.

CP_Size CP_Window_Imp::GetIdealSize  )  const [inherited]
 

Return the ideal size we want this window to be.

Exceptions:
none 
Returns:
CP_Size const The ideal size of the window.

OSWindow CP_Window_Imp::GetImpPlatformWindow  )  const [inherited]
 

Returns the MacOS WindowRef that this window object is using for its platform window.

Exceptions:
none 
Returns:
OSWindow MacOS WindowRef that implements the window.

void CP_Window_Imp::Zoom bool  inZoomOutFlag  )  [inherited]
 

Zooms the window in our out depending on the passed in inZoomOutFlag.

Parameters:
inZoomOutFlag Flag to indicate if the window is being zoomed in our out.
Exceptions:
OSErrors 
Returns:
void

void CP_Window_Imp::SetProxyIcon CP_OSIcon inOSIcon  )  [inherited]
 

Sets the proxy icon for this window from the passed in CP_OSIcon, which should contain an icon ref of the desired icon to use.

Parameters:
inOSIcon CP_OSIcon containing an icon ref to be used.
Exceptions:
OSErrors 
Returns:
void

void CP_Window_Imp::SetProxyCreatorType FourCharCode  inCreator,
FourCharCode  inType
[inherited]
 

Sets the creator code and file type used by the window proxy icon / title.

Parameters:
inCreator Creator code.
inType File type.
Exceptions:
OSErrors 
Returns:
void

void CP_Window_Imp::SetProxyFileSpec const CP_FileSystemSpec inFileSpec  )  [inherited]
 

Sets the file spec for the file being displayed in the window. This will enable the title bar to display the path to the file by command clicking on the title in the windows title bar.

Parameters:
inFileSpec The file spec for the windows contents, and the one displayed in the windows title bar.
Exceptions:
OSErrors 
Returns:
void

void CP_Window_Imp::RemoveProxy  )  [inherited]
 

Removes the proxy icon / display from the windows title bar.

Exceptions:
OSErrors 
Returns:
void

void CP_Window_Imp::SetModified bool  inIsModified  )  [inherited]
 

Sets the window modified flag to handle updating the appearance of the proxy icon in the windows title bar.

Parameters:
inIsModified Flag to indicate if the file has been modified.
Exceptions:
OSErrors 
Returns:
void

void CP_Window_Imp::SetEraseOnUpdate bool  inErase  )  [inherited]
 

Sets a flag to indicate that the window is erased on update events.

Parameters:
inErase Flag to indicate if the window is to be erased.
Exceptions:
none 
Returns:
void

void CP_Window_Imp::SetMinSize const CP_Size inMinSize  )  [inherited]
 

Sets the minimum size a window can shrink to.

Parameters:
inMinSize The minimum size a window can shrink to.
Exceptions:
none 
Returns:
void

void CP_Window_Imp::SetMaxSize const CP_Size inMaxSize  )  [inherited]
 

Sets the maximum size a window can grow to.

Parameters:
inMaxSize The maximum size a window can grow to.
Exceptions:
none 
Returns:
void

void CP_Window_Imp::SetIdealSize const CP_Size inIdealSize  )  [inherited]
 

Sets the ideal size we want this window to be.

Exceptions:
none 
Returns:
void

void CP_Window_Imp::SetTitle const CP_String inWindowTitle  )  [inherited]
 

Sets the title of this window.

Parameters:
inWindowTitle CP_String containing the title of the window.
Exceptions:
none 
Returns:
bool const True if the window is composited.

CP_String CP_Window_Imp::GetTitle  )  const [inherited]
 

Gets the title of this window.

Exceptions:
none 
Returns:
CP_String const The title of the window as a CP_String.

bool CP_Window_Imp::IsComposited  )  const [inherited]
 

Returns true if this window is currently using the compositing attribute. This will only be true under MacOSX 10.2 and greater if the CP_WindowType properties has this attribute set at the time the window is created.

Exceptions:
OSErrors 
Returns:
bool const True if the window is composited.

bool CP_Window_Imp::EraseOnUpdate  )  const [inherited]
 

Returns true if we need to erase the windows contents when the window is called upon to draw.

Exceptions:
none 
Returns:
bool const True if the window should be erased.

bool CP_Window_Imp::IsVisible  )  const [virtual, inherited]
 

Returns true if we need to erase the windows contents when the window is called upon to draw.

Exceptions:
none 
Returns:
bool const True if the window should be erased.

Reimplemented from CP_View.

CP_WindowTypeBase CP_Window_Imp::GetWindowTypeBase  )  [inherited]
 

Returns the CP_WindowTypeBase object that controls the appearance and behavior of the window.

Exceptions:
none 
Returns:
CP_WindowTypeBase The CP_WindowTypeBase that controls the windows type and appearance.

void CP_Window_Imp::SetWindowTypeBase const CP_WindowTypeBase inBase  )  [inherited]
 

Sets the CP_WindowTypeBase object that controls the appearance and behavior of the window.

Parameters:
inBase The CP_WindowTypeBase that controls the type and appearance of the window.
Exceptions:
none 
Returns:
void

DescType CP_Window_Imp::GetAppleClass  )  const [protected, virtual, inherited]
 

Returns a DescType to describe this class for the Apple Event Manager. Default is to return typeNull indicating this is the outter container.

Exceptions:
none 
Returns:
DescType typeNull class id.

Implements CP_ScriptableObject_Imp.

void CP_Window_Imp::MakeSelfSpecifier AEDesc &  inContainerSpec,
AEDesc &  inOutSelfSpec
[protected, virtual, inherited]
 

Add a specifier to ourselves.

Parameters:
inContainerSpec A specifier to our container.
inOutSelfSpec The object we return the information in.
Exceptions:
none 
Returns:
void

Reimplemented from CP_ScriptableObject_Imp.

void CP_Window_Imp::DoAE_Close const AppleEvent &  inEvent,
AppleEvent &  inOutReply
[protected, virtual, inherited]
 

Reimplemented from CP_ScriptableObject_Imp.

void CP_Window_Imp::CreatePlatformImp const CP_Point inUpperLeft,
const CP_Size inContentSize,
const CP_String inWindowTitle,
const CP_WindowTypeBase inWindowType
[protected, inherited]
 

Create the MacOS Carbon window.

Parameters:
inUpperLeft Upper left corner of the window.
inContentSize Content size of the window.
inWindowTitle Title of the window.
inWindowType CP_WindowType object that describes the properties and class of this window.
Exceptions:
none 
Returns:
void

void CP_Window_Imp::HandleBoundsChangedEvent CP_Event_Base inEvent  )  [protected, inherited]
 

Called when the bounds of this window is changed.

Parameters:
inEvent CP_Event_Base descripting the bounds changed event.
Exceptions:
none 
Returns:
void

void CP_Window_Imp::HandleDrawContentEvent CP_Event_Base inEvent  )  [protected, virtual, inherited]
 

Called when the content area of the window needs to be updated.

Parameters:
inEvent CP_Event_Base descripting the control draw event.
Exceptions:
none 
Returns:
void

CP_UseDepreciated_10_4_APIs

void CP_Window_Imp::HandleCloseEvent CP_Event_Base inEvent  )  [protected, inherited]
 

Called when the receives a close event.

Parameters:
inEvent CP_Event_Base descripting the window close event.
Exceptions:
none 
Returns:
void

void CP_Window_Imp::HandleClosedEvent CP_Event_Base inEvent  )  [protected, inherited]
 

Called when the receives a closed event.

Parameters:
inEvent CP_Event_Base descripting the window closed event.
Exceptions:
none 
Returns:
void

void CP_Window_Imp::OnClose  )  [protected, virtual, inherited]
 

Called when someone or some action wants to close this window. This will also cause this window object to be deleted.

Exceptions:
none 
Returns:
void

Reimplemented in CP_DocumentWindow.

void CP_Window_Imp::HandleActivatedEvent CP_Event_Base inEvent  )  [protected, inherited]
 

Called when the window receives an activated event.

Parameters:
inEvent CP_Event_Base descripting the window activation event.
Exceptions:
none 
Returns:
void

void CP_Window_Imp::HandleDeactivatedEvent CP_Event_Base inEvent  )  [protected, inherited]
 

Called when the window receives an deactivated event.

Parameters:
inEvent CP_Event_Base descripting the window deactivation event.
Exceptions:
none 
Returns:
void

void CP_Window_Imp::HandleMinSizeEvent CP_Event_Base inEvent  )  [protected, inherited]
 

Called when the window receives an kEventWindowGetMinimumSize event.

Parameters:
inEvent CP_Event_Base descripting the window kEventWindowGetMinimumSize event.
Exceptions:
none 
Returns:
void

void CP_Window_Imp::HandleMaxSizeEvent CP_Event_Base inEvent  )  [protected, inherited]
 

Called when the window receives an kEventWindowGetMaximumSize event.

Parameters:
inEvent CP_Event_Base descripting the window kEventWindowGetMaximumSize event.
Exceptions:
none 
Returns:
void

void CP_Window_Imp::HandleDragCompletedEvent CP_Event_Base inEvent  )  [protected, inherited]
 

Called when the window receives an kEventWindowDragCompleted event. We use the opportunity to record the new positionof the window via AppleEvent recording.

Parameters:
inEvent CP_Event_Base descripting the window kEventWindowDragCompleted event.
Exceptions:
none 
Returns:
void

void CP_Window_Imp::CommandUpdateStatus CP_Event_Base inEvent  )  [protected, virtual, inherited]
 

Called when the window target needs to update information about commands, usually called when the user is opening a menu that contains some items that the window has registered with the Carbon Event handler.

This will call the CP_M_CommandHandler with the information about the command being updated to do the actual processing.

Parameters:
inEvent CP_Event_Base event that contains the information about the event being handled.
Exceptions:
none 
Returns:
void

void CP_Window_Imp::CommandProcess CP_Event_Base inEvent  )  [protected, virtual, inherited]
 

Called when the winodw target needs to handle a command.

This will call the CP_M_CommandHandler with the information about the command being updated to do the actual handling of the command.

Parameters:
inEvent CP_Event_Base event that contains the information about the event being handled.
Exceptions:
none 
Returns:
void

void CP_Window_Imp::SetImpPlatformWindow OSWindow  inWindow  )  [protected, inherited]
 

Sets the MacOS WindowRef that this window object is using for its platform window.

Parameters:
inWindow The OS window to use.
Exceptions:
none 
Returns:
void

void CP_Window_Imp::SetPortBounds const CP_Rect inBounds  )  [protected, virtual, inherited]
 

Sets the bounds of this window.

Parameters:
inBounds The bounds of the window.
Exceptions:
none 
Returns:
void

Reimplemented from CP_View_Imp.

void CP_View::Activate  )  [virtual, inherited]
 

Activate this view.

Exceptions:
none 
Returns:
void

Reimplemented from CP_View_Imp.

Reimplemented in CP_QT_MovieView, and CP_TextView.

void CP_View::Deactivate  )  [virtual, inherited]
 

Deactivate this view.

Exceptions:
none 
Returns:
void

Reimplemented from CP_View_Imp.

Reimplemented in CP_QT_MovieView, and CP_TextView.

void CP_View::Enable  )  [virtual, inherited]
 

Enable this view.

Exceptions:
none 
Returns:
void

Reimplemented from CP_View_Imp.

Reimplemented in CP_QT_MovieView.

void CP_View::Disable  )  [virtual, inherited]
 

Disable this view.

Exceptions:
none 
Returns:
void

Reimplemented from CP_View_Imp.

Reimplemented in CP_QT_MovieView.

bool CP_View::IsFocused  )  [inherited]
 

void CP_View::SetFocused bool  inFocused  )  [inherited]
 

bool CP_View::CanLoseFocus  )  [virtual, inherited]
 

bool CP_View::FocusCanChange  )  [inherited]
 

void CP_View::LosingFocus  )  [inherited]
 

void CP_View::HandleActivationEvent  )  [inherited]
 

void CP_View::HandleDeactivationEvent  )  [inherited]
 

void CP_View::HandleBoundsChanged const CP_Rect inPreviousBounds,
const CP_Rect inNewBounds
[virtual, inherited]
 

Called when the bounds of this view has changed.

Parameters:
inPreviousBounds The previous bounds of this view.
inNewBounds The new bounds to make this view.
Exceptions:
none 
Returns:
void

Reimplemented from CP_View_Imp.

Reimplemented in CP_Scroller, and CP_Splitter.

OSControl CP_View::GetOSControl  )  [inherited]
 

Returns the underlying platforms OSControl that implements this view. This is a convenience function for GetViewImpBase()->GetOSControl().

Exceptions:
none 
Returns:
OSControl The underlying platforms OSControl that implements this view. NULL is returned if the view imp base object is not created yet, or the control hasn't been created yet.

Reimplemented in CP_PlatformControl.

void CP_View::SetHelp const CP_String inHelpString,
const CP_String inSecondaryHelpString
[virtual, inherited]
 

Sets the help string displayed for this view.

Parameters:
inHelpString The help string to be displayed.
inSecondaryHelpString A secondary help string if the underlying OS supports display of alternate strings.
Exceptions:
none 
Returns:
void

void CP_View::SetHelp SInt16  inHelpStringResID,
SInt16  inHelpStringIndex,
SInt16  inSecondaryHelpStringResID = 0,
SInt16  inSecondaryHelpStringIndex = 0
[virtual, inherited]
 

Sets the help string displayed for this view.

Parameters:
inHelpStringResID The help string resource id.
inHelpStringIndex The help string index of the resource.
inSecondarHelpStringResID The secondary help string resource id.
inSecondarHelpStringIndex The secondary help string index of the resource.
Exceptions:
none 
Returns:
void

void CP_View::Move const CP_Point inDistance  )  [virtual, inherited]
 

Moves the view by the distance specified in the passed in point parameter. All subviews of this view will also move along with the view.

Parameters:
inDistance Distance to move this view by.
Exceptions:
none 
Returns:
void

virtual void CP_View::OnBeginPrinting CP_Printer  )  [virtual, inherited]
 

void CP_View::OnPrint CP_Canvas inCanvas,
UInt32  inPageNumber,
CP_Printer_PageFormat  pageFormat
[virtual, inherited]
 

Called when the user wants to print the contents of this view. The default is to call the OnDraw method of the view to use the same drawing for both printing and user interface. Override if you want to handle drawing differently when printing.

Parameters:
inCanvas The printing port to draw into.
inPageNumber The page number being printed.
inPageFormat Object that describes the format of the page that is printing.
Exceptions:
none 
Returns:
CP_Rect The bounds of this view when printing.

virtual void CP_View::OnEndPrinting CP_Printer  )  [virtual, inherited]
 

void CP_View::CountTiles CP_Printer inPrinter,
CP_Printer_PageFormat pageFormat,
UInt16 *  inOutHorTiles,
UInt16 *  inOutVerTiles
[virtual, inherited]
 

Count and return the number of tiles needed to print this view.

NOTE: In order to print a pane/view that is larger than the printed page, we divide our view up into tiles that our the size of each page. Subclasses need to override this if they are larger than the page size. This default is to return 1 for each of the horizontal and vertical tiles.

Parameters:
inPrinter The CP_Printer that is controlling the printing.
inPageFormat Describes the size of the page being printed.
inOutHorTiles The number of horizontal tiles is returned here.
inOutVerTiles The number of vertical tiles is returned here.
Exceptions:
none 
Returns:
void

CP_Point CP_View::GetPrintLocation  )  [inherited]
 

CP_Size CP_View::GetPrintSize  )  [inherited]
 

CP_Rect CP_View::GetLocalPrintBounds  )  [inherited]
 

Returns the bounds of this view in local coordinates when printing. The user can change the bounds of the view when printing by calling SetPrintLocation, SetPrintSize which can be different than used to draw into a window.

Exceptions:
none 
Returns:
CP_Rect The bounds of this view when printing.

void CP_View::SetPrintLocation const CP_Point inLocation  )  [inherited]
 

void CP_View::SetPrintSize const CP_Size inSize  )  [inherited]
 

void CP_View::AddSubview CP_View inView  )  [virtual, inherited]
 

Adds the passed in view to our list of views.

Parameters:
inView The view being added.
Exceptions:
none 
Returns:
void

Reimplemented from CP_View_Imp.

bool CP_View::IsActive  )  const [virtual, inherited]
 

Returns true if this view is active.

Exceptions:
none 
Returns:
bool const Returns true if the view is active.

Reimplemented from CP_View_Imp.

bool CP_View::IsEnabled  )  const [virtual, inherited]
 

Returns true if this view is enhabled.

Exceptions:
none 
Returns:
bool const Returns true if the view is enabled.

Reimplemented from CP_View_Imp.

bool CP_View::IsContainer  )  const [inherited]
 

void CP_View::InitFromOSControl CP_View inSuperview,
OSControl  inOSControl
[inherited]
 

Initializes this view from a superview and an existing platform OSControl.

Parameters:
inSuperview The view that will contain this view.
inOSControl The OSControl that is implementing this view.
Exceptions:
none 
Returns:
void

void CP_View::SetForeBackColors  )  [virtual, inherited]
 

Called when the view needs to setup its foreground and background colors for drawing. This is called during drawing when the OS needs to setup the correct colors for the AppearanceManager. Normally you don't need to call this yourself.

Exceptions:
none 
Returns:
void

Reimplemented in CP_BackgroundView, and CP_TabView.

void CP_View::OnLosingFocus  )  [protected, virtual, inherited]
 

Reimplemented in CP_TextView.

void CP_View::OnFinishPersist  )  [protected, virtual, inherited]
 

This is called after the containing window and all of its subviews have been created. This gives each view a chance to perform any needed operations after the window and subviews have been created, but before the window is made visible to the user.

Exceptions:
none 
Returns:
void

Reimplemented from CP_M_Persist.

Reimplemented in CP_TabView.

virtual void CP_View::FinishInitFromOSControl OSControl   )  [protected, virtual, inherited]
 

void CP_View_Imp::GlobalToLocal CP_Point inGlobalPoint  )  [virtual, inherited]
 

Converts the passed in point from global to local coordinates.

Parameters:
inGlobalPoint The point to convert to local coordinates.
Exceptions:
none 
Returns:
void

void CP_View_Imp::PortToLocal CP_Point inPortPoint  )  [inherited]
 

Converts the passed in point from port to local coordinates.

Parameters:
inGlobalPoint The point to convert to port coordinates.
Exceptions:
none 
Returns:
void

void CP_View_Imp::LocalToPort CP_Point inPortPoint  )  [inherited]
 

void CP_View_Imp::LocalToPort CP_Rect inPortRect  )  [inherited]
 

virtual void CP_View_Imp::HandleDragReceive CP_DragDrop  )  [virtual, inherited]
 

Reimplemented from CP_M_DragTarget.

CP_EventHandler & CP_View_Imp::GetEventHandler  )  [virtual, inherited]
 

Return the event handler for this view implementation. This will be the OS implentation event handler.

Exceptions:
none 
Returns:
CP_EventHandler The OS implementations event handler.

CP_View * CP_View_Imp::GetSuperview  )  [inherited]
 

Return the superview of this view.

Exceptions:
none 
Returns:
CP_View * Return the superview of this view.

UInt32 CP_View_Imp::GetCommandID  )  [inherited]
 

CP_Canvas CP_View_Imp::SetupForDrawing  )  [virtual, inherited]
 

Used when the user needs to draw into a view at times other than the normal drawing times. This will setup the view for drawing into, and return a canvas object suitable for use.

Exceptions:
none 
Returns:
CP_Canvas CP_Canvas object to use to draw into.

Reimplemented in CP_QT_MovieView.

void CP_View_Imp::FinishDrawing CP_Canvas drawCanvas  )  [inherited]
 

Call after the drawing is complete to free up system resources.

Exceptions:
none 
Returns:
CP_Canvas CP_Canvas object to use to draw into.

void CP_View_Imp::HandleDraw CP_Canvas inCanvas,
CP_Region inUpdateArea
[inherited]
 

CP_View_Imp method called from the user panes callback. This calls the virtual OnDraw function which users override to do the actual drawing in their panes.

Parameters:
inCanvas CP_Canvas object to draw into.
inUpdateArea CP_Region containing the area to draw.
Exceptions:
none 
Returns:
void

void CP_View_Imp::Invalidate const CP_Region inInvalidArea  )  [inherited]
 

Cause the passed in area of this pane to become invalid and force the OS to create an update event to redraw that portion.

Parameters:
inRegion CP_Region that contains the invalid area. Region should be in local coordinates.
Exceptions:
none 
Returns:
void

void CP_View_Imp::Invalidate const CP_Rect inInvalidArea  )  [inherited]
 

Cause the passed in area of this pane to become invalid and force the OS to create an update event to redraw that portion.

Parameters:
inRect CP_Rect that contains the invalid area. Rect should be in local coordinates.
Exceptions:
none 
Returns:
void

ControlPartCode CP_View_Imp::HandleHitTest const CP_Point inMouseLocation  )  [virtual, inherited]
 

MacOS - Returns the part code that the passed in point is over. The default implementation returns kControlIndicatorPart.

Parameters:
innMouseLocation The location of the mouse we are checking.
Exceptions:
none 
Returns:
ControlPartCode MacOS control part code under the passed in mouse.

Reimplemented in CP_SelectColorButton, CP_Splitter, and CP_TableView.

ControlPartCode CP_View_Imp::HandleTracking const CP_Point inMouseLocation,
ControlActionUPP  actionProc
[virtual, inherited]
 

MacOS - Called when the user is holding the mouse down, and moving it in this view. This will track the mouse until the user has released the mouse button. The last part the mouse was over when the user has released the mouse button is returned.

Parameters:
innMouseLocation The location of the mouse we are checking.
inActionProc Not used.
Exceptions:
none 
Returns:
ControlPartCode MacOS control part code under the mouse when the user released the mouse button.

Reimplemented in CP_SelectColorButton, CP_Splitter, CP_TableView, and CP_TV_DataBrowser.

ControlPartCode CP_View_Imp::HandleFocus ControlFocusPart  inFocusPart  )  [virtual, inherited]
 

MacOS - Called when some action is causing this view to become focused. This default implementation returnns kControlNoPart.

Parameters:
inAction Not used.
Exceptions:
none 
Returns:
ControlPartCode MacOS control part code receiving the focus.

Reimplemented in CP_TableView.

void CP_View_Imp::HandleActivate Boolean  inActivating  )  [virtual, inherited]
 

void CP_View_Imp::HandleKeyDown SInt16  keyCode,
SInt16  charCode,
SInt16  modifiers
[virtual, inherited]
 

Reimplemented in CP_TableView.

UInt32 CP_View_Imp::GetFlags  )  [inherited]
 

void CP_View_Imp::SetFlags UInt32  inFlags  )  [inherited]
 

void CP_View_Imp::SetFrameAdapter CP_FrameAdapter inAdapter  )  [inherited]
 

Sets the frame adapter for this view. The frame adapter determines how a view will resize and reposition itself when the superview that contains it changes bounds.

Parameters:
inAdapter The frame adapter for this view.
Exceptions:
none 
Returns:
void

virtual void CP_View_Imp::HandleMouseMoved CP_Event_Base ,
const CP_Point
[virtual, inherited]
 

virtual void CP_View_Imp::HandleMouseEntered CP_Event_Base  )  [virtual, inherited]
 

virtual void CP_View_Imp::HandleMouseExited CP_Event_Base  )  [virtual, inherited]
 

void CP_View_Imp::SetCommandID UInt32  inCommandID  )  [inherited]
 

Sets the command id associated with this view. This will be the command sent out when the control is clicked on.

Parameters:
inCommandID The command to be sent when clicked on.
Exceptions:
none 
Returns:
void

void CP_View_Imp::Show_Slot CP_DataValueHolder inValue,
OSStatus inOutStatus
[inherited]
 

void CP_View_Imp::Hide_Slot CP_DataValueHolder inValue,
OSStatus inOutStatus
[inherited]
 

void CP_View_Imp::Activate_Slot CP_DataValueHolder inValue,
OSStatus inOutStatus
[inherited]
 

void CP_View_Imp::Deactivate_Slot CP_DataValueHolder inValue,
OSStatus inOutStatus
[inherited]
 

void CP_View_Imp::Enable_Slot CP_DataValueHolder inValue,
OSStatus inOutStatus
[inherited]
 

void CP_View_Imp::Disable_Slot CP_DataValueHolder inValue,
OSStatus inOutStatus
[inherited]
 

void CP_View_Imp::AdjustToSuperview CP_View inView  )  [inherited]
 

void CP_View_Imp::SetViewImpBase CP_View_Imp_Base inViewImpBase  )  [inherited]
 

CP_View_Imp_Base* CP_View_Imp::GetViewImpBase  )  [inherited]
 

bool CP_View_Imp::ContainsPoint const CP_Point inPortPoint  )  [inherited]
 

Tests this view to see if it contains the passed in point, which is in port coordinates.

Parameters:
inPortPoint Point to check in port coordinates.
Exceptions:
none 
Returns:
bool Returns true if the passed in port point is contained in this view.

CP_ViewBackground * CP_View_Imp::GetViewBackground  )  [inherited]
 

void CP_View_Imp::SetViewBackground CP_ViewBackground inViewBackground  )  [inherited]
 

void CP_View_Imp::CreateImp CP_View inSuperview,
const CP_Point inUpperLeft,
const CP_Size inContentSize,
bool  inCreateImp = false
[protected, virtual, inherited]
 

Creates the MacOS user pane control that performs all drawing and other interaction between this class and the MacOS ControlManager

Parameters:
inSuperview The subview handler that contains this pane.
inLocation Upper left corner of pane in releation to its superview.
inSize Content size of the pane.
inCreateImp Flag to indicate if the user pane control should be created for this pane. This flag would be true if this is a custom pane and not one of the system controls.
Exceptions:
OSStatusException CP_paramErr if superview is NULL
Returns:
void

WindowRef CP_View_Imp::GetDragWindow  )  [protected, virtual, inherited]
 

MacOS - Returns the WindowRef of our containing window when the user has dragged an object over it.

Exceptions:
none 
Returns:
WindowRef The MacOS WindowRef for the containing window.

CP_Region CP_View_Imp::GetDropRegion  )  [protected, virtual, inherited]
 

MacOS - Returns the region of our target view that can accept the object that is currently over this view. The default implementation returns the the entire view bounds. Users can override if they want to only have a portion of the view act as a drop area.

Exceptions:
none 
Returns:
CP_Region The area of the view that can accept the dropped item.

Implements CP_M_DragTarget.

virtual bool CP_View_Imp::PtInDropArea CPLAT::CP_Point &  inGlobalPoint  )  [protected, virtual, inherited]
 

bool CP_M_DragTarget::PtInDropArea CP_Point inGlobalPoint  )  [protected, virtual, inherited]
 

Returns true if the passed in global point is over this drag target.

Parameters:
inGlobalPoint The location of the mouse in global coordinates to test against. The default implmentation gets the drop region for the target, and compares the location to the drop region.
Exceptions:
none 
Returns:
bool Returns true if the passed in point is over the drop region for this drag target.

void CP_View_Imp::OnDraw CP_Canvas inCanvas,
CP_Region inUpdateArea
[protected, virtual, inherited]
 

Virtual method that users use to handle the actual drawing of their panes data. All platform implemntations eventually call this method to perform the actual drawing, and this is the only place that drawing should occur in.

You can also assume that by the time this method is called, the clipping region and other necessary platform stuff has been setup for you to draw. The passed in canvas also contains a valid port for drawing into.

Parameters:
inCanvas CP_Canvas object to draw into.
inUpdateArea CP_Region containing the area to draw.
Exceptions:
none 
Returns:
void

Reimplemented in CP_BackgroundView, CP_DisclosureButton, CP_FocusBorder, CP_OpenGLView, CP_QT_MovieView, CP_Relevance, CP_RoundButton, CP_Scroller, CP_SearchField, CP_SegmentView, CP_SelectColorButton, CP_Splitter, CP_TableHeaders, CP_TableView, CP_TV_DataBrowser, CP_TV_TextColumn, and CP_WindowListHeader.

virtual bool CP_View_Imp::OnCanAcceptDrag UInt32  inItem,
CPLAT::CP_DragDrop &  inDragDrop
[protected, virtual, inherited]
 

virtual bool CP_M_DragTarget::OnCanAcceptDrag UInt32  inItem,
CP_DragDrop inDragDrop
[protected, pure virtual, inherited]
 

void CP_View_Imp::OnBoundsChanged const CP_Rect inPreviousBounds,
const CP_Rect inNewBounds
[protected, virtual, inherited]
 

Called when the bounds of this view has changed.

Parameters:
inPreviousBounds The previous bounds of this view.
inNewBounds The new bounds to make this view.
Exceptions:
none 
Returns:
void

Reimplemented in CP_OpenGLView, and CP_QT_MovieView.

void CP_M_Persist::InitPersist CP_View inSuperview,
CP_DataValueList inDataValueList
[inherited]
 

Finish initializing our object. Calls OnInitPersist to do the actual work.

Parameters:
inSuperview The CP_View that contains this object.
inDataValueList List of data values used to construct this object.
Exceptions:
none 
Returns:
void

void CP_M_Persist::FinishPersist  )  [inherited]
 

Called when we have constructed our persist objects and are now giving each one a chance to finish up. Calls OnFinishPersist to do the actual work.

Exceptions:
none 
Returns:
void

void CP_Object::SetID FourCharCode  inIdentifier  )  [inherited]
 

Sets the identifier for this object. If a specific identifier is not set with this function, then a default id is used, which is simply a running count of the number of objects created.

Parameters:
inIdentifier The objects identifier.
Returns:
void

FourCharCode CP_Object::GetID  )  [inherited]
 

Returns the objects identifier.

Returns:
FourCharCode The identifier of this object.

void CP_Object::RegisterSignal const CP_SignalHolder inSignal  )  [inherited]
 

Registers the signal / signal name contained in the passed in inSignal object.

Parameters:
inSignal CP_SignalHolder that holds a signal and string identifier.
Returns:
void

CP_DataValueSignal * CP_Object::FindSignal const CP_String inSignalName  )  [inherited]
 

Finds the CP_DataValueSignal object that matches the passed in inSignalName.

Parameters:
inSignalName CP_String containing the identifier of the signal to return.
Returns:
CP_DataValueSignal * Returns a pointer to a CP_DataValueSignal object.

UInt32 CP_Object::GetNumberSignals  )  [inherited]
 

Returns the number of signals for this object.

Returns:
UInt32 The number of signals.

CP_String CP_Object::GetNthSignalName UInt32  inSignalIndex  )  [inherited]
 

Returns the signal name of the passed in signal index.

Parameters:
inSignalIndex Index of the name of the signal to return.
Returns:
CP_String The name of the nth signal being returned.

void CP_Object::RegisterSlot const CP_SlotHolder inSlot  )  [inherited]
 

Registers the slot / slot name contained in the passed in inSlot object.

Parameters:
inSlot CP_SignalHolder that holds a slot and string identifier.
Returns:
void

CP_DataValueSlot CP_Object::FindSlot const CP_String inSlotName  )  [inherited]
 

Finds the CP_Slot1 object that matches the passed in inSlotName.

Parameters:
inSlotName CP_String containing the identifier of the slot to return.
Returns:
CP_DataValueSlot Returns a pointer to a CP_DataValueSlot object.

UInt32 CP_Object::GetNumberSlots  )  [inherited]
 

Returns the number of slots for this object.

Returns:
UInt32 The number of slots.

CP_String CP_Object::GetNthSlotName UInt32  inSlotIndex  )  [inherited]
 

Returns the slot name of the passed in signal index.

Parameters:
inSlotIndex Index of the name of the slot to return.
Returns:
CP_String The name of the nth slot being returned.

template<class R, class P1, class P2>
CP_CommandHandlerSignal* CP_Object::Connect CPLAT::CP_CommandNo  cmd,
void(R::*)(P1, P2)  handler,
SInt32  mode
[inherited]
 

template<class R, class P1, class P2>
void CP_Object::Connect CP_Object control,
const CPLAT::CP_String &  signalName,
void(R::*)(P1, P2)  handler
[inherited]
 

void CP_Object::Connect CP_Object sender,
const CP_String signalName,
CP_Object receiver,
const CP_String slotName,
const bool  reciprocal = false
[static, inherited]
 

void CP_Object::Connect CP_Object sender,
CP_Object receiver,
const bool  reciprocal = false,
const CP_String signalName = kCP_Signal_ValueChanged,
const CP_String slotName = kCP_Slot_SetValue
[static, inherited]
 

bool CP_M_CommandHandler::UpdateCommandStatus CP_CommandNo  inOSCommand,
CP_CommandStatus inOutCommandStatus
[inherited]
 

Updates the status of a command.

Parameters:
inOSCommand The CP_CommandNo assigned to the command.
inOutCommandStatus CP_CommandStatus object that holds the result of the update for the command.
Exceptions:
none 
Returns:
bool True if the command was handled.

bool CP_M_CommandHandler::UpdateCommandStatusForAppState CP_CommandNo  inOSCommand,
CP_CommandStatus inOutCommandStatus,
CP_Command inCommand
[virtual, inherited]
 

Updates the status of a command based on the current state of the application.

Parameters:
inOSCommand The CP_CommandNo assigned to the command.
inOutCommandStatus CP_CommandStatus object that holds the result of the update for the command.
inCommand CP_Command object with the command.
Exceptions:
none 
Returns:
bool True if the command was handled.

OSStatus CP_M_CommandHandler::HandleCommand CP_CommandNo  inOSCommand  )  [inherited]
 

Handles the processing of a command. If the command has been registered with this class, then its signal will be called.

If the command has not been registered, then this function does nothing with the passed in command.

Parameters:
inOSCommand The CP_CommandNo assigned to the command.
Exceptions:
NULL exceptions.
Returns:
OSStatus Result of the command handling.

OSStatus CP_M_CommandHandler::HandleCommand HICommand  inCommand,
CP_Menu inMenu = NULL
[inherited]
 

Signal called when a menu item is selected with no associated command.

CP_MenuSelectionSignal* CP_M_CommandHandler::GetMenuSelectionSignal  )  [inherited]
 

Returns the signal called when a menu item is selected and has no command associated with it.

Exceptions:
none 
Returns:
CP_MenuSelectionSignal * Returns the menu selection signal.

void CP_M_CommandHandler::RegisterCommand CP_CommandNo  inOSCommand,
CP_CommandHandlerSignal inCommandHandler,
CP_CommandStatusSignal inCommandStatus
[inherited]
 

Registers the passed in command. This places the command in a list of commands we will handle updating the status for, and when called executing the signal registered for the command.

Parameters:
inOSCommand The CP_CommandNo assigned to the command.
inCommandHandler The CP_CommandHandlerSignal called when the command is called to be executed. Note: This signal will be deleted when the command is removed from the list of commands, and should be unique for each command, ie don't assign the same signal to the same command.
inCommandStatus The CP_CommandStatusSignal called when the commands status needs to be updated. Note: This signal will be deleted when the command is removed from the list of commands, and should be unique for each command, ie don't assign the same signal to the same command.
Exceptions:
none 
Returns:
void

void CP_M_CommandHandler::RegisterCommand CP_CommandNo  inOSCommand,
CP_CommandHandlerSignal inCommandHandler,
SInt32  inFlags
[inherited]
 

Registers the passed in command. This places the command in a list of commands we will handle updating the status for, and when called executing the signal registered for the command.

Parameters:
inOSCommand The CP_CommandNo assigned to the command.
inCommandHandler The CP_CommandHandlerSignal called when the command is called to be executed. Note: This signal will be deleted when the command is removed from the list of commands, and should be unique for each command, ie don't assign the same signal to the same command.
inFlags Flags used to update the status of the command instead of calling a signal to do the updating.
Exceptions:
none 
Returns:
void

CP_CommandHandlerSignal * CP_M_CommandHandler::RegisterCommand CP_CommandNo  inOSCommand,
SInt32  inFlags
[inherited]
 

Registers the passed in command. This places the command in a list of commands we will handle updating the status for. You are returned the signal object that you need to connect your slot to.

Parameters:
inOSCommand The CP_CommandNo assigned to the command.
inFlags Flags used to update the status of the command instead of calling a signal to do the updating.
Exceptions:
none 
Returns:
CP_CommandHandlerSignal The command handler signal that will be called when the command is executed. You need to connect your slot to this signal.

CP_CommandStatusSignal * CP_M_CommandHandler::RegisterUpdateStatusHandler CP_CommandNo  inOSCommand  )  [inherited]
 

Registers the passed in command, returning the command status signal. If the command already exists, we will return the existing command status signal if there is one, otherwise we create a new signal, and return that signal. If there is already a signal, then return the existing signal.

Parameters:
inOSCommand The CP_CommandNo assigned to the command.
Exceptions:
none 
Returns:
CP_CommandStatusSignal The command status signal that will be called when the command is executed. You need to connect your slot to this signal.

CP_CommandHandlerSignal * CP_M_CommandHandler::RegisterCommandHandler CP_CommandNo  inOSCommand  )  [inherited]
 

Registers the passed in command, returning the command handling signal. If the command already exists, we will return the existing command handler signal if there is one, otherwise we create a new signal, and return that signal. If there is already a signal, then return the existing signal.

Parameters:
inOSCommand The CP_CommandNo assigned to the command.
Exceptions:
none 
Returns:
CP_CommandHandlerSignal The command handler signal that will be called when the command is executed. You need to connect your slot to this signal.

bool CP_M_CommandHandler::IsRegisteredCommand CP_CommandNo  inOSCommand  )  const [inherited]
 

Returns true if the passed in command is known to this class.

Parameters:
inOSCommand The CP_CommandNo assigned to the command.
Exceptions:
none 
Returns:
bool const Returns true if we have previously registered the passed in command.

void CP_M_CommandHandler::ReplaceCommand CP_CommandNo  inOSCommand,
CP_Command inCommand
[inherited]
 

Replaces a CP_Command for the passed in command number.

Parameters:
inOSCommand The CP_CommandNo assigned to the command.
inCommand The CP_Command to replace with.
Exceptions:
none 
Returns:
void

void CP_M_CommandHandler::UnRegisterCommand CP_CommandNo  inOSCommand  )  [inherited]
 

Unregisters a command.

Parameters:
inOSCommand The CP_CommandNo to remove from the list of known commands we handle.
Exceptions:
none 
Returns:
void

CP_Command * CP_M_CommandHandler::GetCommand CP_CommandNo  inOSCommand  )  [inherited]
 

Returns the CP_Command object associated with the passed in command number.

Parameters:
inOSCommand The CP_CommandNo assigned to the command.
Exceptions:
none 
Returns:
CP_Command * CP_Command object associated with the passed in command number. Note: This will return a NULL CP_Command if the command has not been registered yet.

OSStatus CP_M_CommandHandler::HandleCommandUpdateStatus HICommand  inCommand,
CP_Menu inMenu = NULL
[inherited]
 

MacOS - Handles the processing of the passed in HICommand. This will translate the HICommand into a CPLAT CP_CommandNo for processing and updating the status of the command.

Parameters:
inCommand The HICommand to be handled.
Exceptions:
OSError exceptions.
Returns:
OSStatus Result of the command handling.

OSStatus CP_M_CommandHandler::UpdateCommandStatusOS CP_CommandStatus  inCommandStatus,
bool  inResult,
HICommand  inCommand
[inherited]
 

void CP_SigSlot::CP_SlotObject::disconnect_all  )  [inherited]
 

void CP_SigSlot::CP_SlotObject::signal_connect CP_Signal inSender  )  [inherited]
 

void CP_SigSlot::CP_SlotObject::signal_disconnect CP_Signal inSender  )  [inherited]
 

void CP_M_DragSource::AddFlavor CP_DragDrop inDragDrop,
FlavorType  inFlavor,
const void *  inData,
SInt32  inSize,
UInt32  inFlags = 0,
UInt32  inItem = 0
[protected, virtual, inherited]
 

Tracks the drag by calling on the OS to handle the drag.

Parameters:
inDragDrop The CP_DragDrop object performing the drag and drop operation.
FlavorType Type of data being added.
inData Data being added.
inSize Size of the data being added.
inFlags Flags describing the flavor.
inItem Item reference number.
Exceptions:
none 
Returns:
void

void CP_M_DragSource::TrackDrag CP_DragDrop inDragDrop,
CP_Event_Base inEvent
[protected, virtual, inherited]
 

Tracks the drag by calling on the OS to handle the drag.

Parameters:
inDragDrop The CP_DragDrop object performing the drag and drop operation.
inEvent Originating mouse event that initiated this drag and drop.
Exceptions:
none 
Returns:
void

bool CP_M_DragTarget::CanAcceptDrag CP_DragDrop inDragDrop  )  [inherited]
 

Called when the user tries to drop an object on this drag target. For each item inn the drag and drop, OnAcceptDrag will be called, which is the method you should override to determine if the object can be dropped onto this target.

If any of the items are not accepted by the object, then false is returned.

Parameters:
inDragDrop The CP_DragDrop object that is performing the drag and drop.
Exceptions:
none 
Returns:
bool Returns true if all of the items in the drag are acceptable.

void CP_M_DragTarget::HiliteDropArea CP_DragDrop inDragDrop  )  [virtual, inherited]
 

Called when the drag enters a new drop area. This is used to show the MacOS default drag hiliting.

Parameters:
inDragDrop The CP_DragDrop object that is performing the drag and drop.
Exceptions:
none 
Returns:
void

void CP_M_DragTarget::UnhiliteDropArea CP_DragDrop inDragDrop  )  [virtual, inherited]
 

Called when the drag leaves a drop area. This is used to remove the MacOS default drag hiliting.

Parameters:
inDragDrop The CP_DragDrop object that is performing the drag and drop.
Exceptions:
none 
Returns:
void

void CP_M_DragTarget::AddDragTarget CP_M_DragTarget inDragTarget,
CP_Window inWindow
[inherited]
 

Adds the passed in CP_M_DragTarget to the global list of drag targets that this object maintains. This is the list of objects that get checked during a drag and drop operation to see if the object can receive the dropped object when the mouse if over the target object.

Parameters:
inDragTarget The object that can be the receipient of a drag and drop operation.
inWindow The window that contains the drag target.
Exceptions:
none 

void CP_M_DragTarget::RemoveDragTarget CP_M_DragTarget inDragTarget,
CP_Window inWindow
[inherited]
 

Removes a previously added CP_M_DragTarget object. This is called for you automatically when aa CP_M_DragTarget object is destroyed. However you can call this at other times, if you want to remove an object as a postential drop target for drag and drops.

Parameters:
inDragTarget The object that is going to be removed.
inWindow The window that contains the drag target.
Exceptions:
none 

pascal::OSErr CP_M_DragTarget::HandleDragTrackingCallback DragTrackingMessage  inMessage,
WindowPtr  inOSWindow,
void *  inRefCon,
DragReference  inDragRef
[static, protected, inherited]
 

Callback to the MacOS Drag Manager that is called during a drag and drop tracking operation.

Parameters:
inMessage The message or reason that this callback was called.
inOSWindow The MacOS window that the drag is ocurring in.
inRefCon Not used.
inDragRef The Drag Manager DragReference for this drag and drop.
Exceptions:
none 
Returns:
OSErr The result of this operation.

pascal OSErr CP_M_DragTarget::HandleDragReceiveCallback WindowPtr  inOSWindow,
void *  inRefCon,
DragReference  inDragRef
[static, protected, inherited]
 

Callback to the MacOS Drag Manager when the user has dropped an object over a drag target.

Parameters:
inOSWindow The MacOS window that the drop occured over.
inRefCon Not used.
inDragRef The Drag Manager DragReference for this drag and drop.
Exceptions:
none 
Returns:
OSErr The result of this operation.

CP_M_DragTarget * CP_M_DragTarget::FindDragTarget OSWindow  inOSWindow,
CP_Point inMouseLocation,
CP_DragDrop inDragDrop
[static, protected, inherited]
 

Finds and returns the CP_M_DragTarget that is in the passed in OSWindow at the passed in mouse location. The mouse location is in global coordinates.

If no target was found at the passed in location, then NULL is returned.

Parameters:
inOSWindow The MacOS window that the mouse is over.
inMouseLocation Global location of the mouse.
inDragDrop The CP_DragDrop object that is performing the drag and drop.
Exceptions:
none 
Returns:
CP_M_DragTarget * The object that was registered to handle a drag and drop at the passed in mouse location. NULL is returned if no target object was found.

void CP_M_DragTarget::OnDragEnter CP_DragDrop inDragDrop,
bool  inDragHasLeftSender
[protected, virtual, inherited]
 

Called when the user has entered a registered drag target object.

Parameters:
inDragDrop The CP_DragDrop object that is performing the drag and drop.
inDragHasLeftSender Flag to indicate if the drag operation has left the sending object, and is now in another object.
Exceptions:
none 
Returns:
void

void CP_M_DragTarget::OnDragLeave CP_DragDrop inDragDrop  )  [protected, virtual, inherited]
 

Called when the user is has left the current drag target object.

Parameters:
inDragDrop The CP_DragDrop object that is performing the drag and drop.
Exceptions:
none 
Returns:
void

void CP_M_DragTarget::OnDragTrack CP_DragDrop inDragDrop  )  [protected, virtual, inherited]
 

Called when the user is tracking or moving the mouse during a drag and drop operationn.

Parameters:
inDragDrop The CP_DragDrop object that is performing the drag and drop.
Exceptions:
none 
Returns:
void

void CP_M_DragTarget::HandleTrackInWindow WindowPtr  inOSWindow,
CP_DragDrop inDragDrop
[static, protected, inherited]
 

Called when the user is dragging an object around in a window. This is called from the MacOS Drag Manager callback.

Parameters:
inOSWindow The MacOS window that the user is dragging an object over.
inDragDrop The CP_DragDrop object that is performing the drag and drop.
Exceptions:
none 
Returns:
void

void CP_M_SubViewHandler::AddSubviewToList CP_View inSubView  )  [inherited]
 

Adds the passed in subView to our list of subViews. If the View is already in the list, it is not added another time.

Parameters:
inSubView The CP_View object being added.
Exceptions:
none 
Returns:
void

void CP_M_SubViewHandler::DeleteSubViews  )  [virtual, inherited]
 

Delete all of our sub Views and the list that tracks them.

Exceptions:
none 
Returns:
void

void CP_M_SubViewHandler::DeleteSubView CP_View inSubView,
bool  inDeleteSubViews = true,
bool  inDeleteSubView = true
[virtual, inherited]
 

Delete one of our subViews.

Parameters:
inSubView The CP_View object to delete.
inDeleteSubViews Flag to indicate if the subView is a view, should it delete its subViews.
inDeleteSubView Flag to indicate if the subView is just removed from our list, or removed and the passed in object then deleted.
Exceptions:
none 
Returns:
void

void CP_M_SubViewHandler::RemoveSubView CP_View inSubView  )  [inherited]
 

Remove the passed in subView from our list of subViews.

Parameters:
inSubView The CP_View to be removed.
Exceptions:
none 
Returns:
void

CP_View * CP_M_SubViewHandler::FindSubView const CP_Point inWhere,
bool  inRecrusive = kCP_NoRecrusiveSearch
[inherited]
 

Find the sub View containing our passed in point. The search beings at the end of the list of subViews. The subView list is in order that the subViews where added to the view, not necessarily by location.

Parameters:
inWhere The location of the subView we are after.
inRecrusive Flag to indicate if we should find the deepest subView containing the point.
Exceptions:
none 
Returns:
void

CP_View * CP_M_SubViewHandler::FindSubView const UInt32  inViewID,
bool  inRecrusive = kCP_NoRecrusiveSearch
[inherited]
 

Find the sub View containing our passed in View id. The search beings at the end of the list of subViews. The subView list is in order that the subViews where added to the view, not necessarily by location. This will return the last subView added with the passed in id in case of multiple subViews with the same id.

Parameters:
inViewID The View ID of the subView we are after.
inRecrusive Flag to indicate if we should find the deepest subView containing the point.
Exceptions:
none 
Returns:
void

bool CP_M_SubViewHandler::ContainsSubView CP_View inView,
bool  inRecrusive
[inherited]
 

Returns true if this subview contains the passed in CP_View object. If the inRecrusive flag is set and the view is not found in the outter view, the search continues in subviews until the match is found, or all views and sub views have been searched.

Parameters:
inView The view we are after.
inRecrusive Flag to indicate if we should find the deepest subView containing the point.
Exceptions:
none 
Returns:
void

void CP_M_SubViewHandler::ShowSubs  )  [protected, virtual, inherited]
 

Show the window.

Exceptions:
none 
Returns:
void

void CP_M_SubViewHandler::HideSubs  )  [protected, virtual, inherited]
 

Hide the window.

Exceptions:
none 
Returns:
void

void CP_ScriptableObject_Imp::HandleAppleEventSelf const AppleEvent &  inEvent,
AppleEvent &  inOutReply,
SInt32  inRefCon
[virtual, inherited]
 

Handle the passed in Apple Event. You should not need to override this. Either call the one of the default handlers for the core events, or to override the default handlers, register an event handler for the event.

Registered event handlers will be handled first, then the built in functions will be called if there is no overriding event handler for the event.

Parameters:
inEvent The AppleEvent being handled.
inOutReply The AppleEvent to place any reply into.
inRefCon The eventID passed from the AppleEvent manager when the event handler was registered.
Exceptions:
OSErrorExceptions 
Returns:
void

Reimplemented in CP_ScriptableObject_Property.

void CP_ScriptableObject_Imp::HandleAppleEvent const AppleEvent &  inEvent,
AppleEvent &  outAEReply,
AEDesc &  outResult,
SInt32  inRefCon
[virtual, inherited]
 

Handles AppleEvents for this object and any sub scriptable objects that this object might contain.

Parameters:
inEvent The AppleEvent being handled.
inOutReply The AppleEvent to place any reply into.
outReply Location to put a reply into.
inRefCon The eventID passed from the AppleEvent manager when the event handler was registered.
Exceptions:
OSErrorExceptions 
Returns:
void

void CP_ScriptableObject_Imp::SetDefaultObject CP_ScriptableObject_Imp inDefaultObject  )  [static, inherited]
 

Set the default object. This is the object that subsequent events will use when they refer to the default object.

Parameters:
inDefaultObject The CP_ScriptableObject_Imp that is to become the default object.
Exceptions:
none 
Returns:
void

static CP_ScriptableObject_Imp* CP_ScriptableObject_Imp::GetDefaultObject  )  [static, inherited]
 

CP_ScriptableObject_Imp * CP_ScriptableObject_Imp::GetScriptableObjectFromToken const AEDesc &  inToken  )  [static, inherited]
 

Gets the scriptable object that an event corresponds to, by extracting our CP_ModelToken from the descriptor.

Parameters:
inToken The AEDesc that contains the token for the scriptable object we are trying to get.
Exceptions:
OSErrorExceptions 
Returns:
void

CP_ScriptableObject_Imp* CP_ScriptableObject_Imp::GetSuperScriptableObject  )  const [inherited]
 

virtual void CP_ScriptableObject_Imp::SetSuperScriptableObject CP_ScriptableObject_Imp inSuperScriptableObject  )  [virtual, inherited]
 

CP_ScriptableObject_Imp* CP_ScriptableObject_Imp::GetDefaultSubScriptableObject  )  const [inherited]
 

void CP_ScriptableObject_Imp::SetDefaultSubScriptableObject CP_ScriptableObject_Imp inObject  )  [inherited]
 

CP_ScriptableObject_Imp* CP_ScriptableObject_Imp::GetDefaultSuperScriptableObject  )  const [inherited]
 

void CP_ScriptableObject_Imp::SetDefaultSuperScriptableObject CP_ScriptableObject_Imp inObject  )  [inherited]
 

bool CP_ScriptableObject_Imp::CompareObjects const DescType  inOperation,
const CP_ScriptableObject_Imp toWhat
[virtual, inherited]
 

Compare Apple Event objects. This method returns false, and subclasses need to override it.

Parameters:
inOperation A DescType describing the type of comparison operation to be performed.
toWhat The CP_ScriptableObject_Imp we are comparing against.
Exceptions:
none 
Returns:
bool The result of the comparison.

SInt32 CP_ScriptableObject_Imp::CountContainedObjects const DescType  inType  )  [virtual, inherited]
 

Return a count of the objects of inType contained in ourselves. This needs to be overriden, this method just returns 0.

Parameters:
inType Not used
Exceptions:
none 
Returns:
SInt32 The number of contained objects.

Reimplemented in CP_Document_Base, and CP_Application_Imp.

void CP_ScriptableObject_Imp::GetContainedObject const DescType  inDesiredClass,
const DescType  inForm,
const AEDesc &  inSelectionData,
AEDesc &  outToken
[virtual, inherited]
 

Return the object contained in the passed in container based upon the inForm criteria.

Parameters:
inDesiredClass A DescType describing the class we are looking for.
inForm a DescType describing the form.
inSelectionData AEDesc with the selection data.
inNeedsDisposal Flag to indicate if we should dispose dispose of objects.
Exceptions:
none 
Returns:
void

CP_ScriptableObject_Imp * CP_ScriptableObject_Imp::GetContainedObjectByName const DescType  inDesiredClass,
const CP_String inName
[virtual, inherited]
 

Return the object contained in ourselves based on the name passed in. Subclasses need to override this function. This routine just returns NULL.

Parameters:
inDesiredClass A DescType for the class we are looking for.
inName The name we are looking for.
Exceptions:
none 
Returns:
CP_ScriptableObject_Imp * The contained object.

Reimplemented in CP_Document_Base, and CP_Application_Imp.

CP_ScriptableObject_Imp * CP_ScriptableObject_Imp::GetContainedObjectByPosition DescType  inDesiredClass,
SInt32  inPosition
[virtual, inherited]
 

Return the object contained in ourselves based on the position passed in. Subclasses need to override this function. This routine just returns NULL.

Parameters:
inDesiredClass A DescType for the class we are looking for.
inPosition The position of the object we are looking for.
Exceptions:
none 
Returns:
CP_ScriptableObject_Imp * The contained object.

Reimplemented in CP_Document_Base, and CP_Application_Imp.

CP_ScriptableObject_Imp * CP_ScriptableObject_Imp::GetContainedObjectByUniqueID DescType  inDesiredClass,
SInt32  inID
[virtual, inherited]
 

Return the object contained in ourselves based on the unique ID passed in. Subclasses need to override this function. This routine just returns NULL.

Parameters:
inDesiredClass A DescType for the class we are looking for.
inUniqueID The unique id to identify the object.
Exceptions:
none 
Returns:
CP_ScriptableObject_Imp * The contained object.

CP_ScriptableObject_Imp * CP_ScriptableObject_Imp::GetContainedObjectByRelativePosition DescType  inDesiredClass,
SInt32  inPosition
[virtual, inherited]
 

Return the object contained in ourselves based on the position passed in. Subclasses need to override this function. This routine just returns NULL.

Parameters:
inDesiredClass A DescType for the class we are looking for.
inRelativePosition The relative position of the object we are looking for.
Exceptions:
none 
Returns:
CP_ScriptableObject_Imp * The contained object.

CP_ScriptableObject_Imp * CP_ScriptableObject_Imp::DoAE_CreateElement const DescType  inDesiredClass,
const DescType  inInsertLocation,
const AppleEvent &  inEvent,
AppleEvent &  inOutAEReply
[virtual, inherited]
 

Subclasses need to override this to handle the create element event.

Parameters:
inDesiredClass A DescType describing the class desired to create.
inInsertLocation A DescType describing the location to insert the object.
inEvent The incoming AppleEvent that we are creating the object for.
inOutAEReply The reply to the incoming Apple Event.
Exceptions:
none 
Returns:
CP_ScriptableObject_Imp * The newly created element.

Reimplemented in CP_Application< DOC_POLICY, PRINT_POLICY, UNDO_POLICY >.

void CP_ScriptableObject_Imp::AddEvent SInt32  inEventID,
CP_AppleEventSignal inEventSignal
[inherited]
 

Adds the passed in CP_AppleEventSignal to the list of AppleEvents we will handle through a signal / slot connection.

Parameters:
inEventID The identifier of the event to be handled.
inEventSignal The signal to call to handle the event.
Exceptions:
none 
Returns:
void

void CP_ScriptableObject_Imp::RemoveEvent SInt32  inEventID  )  [inherited]
 

Removes a previously added event handler from the list of the events handled by the object.

Parameters:
inEventID The identifier of the event to be removed.
Exceptions:
none 
Returns:
void

bool CP_ScriptableObject_Imp::HasHandlerForEvent SInt32  inEventID  )  [inherited]
 

Returns true if there is a registered signal handler for the passed in event.

Parameters:
inEventID The event id to check for a handler for.
Exceptions:
none 
Returns:
bool True if we have a handler for the event.

CP_AppleEventSignal * CP_ScriptableObject_Imp::FindHandlerForEvent SInt32  inEventID  )  [inherited]
 

Finds and returns the signal for the passed in event.

Parameters:
inEventID The identifier of the event to return the signal handler for.
Exceptions:
none 
Returns:
CP_AppleEventSignal * The AppleEventSignal handler for the event.

void CP_ScriptableObject_Imp::GetScriptableObjectToken DescType  inModelID,
DescType  inKeyForm,
const AEDesc &  inKeyData,
AEDesc &  outToken
[virtual, inherited]
 

Tries to get the CP_ModelToken from the passed in descriptor and return in outToken.

Parameters:
inModelID Identifier of the model to get.
inKeyForm Form to use.
inKeyData Descriptor that holds the data.
outToken Location to return the result in.
Exceptions:
none 
Returns:
void

void CP_ScriptableObject_Imp::PutInToken CP_ScriptableObject_Imp inScriptableObject,
AEDesc &  outToken
const [inherited]
 

Places the passed in scriptable object into a CP_ModelToken and then packages it up in a descriptor and returns in outToken.

Parameters:
inScriptableObject Object to package up.
outToken Location to return the result in.
Exceptions:
OSErrorExceptions 
Returns:
void

CP_ScriptableObject_Imp* CP_ScriptableObject_Imp::GetScriptableObjectProperty DescType  inProperty  )  const [inherited]
 

void CP_ScriptableObject_Imp::SendAppleEvent_Self const AEEventClass  inEventClass,
const AEEventID  inEventID,
const bool  inDoExecute
[inherited]
 

Send an Apple Event to ourselves. Used to record events.

Parameters:
inEventClass The AEEventClass for this event.
inEventID The AEEventID for this event.
inDoExecute If false, the event is sent for recording purposes, but not actually executed.
Exceptions:
none 
Returns:
void

void CP_ScriptableObject_Imp::MakeSpecifier AEDesc &  inOutSpecifier  )  [virtual, inherited]
 

Make the specifier for our object. This method will recruisvely travel the object heirachy to make the correct specifier.

Parameters:
inOutSpecifier The CP_AE_Object where we will place the results.
Exceptions:
none 
Returns:
void

void CP_ScriptableObject_Imp::GotRequiredParams const AppleEvent &  inAppleEvent  )  [virtual, inherited]
 

Check to make sure that the required params for the event are present, and throw an OSErr exception if they are missing.

Parameters:
inAppleEvent The AppleEvent that we are checking.
Exceptions:
OSErrorExceptions 
Returns:
void

void CP_ScriptableObject_Imp::Install CP_AE_ObjectDispatcher inDispatcher = NULL  )  [protected, virtual, inherited]
 

Initialize our Apple Event handling by installing the Apple Event dispatcher and its object handlers.

Parameters:
inDispatcher Ghe CP_AE_ObjectDispatcher you want to use. If you pass NULL in this parameter, then the default CPLAT dispatcher will be used.
Exceptions:
none 
Returns:
void

void CP_ScriptableObject_Imp::DoAE_Activate const AppleEvent &  inEvent,
AppleEvent &  inOutReply
[protected, virtual, inherited]
 

void CP_ScriptableObject_Imp::DoAE_Clone const AppleEvent &  inEvent,
AppleEvent &  inOutReply
[protected, virtual, inherited]
 

void CP_ScriptableObject_Imp::DoAE_Delete const AppleEvent &  inEvent,
AppleEvent &  inOutReply
[protected, virtual, inherited]
 

void CP_ScriptableObject_Imp::DoAE_DoObjectsExist const AppleEvent &  inEvent,
AppleEvent &  inOutReply
[protected, virtual, inherited]
 

void CP_ScriptableObject_Imp::DoAE_Move const AppleEvent &  inEvent,
AppleEvent &  inOutReply
[protected, virtual, inherited]
 

void CP_ScriptableObject_Imp::DoAE_Open const AppleEvent &  inEvent,
AppleEvent &  inOutReply
[protected, virtual, inherited]
 

void CP_ScriptableObject_Imp::DoAE_Print const AppleEvent &  inEvent,
AppleEvent &  inOutReply
[protected, virtual, inherited]
 

void CP_ScriptableObject_Imp::DoAE_Save const AppleEvent &  inEvent,
AppleEvent &  inOutReply
[protected, virtual, inherited]
 

void CP_ScriptableObject_Imp::DoAE_Revert const AppleEvent &  inEvent,
AppleEvent &  inOutReply
[protected, virtual, inherited]
 

void CP_ScriptableObject_Imp::GetContainedObject_FormAbsolutePosition const DescType  inDesiredClass,
const DescType  inForm,
const AEDesc &  inSelectionData,
AEDesc &  outToken
[protected, virtual, inherited]
 

Return the object contained in the passed in container based upon the inForm criteria.

Parameters:
inDesiredClass A DescType describing the class we are looking for.
inForm a DescType describing the form.
inSelectionData AEDesc with the selection data.
inNeedsDisposal Flag to indicate if we should dispose dispose of objects.
Exceptions:
none 
Returns:
void

void CP_ScriptableObject_Imp::GetContainedObject_FormName const DescType  inDesiredClass,
const DescType  inForm,
const AEDesc &  inSelectionData,
AEDesc &  outToken
[protected, virtual, inherited]
 

Return the object contained in the passed in container based upon the inForm criteria.

Parameters:
inDesiredClass A DescType describing the class we are looking for.
inForm a DescType describing the form.
inSelectionData AEDesc with the selection data.
inNeedsDisposal Flag to indicate if we should dispose dispose of objects.
Exceptions:
none 
Returns:
void

void CP_ScriptableObject_Imp::GetContainedObject_FormUniqueID const DescType  inDesiredClass,
const DescType  inForm,
const AEDesc &  inSelectionData,
AEDesc &  outToken
[protected, virtual, inherited]
 

Return the object contained in the passed in container based upon the inForm criteria.

Parameters:
inDesiredClass A DescType describing the class we are looking for.
inForm a DescType describing the form.
inSelectionData AEDesc with the selection data.
inNeedsDisposal Flag to indicate if we should dispose dispose of objects.
Exceptions:
none 
Returns:
void

void CP_ScriptableObject_Imp::GetContainedObject_FormRelativePosition const DescType  inDesiredClass,
const DescType  inForm,
const AEDesc &  inSelectionData,
AEDesc &  outToken
[protected, virtual, inherited]
 

Return the object contained in the passed in container based upon the inForm criteria.

Parameters:
inDesiredClass A DescType describing the class we are looking for.
inForm a DescType describing the form.
inSelectionData AEDesc with the selection data.
inNeedsDisposal Flag to indicate if we should dispose dispose of objects.
Exceptions:
none 
Returns:
void

void CP_ScriptableObject_Imp::GetContainedObject_FormPropertyID const DescType  inDesiredClass,
const DescType  inForm,
const AEDesc &  inSelectionData,
AEDesc &  outToken
[protected, virtual, inherited]
 

Return the object contained in the passed in container based upon the inForm criteria.

Parameters:
inDesiredClass A DescType describing the class we are looking for.
inForm a DescType describing the form.
inSelectionData AEDesc with the selection data.
inNeedsDisposal Flag to indicate if we should dispose dispose of objects.
Exceptions:
none 
Returns:
void

void CP_ScriptableObject_Imp::GetContainedObject_OtherForm const DescType  inDesiredClass,
const DescType  inForm,
const AEDesc &  inSelectionData,
AEDesc &  outToken
[protected, virtual, inherited]
 

Return the object contained in the passed in container based upon the inForm criteria.

Parameters:
inDesiredClass A DescType describing the class we are looking for.
inForm a DescType describing the form.
inSelectionData AEDesc with the selection data.
inNeedsDisposal Flag to indicate if we should dispose dispose of objects.
Exceptions:
CP_AE_EventNotHandledException 
Returns:
void

SInt32 CP_ScriptableObject_Imp::GetPositionOfSubObject const DescType  inObjectID,
const CP_ScriptableObject_Imp inObject
const [protected, virtual, inherited]
 

Subclasses need to override to return the position of their sub objects.

Parameters:
inDesiredClass A DescType for the class we are looking for.
inObject The object we are looking for.
Exceptions:
none 
Returns:
SInt32 The position of the subobject.


Member Data Documentation

CP_Window* CP_DrawerWindow::fParentWindow [protected]
 

CP_DataValueSignal CP_DrawerWindow::fDrawerOpeningSignal [protected]
 

CP_DataValueSignal CP_DrawerWindow::fDrawerOpenedSignal [protected]
 

Signal sent when the window is opening.

CP_DataValueSignal CP_DrawerWindow::fDrawerClosingSignal [protected]
 

Signal sent when the window has opened.

CP_DataValueSignal CP_DrawerWindow::fDrawerClosedSignal [protected]
 

Signal sent when the window is closing.

CP_DataValueSignal CP_Window_Imp::fWindowClosingSignal [protected, inherited]
 

CP_WindowTypeBase CP_Window_Imp::fWindowTypeBase [protected, inherited]
 

Signal sent when the window is closing.

CP_Size CP_Window_Imp::fMinSize [protected, inherited]
 

Object that controls the appearance and behavior of the platforms OS window.

CP_Size CP_Window_Imp::fMaxSize [protected, inherited]
 

Minimum size a window can shrink to.

CP_Size CP_Window_Imp::fIdealSize [protected, inherited]
 

Maximum size a window can grow to.

SInt32 CP_Window_Imp::fWindowData [protected, inherited]
 

Ideal size for a window that does not change size.

bool CP_View::fIsContainer [protected, inherited]
 

CP_Point CP_View::fPrintLocation [protected, inherited]
 

CP_Size CP_View::fPrintSize [protected, inherited]
 

bool CP_View::fIsFocused [protected, inherited]
 

CP_DataValueSignal CP_View::fFocusChangedSignal [protected, inherited]
 

CP_View_Imp_Base* CP_View_Imp::fViewImpBase [protected, inherited]
 

CP_EventHandler CP_View_Imp::fDummyEventHandler [protected, inherited]
 

Object that actually implements the pane.

UInt32 CP_View_Imp::fCommandID [protected, inherited]
 

Dummy event handler if the view imp has not been created.

CP_SmartPtr<CP_FrameAdapter> CP_View_Imp::fFrameAdapter [protected, inherited]
 

The command associated with this view / control.

UInt32 CP_View_Imp::fFlags [protected, inherited]
 

CP_ViewBackground* CP_View_Imp::fViewBackground [protected, inherited]
 

CP_DataValueSignal CP_View_Imp::fBoundsChangedSignal [protected, inherited]
 

CP_DataValueSignal CP_View_Imp::fShowSignal [protected, inherited]
 

Signal sent when the bounds of this view change.

CP_DataValueSignal CP_View_Imp::fHideSignal [protected, inherited]
 

Signal sent when the view is becoming visible.

CP_DataValueSignal CP_View_Imp::fActivateSignal [protected, inherited]
 

Signal sent when the view is becoming hidden.

CP_DataValueSignal CP_View_Imp::fDeactivateSignal [protected, inherited]
 

Signal sent when the view is becoming active.

CP_DataValueSignal CP_View_Imp::fEnableSignal [protected, inherited]
 

Signal sent when the view is becoming inactive.

CP_DataValueSignal CP_View_Imp::fDisableSignal [protected, inherited]
 

Signal sent when the view is becoming enabled.

CP_DataValueSlot CP_View_Imp::fShowSlot [protected, inherited]
 

Signal sent when the view is becoming disable.

CP_DataValueSlot CP_View_Imp::fHideSlot [protected, inherited]
 

Slot to show a view.

CP_DataValueSlot CP_View_Imp::fActivateSlot [protected, inherited]
 

Slot to hide a view.

CP_DataValueSlot CP_View_Imp::fDeactivateSlot [protected, inherited]
 

Slot to activate a view.

CP_DataValueSlot CP_View_Imp::fEnableSlot [protected, inherited]
 

Slot to deactivate a view.

CP_DataValueSlot CP_View_Imp::fDisableSlot [protected, inherited]
 

Slot to enable a view.

CP_Signals_Array* CP_Object::fSignals [protected, inherited]
 

CP_Slots_Array* CP_Object::fSlots [protected, inherited]
 

List of registered signals for this object.

FourCharCode CP_Object::fObjectID [protected, inherited]
 

List of registered slots for this object.

CPLAT_Begin_Namespace_CPLAT FourCharCode CP_Object::fObjectIDCount = 0 [static, protected, inherited]
 

Object identifier.

CP_Commands_Array* CP_M_CommandHandler::fCommands [protected, inherited]
 

CP_MenuSelectionSignal* CP_M_CommandHandler::fMennuSelectionSignal [protected, inherited]
 

List of commands managed by this class.

sender_set CP_SigSlot::CP_SlotObject::fSenders [protected, inherited]
 

CPLAT_Begin_Namespace_CPLAT CP_DragTarget_List * CP_M_DragTarget::fsDragTargetList = NULL [static, protected, inherited]
 

CP_M_DragTarget * CP_M_DragTarget::fsCurrentDragTarget = NULL [static, protected, inherited]
 

bool CP_M_DragTarget::fsDragHasLeftSender = false [static, protected, inherited]
 

CP_Window* CP_M_DragTarget::fWindow [protected, inherited]
 

bool CP_M_DragTarget::fDropAreaIsHilited [protected, inherited]
 

bool CP_M_DragTarget::fCanAcceptCurrentDrag [protected, inherited]
 

CP_SubViews_List* CP_M_SubViewHandler::fSubViews [protected, inherited]
 

CPLAT_Begin_Namespace_CPLAT CP_ScriptableObject_Imp * CP_ScriptableObject_Imp::gDefaultObject = NULL [static, protected, inherited]
 

bool CP_ScriptableObject_Imp::gInited = false [static, protected, inherited]
 

The default object that events will be dispatched to.

CP_AppleEventHandler_Map CP_ScriptableObject_Imp::fEventHandlers [protected, inherited]
 

Flag to indicate if this class has been initialized.

CP_ScriptableObject_Imp* CP_ScriptableObject_Imp::fSuperScriptableObject [protected, inherited]
 

Map that contains all of the registered handlers.

CP_ScriptableObject_Imp* CP_ScriptableObject_Imp::fDefaultSubScriptableObject [protected, inherited]
 

Scriptable object that is our container.

CP_ScriptableObject_Imp* CP_ScriptableObject_Imp::fDefaultSuperScriptableObject [protected, inherited]
 

Default scriptable object that is contained by this object.


The documentation for this class was generated from the following files:
Generated on Tue Sep 20 20:21:41 2005 for CPLAT_MacOS by  doxygen 1.4.0