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

CP_View_Imp_Toolbar_Item Class Reference

Inheritance diagram for CP_View_Imp_Toolbar_Item:

CP_View_Imp_Control CP_View_Imp_Base CP_M_CommandHandler CP_SigSlot::CP_SlotObject List of all members.

Drawing

void HandleDraw (CP_Canvas &inCanvas, CP_Region &inUpdateArea)
virtual void FinishDrawing (CP_Canvas &drawingCanvas)
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)
Events
virtual void InitEventHandler (CP_EventHandler &)
Appearance
virtual void Show ()
virtual void Hide ()
virtual void Activate ()
virtual void Deactivate ()
virtual void Enable ()
virtual void Disable ()
Drawing
virtual CP_Canvas SetupForDrawing ()
virtual void HandleDraw (ControlRef inControl)
virtual void Draw ()
virtual void PrepareDraw (CP_Canvas &inCanvas, CP_Region &inUpdateArea)
virtual void Refresh ()
Getters
virtual CP_EventHandlerGetEventHandler ()
virtual CP_Rect GetPortBounds ()
Positioning
virtual void Move (const CP_Point &inOffset)
Superview
virtual void AddSubview (CP_View_Imp *inView)
virtual void AdjustToSuperview (CP_View *inView)
Positioning
virtual void SetPortBounds (const CP_Rect &inBounds)
virtual void SetLocation (const CP_Point &inLocation)
virtual void SetSize (const CP_Size &inSize)
Testers
virtual bool IsVisible () const
virtual bool IsActive () const
virtual bool IsEnabled () const
Events
virtual void InitEventHandler (CP_EventHandler &)
Appearance
virtual void Show ()
virtual void Hide ()
virtual void Activate ()
virtual void Deactivate ()
virtual void Enable ()
virtual void Disable ()
Drawing
virtual CP_Canvas SetupForDrawing ()
virtual void HandleDraw (ControlRef inControl)
virtual void Draw ()
virtual void Refresh ()
Getters
virtual CP_EventHandlerGetEventHandler ()
virtual CP_Rect GetPortBounds ()
Superview
virtual void AddSubview (CP_View_Imp *inView)
virtual void AdjustToSuperview (CP_View *inView)
Positioning
virtual void SetLocation (const CP_Point &inLocation)
virtual void SetSize (const CP_Size &inSize)
Testers
virtual bool IsVisible () const
virtual bool IsActive () const
virtual bool IsEnabled () const
Events
virtual void InitEventHandler (CP_EventHandler &)
Appearance
virtual void Show ()
virtual void Hide ()
virtual void Enable ()
virtual void Disable ()
Drawing
virtual CP_Canvas SetupForDrawing ()
virtual void Draw ()
virtual void Refresh ()
Events
virtual void HandleActivate (ControlRef inControl, Boolean inActivating)
virtual void HandleKeyDown (ControlRef inControl, SInt16 keyCode, SInt16 charCode, SInt16 modifiers)
Getters
virtual CP_EventHandlerGetEventHandler ()
virtual CP_Rect GetPortBounds ()
Positioning
virtual void Move (const CP_Point &inOffset)
Superview
virtual void AddSubview (CP_View_Imp *inView)
virtual void AdjustToSuperview (CP_View *inView)
Positioning
virtual void SetLocation (const CP_Point &inLocation)
virtual void SetSize (const CP_Size &inSize)
Testers
virtual bool IsVisible () const
virtual bool IsActive () const
virtual bool IsEnabled () const
Events
virtual void InitEventHandler (CP_EventHandler &)
Appearance
virtual void Show ()
virtual void Hide ()
virtual void Activate ()
virtual void Deactivate ()
virtual void Enable ()
virtual void Disable ()
Drawing
virtual CP_Canvas SetupForDrawing ()
virtual void HandleDraw (ControlRef inControl)
virtual void Draw ()
virtual void PrepareDraw (CP_Canvas &inCanvas, CP_Region &inUpdateArea)
virtual void Refresh ()
Getters
virtual CP_EventHandlerGetEventHandler ()
virtual CP_Rect GetPortBounds ()
Positioning
virtual void Move (const CP_Point &inOffset)
Superview
virtual void AddSubview (CP_View_Imp *inView)
virtual void AdjustToSuperview (CP_View *inView)
Positioning
virtual void SetPortBounds (const CP_Rect &inBounds)
virtual void SetLocation (const CP_Point &inLocation)
virtual void SetSize (const CP_Size &inSize)
Testers
virtual bool IsVisible () const
virtual bool IsActive () const
virtual bool IsEnabled () const
Events
virtual void InitEventHandler (CP_EventHandler &)
Constructor / Destructor
 CP_View_Imp_Toolbar_Item (CP_View_Imp *inOwnerViewImp, CP_View *inSuperview, const CP_Point &inUpperLeft, const CP_Size &inContentSize, const CP_String &inItemText, const CP_S_ViewContentInfo &inContentInfo, const CP_CommandNo inCommand)
 Constructor.
virtual ~CP_View_Imp_Toolbar_Item () throw ()
 Destructor.
Events
virtual ControlPartCode HandleHitTest (ControlRef inControl, const CP_Point &inMouseLocation)
virtual ControlPartCode HandleTracking (ControlRef inControl, const CP_Point &inMouseLocation, ControlActionUPP inActionProc)
Appearance
virtual void Show ()
virtual void Hide ()
virtual void Activate ()
virtual void Deactivate ()
virtual void Enable ()
virtual void Disable ()
Drawing
virtual CP_Canvas SetupForDrawing ()
virtual void HandleDraw (ControlRef inControl)
virtual void Draw ()
virtual void PrepareDraw (CP_Canvas &inCanvas, CP_Region &inUpdateArea)
virtual void Refresh ()
Events
virtual ControlPartCode HandleFocus (ControlRef inControl, ControlFocusPart inAction)
virtual void HandleIdle (ControlRef inControl)
virtual void HandleActivate (ControlRef inControl, Boolean inActivating)
virtual void HandleKeyDown (ControlRef inControl, SInt16 keyCode, SInt16 charCode, SInt16 modifiers)
Getters
virtual CP_EventHandlerGetEventHandler ()
virtual CP_Rect GetPortBounds ()
Positioning
virtual void Move (const CP_Point &inOffset)
Superview
virtual void AddSubview (CP_View_Imp *inView)
virtual void AdjustToSuperview (CP_View *inView)
Positioning
virtual void SetPortBounds (const CP_Rect &inBounds)
virtual void SetLocation (const CP_Point &inLocation)
virtual void SetSize (const CP_Size &inSize)
Testers
virtual bool IsVisible () const
virtual bool IsActive () const
virtual bool IsEnabled () const
Events
virtual void InitEventHandler (CP_EventHandler &)

Protected Member Functions

Drawing
void Invalidate (const CP_Region &inInvalidArea)
Drawing
virtual void HandleDrawInCanvas (CP_Canvas &inCanvas, CP_Region &inUpdateArea)
Drawing
void Invalidate (const CP_Region &inInvalidArea)

Protected Attributes

CP_String fItemText
CP_S_ViewContentInfo fContentInfo
CP_CommandNo fCommand
CP_EventHandler fEventHandler
CP_ViewfSuperview
CP_Point fOrigin
CP_View_ImpfOwnerViewImp
OSControl fOSControl
CP_EventHandler fDummyEventHandler
CP_Point fLocation
CP_Size fSize
CP_Commands_ArrayfCommands
CP_MenuSelectionSignalfMennuSelectionSignal
sender_set fSenders

Static Protected Attributes

static ControlUserPaneDrawUPP fsPaneImp_DrawProc = NULL
static ControlUserPaneHitTestUPP fsPaneImp_HitTestProc = NULL
static ControlUserPaneTrackingUPP fsPaneImp_PaneTrackingProc = NULL
static ControlUserPaneFocusUPP fsPaneImp_PaneFocusProc = NULL
static ControlUserPaneIdleUPP fsPaneImp_PaneIdleProc = NULL
static ControlUserPaneActivateUPP fsPaneImp_PaneActivateProc = NULL
static ControlUserPaneKeyDownUPP fsPaneImp_PaneKeyDownProc = NULL

Private Member Functions

Getters
CP_Rect GetTextBounds (const CP_Rect &inBounds, bool inLimitToTextWidth) const
CP_Rect GetImageBounds (const CP_Rect &inBounds) const

Constructor & Destructor Documentation

CP_View_Imp_Toolbar_Item::CP_View_Imp_Toolbar_Item CP_View_Imp inOwnerViewImp,
CP_View inSuperview,
const CP_Point inUpperLeft,
const CP_Size inContentSize,
const CP_String inItemText,
const CP_S_ViewContentInfo inContentInfo,
const CP_CommandNo  inCommand
 

Constructor.

Parameters:
inOwnerViewImp The CP_View that this imp class is used in.
inSuperview The view that contains this control.
inLocation Upper left corner of pane in releation to its superview.
inContentSize Content size of the pane.
inItemText The text of the item being added.
inContentInfo Contains information about the item.
inCommand Command sent when the user clicks on the item.
Exceptions:
none 
Returns:
void

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

Destructor.

Exceptions:
none 


Member Function Documentation

ControlPartCode CP_View_Imp_Toolbar_Item::HandleHitTest ControlRef  inControl,
const CP_Point inMouseLocation
[virtual]
 

Called when the user has clicked on this item.

Parameters:
inControl Not used.
inMouseLocation Port location of the mouse.
Exceptions:
none 
Returns:
ControlPartCode Returns kControlIndicatorPart if the mouse click was over the item. Otherwise kControlNoPart is returned.

Reimplemented from CP_View_Imp_Control.

ControlPartCode CP_View_Imp_Toolbar_Item::HandleTracking ControlRef  inControl,
const CP_Point inMouseLocation,
ControlActionUPP  inActionProc
[virtual]
 

Called when the user has clicked on this item and moving the mouse with the button still down. This will handle the tracking needed while the user continues to move the mouse over the item with the mouse button down.

Parameters:
inControl The items control that the mouse is over.
inMouseLocation Port location of the mouse.
inActionProc Not used.
Exceptions:
none 
Returns:
ControlPartCode Returns the part code where the mouse was when the button was released.

Reimplemented from CP_View_Imp_Control.

void CP_View_Imp_Toolbar_Item::HandleDrawInCanvas CP_Canvas inCanvas,
CP_Region inUpdateArea
[protected, virtual]
 

Handle drawing the item into the passed in canvas object.

Parameters:
inCanvas The destination CP_Canvas object.
inUpdateArea The area needing to be updated.
Exceptions:
none 
Returns:
void

Reimplemented from CP_View_Imp_Control.

CP_Rect CP_View_Imp_Toolbar_Item::GetTextBounds const CP_Rect inBounds,
bool  inLimitToTextWidth
const [private]
 

Returns the bounds of the text for this item.

Parameters:
inBounds The bounds of the item.
inLimitToTextWidth Flag to indicate if the item is calculated to the exact width of the text.
Exceptions:
none 
Returns:
CP_Rect const The return bounds of the item.

CP_Rect CP_View_Imp_Toolbar_Item::GetImageBounds const CP_Rect inBounds  )  const [private]
 

Returns the bounds of the image for this item.

Parameters:
inBounds The bounds of the item.
Exceptions:
none 
Returns:
CP_Rect const The return bounds of the image.

void CP_View_Imp_Control::Show  )  [virtual, inherited]
 

Show this control.

Exceptions:
none 
Returns:
void

Reimplemented from CP_View_Imp_Base.

void CP_View_Imp_Control::Hide  )  [virtual, inherited]
 

Hide this control.

Exceptions:
none 
Returns:
void

Reimplemented from CP_View_Imp_Base.

void CP_View_Imp_Control::Activate  )  [virtual, inherited]
 

Activate this control.

Exceptions:
none 
Returns:
void

Reimplemented from CP_View_Imp_Base.

Reimplemented in CP_View_Imp_MLTE.

void CP_View_Imp_Control::Deactivate  )  [virtual, inherited]
 

Deactivate this control.

Exceptions:
none 
Returns:
void

Reimplemented from CP_View_Imp_Base.

Reimplemented in CP_View_Imp_MLTE.

void CP_View_Imp_Control::Enable  )  [virtual, inherited]
 

Enable this control.

Exceptions:
none 
Returns:
void

Reimplemented from CP_View_Imp_Base.

void CP_View_Imp_Control::Disable  )  [virtual, inherited]
 

Disable this control.

Exceptions:
none 
Returns:
void

Reimplemented from CP_View_Imp_Base.

CP_Canvas CP_View_Imp_Control::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 control 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 from CP_View_Imp_Base.

void CP_View_Imp_Control::HandleDraw ControlRef  inControl  )  [virtual, inherited]
 

Called from the user pane draw upp to handle setting up the environment for drawing the contents of this control, and then calling the CP_Views overriden HandleDraw() for a subclass to perform the actual drawing in this control.

Parameters:
inControl The control that is being drawn into.
Exceptions:
none 
Returns:
void

Reimplemented in CP_View_Imp_MLTE.

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

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

void CP_View_Imp_Control::Draw  )  [virtual, inherited]
 

Draws the user pane control immediately. This will take care of setting up the drawing environment for the control to draw, and then draw the contents of the control.

Exceptions:
none 
Returns:
void

Reimplemented from CP_View_Imp_Base.

void CP_View_Imp_Control::PrepareDraw CP_Canvas inCanvas,
CP_Region inUpdateArea
[virtual, inherited]
 

Prepares the control for drawing into.

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

Reimplemented from CP_View_Imp_Base.

Reimplemented in CP_View_Imp_ControlScroller, and CP_View_Imp_MLTE.

void CP_View_Imp_Control::Refresh  )  [virtual, inherited]
 

Cause the control to refresh itself by invalidating the bounds of this control.

Exceptions:
none 
Returns:
void

Reimplemented from CP_View_Imp_Base.

ControlPartCode CP_View_Imp_Control::HandleFocus ControlRef  inControl,
ControlFocusPart  inFocusPart
[virtual, inherited]
 

Called from the user pane upp to set the focus of this control. This calls the owner view imp class to let subclasses perform the actual focus setting.

Parameters:
theControl The MacOS control.
inFocusPart The part to focus.
Exceptions:
none 
Returns:
ControlParCode The part code that will receive the focus.

Reimplemented in CP_View_Imp_MLTE.

void CP_View_Imp_Control::HandleIdle ControlRef  inControl  )  [virtual, inherited]
 

Reimplemented in CP_View_Imp_MLTE.

void CP_View_Imp_Control::HandleActivate ControlRef  inControl,
Boolean  inActivating
[virtual, inherited]
 

void CP_View_Imp_Control::HandleKeyDown ControlRef  inControl,
SInt16  keyCode,
SInt16  charCode,
SInt16  modifiers
[virtual, inherited]
 

CP_EventHandler & CP_View_Imp_Control::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.

Reimplemented from CP_View_Imp_Base.

CP_Rect CP_View_Imp_Control::GetPortBounds  )  [virtual, inherited]
 

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 from CP_View_Imp_Base.

void CP_View_Imp_Control::Move const CP_Point inOffset  )  [virtual, inherited]
 

Reimplemented from CP_View_Imp_Base.

Reimplemented in CP_View_Imp_ControlScroller.

void CP_View_Imp_Control::AddSubview CP_View_Imp inView  )  [virtual, inherited]
 

Embeds the passed in view into this control.

Parameters:
inView The CP_View object to embed into this one.
Exceptions:
none 
Returns:
void

Reimplemented from CP_View_Imp_Base.

void CP_View_Imp_Control::AdjustToSuperview CP_View inView  )  [virtual, inherited]
 

Reimplemented from CP_View_Imp_Base.

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

Sets the bounds of this control in port coordinates to that of the passed in rect.

Parameters:
inBounds Port bounds to set this control to.
Exceptions:
none 
Returns:
void

Reimplemented from CP_View_Imp_Base.

Reimplemented in CP_View_Imp_ControlScroller, and CP_View_Imp_MLTE.

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

Sets the location of this control releative to its superview. The passed in location is relative to the subview that contains this control.

Parameters:
inLocation Superview relative coordinates of the location.
Exceptions:
none 
Returns:
void

Reimplemented from CP_View_Imp_Base.

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

Sets the size of this control. This will expand or shrink the control relative to its upper left corner.

Parameters:
inSize Size to make this control.
Exceptions:
none 
Returns:
void

Reimplemented from CP_View_Imp_Base.

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

Returns true if this view is visible.

Exceptions:
none 
Returns:
bool Returns true if the view is visible.

Reimplemented from CP_View_Imp_Base.

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

Returns true if this view is active.

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

Reimplemented from CP_View_Imp_Base.

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

Returns true if this view is enabled.

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

Reimplemented from CP_View_Imp_Base.

void CP_View_Imp_Control::Invalidate const CP_Region inInvalidArea  )  [protected, virtual, 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, in local coordinates.
Exceptions:
none 
Returns:
void

Reimplemented from CP_View_Imp_Base.

void CP_View_Imp_Base::PortToLocal CP_Point inPortPoint  )  [virtual, inherited]
 

void CP_View_Imp_Base::PortToLocal CP_Rect inPortRect  )  [inherited]
 

void CP_View_Imp_Base::PortToGlobal CP_Point inPortPoint  )  [inherited]
 

void CP_View_Imp_Base::PortToGlobal CP_Rect inPortRect  )  [inherited]
 

void CP_View_Imp_Base::LocalToPort CP_Point inPortPoint  )  [inherited]
 

void CP_View_Imp_Base::LocalToPort CP_Rect inPortRect  )  [inherited]
 

virtual void CP_View_Imp_Base::InitEventHandler CP_EventHandler  )  [virtual, inherited]
 

Reimplemented in CP_View_Imp_Gtk, CP_View_Imp_Win, and CP_View_Imp_WinToolbar.

CP_Rect CP_View_Imp_Base::GetLocalBounds  )  [inherited]
 

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 [inherited]
 

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  )  [inherited]
 

CP_View* CP_View_Imp_Base::GetSuperview  )  [inherited]
 

CP_Point CP_View_Imp_Base::GetLocation  )  [inherited]
 

CP_Size CP_View_Imp_Base::GetSize  )  [inherited]
 

void CP_View_Imp_Base::FinishDrawing CP_Canvas drawingCanvas  )  [virtual, inherited]
 

Reimplemented in CP_View_Imp_Win.

CP_Point CP_View_Imp_Base::GetOrigin  )  [inherited]
 

void CP_View_Imp_Base::SetOrigin const CP_Point inOrigin  )  [inherited]
 

CP_View_Imp * CP_View_Imp_Base::GetOwnerViewImp  )  const [inherited]
 

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  )  [inherited]
 

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::SetSizeAndPosition GtkWidget *  ,
CP_View ,
const CP_Point ,
const CP_Size
[virtual, inherited]
 

Adjusts the passed in GtkWidget to be positioned correctly in the subview at the specified position, and resized to the passed in size.

The implementation object of this view will handle the actual work.

Parameters:
inGtkWidget The GtkWidget that is being repositioned.
inSuperview The CP_View that will contains this widget.
inLocation Location in local coorinates releative to the passed in superview to place this view at.
inSize The size to make the passed in GtkWidget, will correspond to the size of this view.
Exceptions:
none 
Returns:
void

Reimplemented in CP_View_Imp_Gtk.

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_String CP_View_Imp_Toolbar_Item::fItemText [protected]
 

CP_S_ViewContentInfo CP_View_Imp_Toolbar_Item::fContentInfo [protected]
 

CP_CommandNo CP_View_Imp_Toolbar_Item::fCommand [protected]
 

CPLAT_Begin_Namespace_CPLAT ControlUserPaneDrawUPP CP_View_Imp_Control::fsPaneImp_DrawProc = NULL [static, protected, inherited]
 

ControlUserPaneHitTestUPP CP_View_Imp_Control::fsPaneImp_HitTestProc = NULL [static, protected, inherited]
 

ControlManager callback to draw the contents of this pane.

ControlUserPaneTrackingUPP CP_View_Imp_Control::fsPaneImp_PaneTrackingProc = NULL [static, protected, inherited]
 

ControlManager callback for hit testing of this pane.

ControlUserPaneFocusUPP CP_View_Imp_Control::fsPaneImp_PaneFocusProc = NULL [static, protected, inherited]
 

ControlManager callback for tracking of this pane.

ControlUserPaneIdleUPP CP_View_Imp_Control::fsPaneImp_PaneIdleProc = NULL [static, protected, inherited]
 

ControlManager callback for tracking of this pane.

ControlUserPaneActivateUPP CP_View_Imp_Control::fsPaneImp_PaneActivateProc = NULL [static, protected, inherited]
 

ControlManager callback for idle time in this pane.

ControlUserPaneKeyDownUPP CP_View_Imp_Control::fsPaneImp_PaneKeyDownProc = NULL [static, protected, inherited]
 

ControlManager callback for pane activate in this pane.

CP_EventHandler CP_View_Imp_Control::fEventHandler [protected, inherited]
 

ControlManager callback for keydowns in this pane.

CP_View* CP_View_Imp_Base::fSuperview [protected, inherited]
 

CP_Point CP_View_Imp_Base::fOrigin [protected, inherited]
 

CP_View that contains this view

CP_View_Imp* CP_View_Imp_Base::fOwnerViewImp [protected, inherited]
 

OSControl CP_View_Imp_Base::fOSControl [protected, inherited]
 

CP_View_Imp that we provide implementation for.

CP_EventHandler CP_View_Imp_Base::fDummyEventHandler [protected, inherited]
 

Platform control to implement View features.

CP_Point CP_View_Imp_Base::fLocation [protected, inherited]
 

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

Reimplemented in CP_View_Imp_Win.

CP_Size CP_View_Imp_Base::fSize [protected, inherited]
 

Upper left corner of view, relative to superview

Reimplemented in CP_View_Imp_Gtk.

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 Sat Sep 17 20:02:28 2005 for CPLAT by  doxygen 1.4.0