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

CP_View_Imp_Base Class Reference

Inheritance diagram for CP_View_Imp_Base:

CP_M_CommandHandler CP_SigSlot::CP_SlotObject CP_View_Imp_Control CP_View_Imp_ControlScroller CP_View_Imp_MLTE CP_View_Imp_Toolbar CP_View_Imp_Toolbar_Item List of all members.

Getters

virtual CP_EventHandler & GetEventHandler ()
virtual CP_Rect GetPortBounds ()
CP_Rect GetLocalBounds ()
OSControl GetOSControl () const
void SetOSControl (OSControl inOSControl)
CP_View * GetSuperview ()
CP_Point GetLocation ()
CP_Size GetSize ()

Drawing

virtual void Draw ()
void HandleDraw (CP_Canvas &inCanvas, CP_Region &inUpdateArea)
virtual void PrepareDraw (CP_Canvas &, CP_Region &)
virtual CP_Canvas SetupForDrawing ()
virtual void FinishDrawing (CP_Canvas &drawingCanvas)
virtual void Invalidate (const CP_Region &)
virtual void Refresh ()
CP_Point GetOrigin ()
void SetOrigin (const CP_Point &inOrigin)

Public Member Functions

void disconnect_all ()
void signal_connect (CP_Signal *inSender)
void signal_disconnect (CP_Signal *inSender)
Constructor / Destructor
virtual ~CP_View_Imp_Base () throw ()
 Destructor.
Appearance
virtual void Show ()
virtual void Hide ()
virtual void Activate ()
virtual void Deactivate ()
virtual void Enable ()
virtual void Disable ()
Getters
virtual void SetPortBounds (const CP_Rect &)
Positioning
virtual void Move (const CP_Point &)
Superview
virtual void AddSubview (CP_View_Imp *)
virtual void AdjustToSuperview (CP_View *)
Positioning
virtual void SetLocation (const CP_Point &)
virtual void SetSize (const CP_Size &)
Testers
virtual bool IsVisible () const
virtual bool IsActive () const
virtual bool IsEnabled () const

Protected Member Functions

Constructor / Destructor
 CP_View_Imp_Base ()
 Constructor.
 CP_View_Imp_Base (CP_View_Imp *inOwnerViewImp, CP_View *inSuperview, const CP_Point &inUpperLeft, const CP_Size &inContentSize, bool inCreateImp=false)

Protected Attributes

CP_View * fSuperview
CP_Point fOrigin
CP_View_Imp * fOwnerViewImp
OSControl fOSControl
CP_EventHandler fDummyEventHandler
CP_Point fLocation
CP_Size fSize
CP_Commands_Array * fCommands
CP_MenuSelectionSignal * fMennuSelectionSignal
sender_set fSenders

Private Member Functions

Initialization
void CreateImp ()

Constructor & Destructor Documentation

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

Destructor.

Exceptions:
none 

CPLAT_Begin_Namespace_CPLAT CP_View_Imp_Base::CP_View_Imp_Base (   )  [protected]
 

Constructor.

Exceptions:
none 

CP_View_Imp_Base::CP_View_Imp_Base (  CP_View_Imp *  inOwnerViewImp,
CP_View *  inSuperview,
const CP_Point &  inUpperLeft,
const CP_Size &  inContentSize,
bool  inCreateImp = false
)  [protected]
 

Constructor. Create a View with the upper left corner at inLocation, and the content size of inSize.

Parameters:
inOwnerViewImp The CP_View_Imp that is using this object to perform its OS implementation.
inSuperview The subview handler that contains this View.
inLocation Upper left corner of View in releation to its superview.
inSize Content size of the View.
inCreateImp Flag to indicate if the user View control should be created for this View. This flag would be true if this is a custom View and not one of the system controls.
Exceptions:
none 

Member Function Documentation

virtual void CP_View_Imp_Base::Show (   )  [virtual]
 

Reimplemented in CP_View_Imp_Control.

virtual void CP_View_Imp_Base::Hide (   )  [virtual]
 

Reimplemented in CP_View_Imp_Control.

virtual void CP_View_Imp_Base::Activate (   )  [virtual]
 

Reimplemented in CP_View_Imp_Control, and CP_View_Imp_MLTE.

virtual void CP_View_Imp_Base::Deactivate (   )  [virtual]
 

Reimplemented in CP_View_Imp_Control, and CP_View_Imp_MLTE.

virtual void CP_View_Imp_Base::Enable (   )  [virtual]
 

Reimplemented in CP_View_Imp_Control.

virtual void CP_View_Imp_Base::Disable (   )  [virtual]
 

Reimplemented in CP_View_Imp_Control.

void CP_View_Imp_Base::PortToLocal (  CP_Point &  inPortPoint  )  [virtual]
 

void CP_View_Imp_Base::PortToLocal (  CP_Rect &  inPortRect  ) 
 

void CP_View_Imp_Base::PortToGlobal (  CP_Point &  inPortPoint  ) 
 

void CP_View_Imp_Base::PortToGlobal (  CP_Rect &  inPortRect  ) 
 

void CP_View_Imp_Base::LocalToPort (  CP_Point &  inPortPoint  ) 
 

void CP_View_Imp_Base::LocalToPort (  CP_Rect &  inPortRect  ) 
 

virtual void CP_View_Imp_Base::InitEventHandler (  CP_EventHandler &   )  [virtual]
 

CP_EventHandler & CP_View_Imp_Base::GetEventHandler (   )  [virtual]
 

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.

Reimplemented in CP_View_Imp_Control.

CP_Rect CP_View_Imp_Base::GetPortBounds (   )  [virtual]
 

Return the port bounds of this pane. This is the bounds of the pane in port coordinates.

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

Reimplemented in CP_View_Imp_Control.

CP_Rect CP_View_Imp_Base::GetLocalBounds (   ) 
 

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

Exceptions:
none 
Returns:
CP_Rect const Returns the bounds of this pane.

OSControl CP_View_Imp_Base::GetOSControl (   )  const
 

Returns the OSControl that is implementing this base view. The will be a MacOS ControlHandle on non HIView OSs or non compositing windows, and an HIViewRef on compositing windows.

Exceptions:
none 
Returns:
OSControl The OSControl implementing this view.

void CP_View_Imp_Base::SetOSControl (  OSControl  inOSControl  ) 
 

CP_View* CP_View_Imp_Base::GetSuperview (   ) 
 

CP_Point CP_View_Imp_Base::GetLocation (   ) 
 

CP_Size CP_View_Imp_Base::GetSize (   ) 
 

virtual void CP_View_Imp_Base::Draw (   )  [virtual]
 

Cause the View implementation to draw itself.

Exceptions:
none 
Returns:
void

Reimplemented in CP_View_Imp_Control.

void CP_View_Imp_Base::HandleDraw (  CP_Canvas &  inCanvas,
CP_Region &  inUpdateArea
) 
 

Public method called from the various OS implementations when they need to draw some content. This then calls the CP_View_Imp HandleDraw to notify your object that is should draw something via its OnDraw() method.

Parameters:
inCanvas CP_Canvas object that holds the graphics port for the View to draw into. The canvas object should only be considered setup correctly in this call, and not held onto.
inUpdateArea The area that needs to be updated or drawn.
Exceptions:
none 
Returns:
void

virtual void CP_View_Imp_Base::PrepareDraw (  CP_Canvas &  ,
CP_Region & 
)  [virtual]
 

Reimplemented in CP_View_Imp_Control, CP_View_Imp_ControlScroller, and CP_View_Imp_MLTE.

CP_Canvas CP_View_Imp_Base::SetupForDrawing (   )  [virtual]
 

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_View_Imp_Control.

void CP_View_Imp_Base::FinishDrawing (  CP_Canvas &  drawingCanvas  )  [virtual]
 

virtual void CP_View_Imp_Base::Invalidate (  const CP_Region &   )  [virtual]
 

Reimplemented in CP_View_Imp_Control.

virtual void CP_View_Imp_Base::Refresh (   )  [virtual]
 

Reimplemented in CP_View_Imp_Control.

CP_Point CP_View_Imp_Base::GetOrigin (   ) 
 

void CP_View_Imp_Base::SetOrigin (  const CP_Point &  inOrigin  ) 
 

CP_View_Imp * CP_View_Imp_Base::GetOwnerViewImp (   )  const
 

Gets the CP_View_Imp class that this object provides the OS implementation of.

Exceptions:
none 
Returns:
CP_View_Imp * const Returns the owner CP_View_Imp that we belong to.

void CP_View_Imp_Base::SetOwnerViewImp (  CP_View_Imp *  inViewImp  ) 
 

Sets the CP_View_Imp class that this object provides the OS implementation of.

Parameters:
inViewImp The CP_View_Imp class that created us, and we are providing the implementation for.
Exceptions:
none 
Returns:
void

virtual void CP_View_Imp_Base::SetPortBounds (  const CP_Rect &   )  [virtual]
 

Reimplemented in CP_View_Imp_Control, CP_View_Imp_ControlScroller, and CP_View_Imp_MLTE.

virtual void CP_View_Imp_Base::Move (  const CP_Point &   )  [virtual]
 

Reimplemented in CP_View_Imp_Control, and CP_View_Imp_ControlScroller.

virtual void CP_View_Imp_Base::AddSubview (  CP_View_Imp *   )  [virtual]
 

Reimplemented in CP_View_Imp_Control.

virtual void CP_View_Imp_Base::AdjustToSuperview (  CP_View *   )  [virtual]
 

Reimplemented in CP_View_Imp_Control.

virtual void CP_View_Imp_Base::SetLocation (  const CP_Point &   )  [virtual]
 

Reimplemented in CP_View_Imp_Control.

virtual void CP_View_Imp_Base::SetSize (  const CP_Size &   )  [virtual]
 

Reimplemented in CP_View_Imp_Control.

virtual bool CP_View_Imp_Base::IsVisible (   )  const [virtual]
 

Reimplemented in CP_View_Imp_Control.

virtual bool CP_View_Imp_Base::IsActive (   )  const [virtual]
 

Reimplemented in CP_View_Imp_Control.

virtual bool CP_View_Imp_Base::IsEnabled (   )  const [virtual]
 

Reimplemented in CP_View_Imp_Control.

void CP_View_Imp_Base::CreateImp (   )  [private]
 

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]
 

Member Data Documentation

CP_View* CP_View_Imp_Base::fSuperview [protected]
 

CP_Point CP_View_Imp_Base::fOrigin [protected]
 

CP_View that contains this view

CP_View_Imp* CP_View_Imp_Base::fOwnerViewImp [protected]
 

OSControl CP_View_Imp_Base::fOSControl [protected]
 

CP_View_Imp that we provide implementation for.

CP_EventHandler CP_View_Imp_Base::fDummyEventHandler [protected]
 

Platform control to implement View features.

CP_Point CP_View_Imp_Base::fLocation [protected]
 

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

CP_Size CP_View_Imp_Base::fSize [protected]
 

Upper left corner of view, relative to superview

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]
 

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