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

CP_View_Imp_Rich Class Reference

Inheritance diagram for CP_View_Imp_Rich:

CP_View_Imp_Win CP_Object CP_View_Imp_Base CP_NoCopy CP_M_CommandHandler CP_SigSlot::CP_SlotObject List of all members.

Events

virtual void InitEventHandler (CP_EventHandler &inEventHandler)
LRESULT HandleWinProcMessage (HWND hwnd, UINT iMsg, WPARAM wParam, LPARAM lParam)
void HandleMouseEnteredEvent (CP_Event_Base &inEvent)
void HandleMouseExitedEvent (CP_Event_Base &inEvent)

Getters

virtual CP_EventHandler & GetEventHandler ()
WNDPROC GetOldWinProc ()
HBRUSH GetBackgroundBrush ()
static CP_View_Imp_Win * GetLastViewWithMouse ()
static void SetLastViewWithMouse (CP_View_Imp_Win *inView)

Public Member Functions

 CP_View_Imp_Rich (CP_View_Imp *inOwnerViewImp, CP_View *inSuperview, const CP_Point &inUpperLeft, const CP_Size &inContentSize, bool inHasHorizontalScroll=true, bool inHasVerticalScroll=true, bool inReadOnly=false)
virtual ~CP_View_Imp_Rich () throw ()
void disconnect_all ()
void signal_connect (CP_Signal *inSender)
void signal_disconnect (CP_Signal *inSender)
void SetID (FourCharCode inIdentifier)
FourCharCode GetID ()
void RegisterSignal (const CP_SignalHolder &inSignal)
CP_DataValueSignal * FindSignal (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_CommandHandlerSignal * Connect (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))
Appearance
void Activate ()
void Deactivate ()
Command Handling
void HandleCommandStatus (CP_CommandStatus &inCommandStatus, bool &inOutResult, CP_CommandNo &inCommandNo)
void HandleCutCommand (OSStatus &inOutStatus)
void HandleCopyCommand (OSStatus &inOutStatus)
void HandleClearCommand (OSStatus &inOutStatus)
void HandlePasteCommand (OSStatus &inOutStatus)
void HandleSelectAllCommand (OSStatus &inOutStatus)
void HandleUndoCommand (OSStatus &inOutStatus)
void HandleRedoCommand (OSStatus &inOutStatus)
Drawing
virtual void HandleDraw (OSControl inControl)
Focus
virtual void OnLosingFocus ()
Getters
OSStatus ReadTextFromFile (const CP_FileSystemSpec &inFileSpec)
Getters
CP_String GetText (char inLineEnd=CP_LF)
UInt32 GetTextLength ()
Key Filter
void AttachFilter (CP_KeyInputFilter *inFilter)
CP_KeyInputFilter * GetFilter ()
Printing
void Print ()
Selection
void GetSelection (UInt32 *inStartSelection, UInt32 *inEndSelection)
void SetSelection (UInt32 inStartSelection, UInt32 inEndSelection)
bool HasSelection ()
Setters
void SetText (const CP_String &inText)
void SetText (CP_InStream *inStream)
void InsertText (const CP_String &inText)
void InsertText (const char *inTextPtr, SInt32 inTextLength)
void SetFontSpec (CP_FontSpec &inFontSpec)
Testers
bool HasTextToPaste ()

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

Setters
virtual void SetPortBounds (const CP_Rect &inBounds)
void SetTextFont (const CP_String &inFontName)
void SetTextSize (SInt16 inFontSize)
void SetTextFace (SInt16 inFace)
void SetTextColor (const CP_RGBColor &inForeColor)

Protected Attributes

CP_KeyInputFilter * fKeyFilter
CP_DataValueSignal fFieldExitSignal
CP_EventHandler fEventHandler
CP_Point fLocation
UInt32 fWinStyleFlags
UInt32 fWinExtStyleFlags
WNDPROC fnOldWndProc
bool fIsCustomPane
CP_View * fSuperview
CP_Point fOrigin
CP_View_Imp * fOwnerViewImp
OSControl fOSControl
CP_EventHandler fDummyEventHandler
CP_Size fSize
CP_Commands_Array * fCommands
CP_MenuSelectionSignal * fMennuSelectionSignal
sender_set fSenders
CP_Signals_Array * fSignals
CP_Slots_Array * fSlots
FourCharCode fObjectID

Static Protected Attributes

static SInt16 fsWinViewID = 0
static HBRUSH fsBackgroundBrush
static CP_View_Imp_Win * fsLastViewWithMouse = NULL
static FourCharCode fObjectIDCount = 0

Private Member Functions

Events
void HandleKeyboardInput_Win (CP_Event_Base &inEvent)
void CommandProcess (CP_Event_Base &inEvent)
void CommandUpdateStatus (CP_Event_Base &inEvent)
Initialization
void Init (CP_View *inSuperview, const CP_Point &inLocation, const CP_Size &inContentSize, bool inHasHorizontalScroll=true, bool inHasVerticalScroll=true, bool inReadOnly=false)
void InitEventHandler (CPLAT::CP_EventHandler &inEventHandler)
bool HandleFieldExitChar (char inChar)
Misc
void TextChanged ()

Static Private Member Functions

static DWORD CALLBACK CP_RichText_StreamInCallback (DWORD dwCookie, LPBYTE pbBuff, LONG cb, LONG *pcb)

Constructor & Destructor Documentation

CPLAT_Begin_Namespace_CPLAT CP_View_Imp_Rich::CP_View_Imp_Rich (  CP_View_Imp *  inOwnerViewImp,
CP_View *  inSuperview,
const CP_Point &  inUpperLeft,
const CP_Size &  inContentSize,
bool  inHasHorizontalScroll = true,
bool  inHasVerticalScroll = true,
bool  inReadOnly = false
) 
 

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

Destructor.

Exceptions:
none 

Member Function Documentation

void CP_View_Imp_Rich::Activate (   )  [virtual]
 

Activate this view.

Exceptions:
none 
Returns:
void

Reimplemented from CP_View_Imp_Base.

void CP_View_Imp_Rich::Deactivate (   )  [virtual]
 

Deactivate this view.

Exceptions:
none 
Returns:
void

Reimplemented from CP_View_Imp_Base.

void CP_View_Imp_Rich::HandleCommandStatus (  CP_CommandStatus &  inCommandStatus,
bool &  inOutResult,
CP_CommandNo &  inCommandNo
) 
 

void CP_View_Imp_Rich::HandleCutCommand (  OSStatus &  inOutStatus  ) 
 

void CP_View_Imp_Rich::HandleCopyCommand (  OSStatus &  inOutStatus  ) 
 

void CP_View_Imp_Rich::HandleClearCommand (  OSStatus &  inOutStatus  ) 
 

void CP_View_Imp_Rich::HandlePasteCommand (  OSStatus &  inOutStatus  ) 
 

void CP_View_Imp_Rich::HandleSelectAllCommand (  OSStatus &  inOutStatus  ) 
 

void CP_View_Imp_Rich::HandleUndoCommand (  OSStatus &  inOutStatus  ) 
 

void CP_View_Imp_Rich::HandleRedoCommand (  OSStatus &  inOutStatus  ) 
 

void CP_View_Imp_Rich::HandleDraw (  OSControl  inControl  )  [virtual]
 

void CP_View_Imp_Rich::OnLosingFocus (   )  [virtual]
 

OSStatus CP_View_Imp_Rich::ReadTextFromFile (  const CP_FileSystemSpec &  inFileSpec  ) 
 

CP_String CP_View_Imp_Rich::GetText (  char  inLineEnd = CP_LF  ) 
 

UInt32 CP_View_Imp_Rich::GetTextLength (   ) 
 

void CP_View_Imp_Rich::AttachFilter (  CP_KeyInputFilter *  inFilter  ) 
 

Attach a text field to this field. NOTE: It is possible to pass a NULL validator in, which will remove any existing one.

Parameters:
inValidate - the text filter to attach.

CP_KeyInputFilter * CP_View_Imp_Rich::GetFilter (   ) 
 

Return the key input filter associated with this field.

void CP_View_Imp_Rich::Print (   ) 
 

void CP_View_Imp_Rich::GetSelection (  UInt32 *  inStartSelection,
UInt32 *  inEndSelection
) 
 

void CP_View_Imp_Rich::SetSelection (  UInt32  inStartSelection,
UInt32  inEndSelection
) 
 

bool CP_View_Imp_Rich::HasSelection (   ) 
 

void CP_View_Imp_Rich::SetText (  const CP_String &  inText  ) 
 

void CP_View_Imp_Rich::SetText (  CP_InStream *  inStream  ) 
 

void CP_View_Imp_Rich::InsertText (  const CP_String &  inText  ) 
 

void CP_View_Imp_Rich::InsertText (  const char *  inTextPtr,
SInt32  inTextLength
) 
 

void CP_View_Imp_Rich::SetFontSpec (  CP_FontSpec &  inFontSpec  ) 
 

bool CP_View_Imp_Rich::HasTextToPaste (   ) 
 

Do we have text in our scrap to paste into our field.

void CP_View_Imp_Rich::SetPortBounds (  const CP_Rect &  inBounds  )  [protected, virtual]
 

Sets the port bounds of the child window.

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

Reimplemented from CP_View_Imp_Win.

void CP_View_Imp_Rich::SetTextFont (  const CP_String &  inFontName  )  [protected]
 

void CP_View_Imp_Rich::SetTextSize (  SInt16  inFontSize  )  [protected]
 

void CP_View_Imp_Rich::SetTextFace (  SInt16  inFace  )  [protected]
 

void CP_View_Imp_Rich::SetTextColor (  const CP_RGBColor &  inForeColor  )  [protected]
 

void CP_View_Imp_Rich::HandleKeyboardInput_Win (  CP_Event_Base &  inEvent  )  [private]
 

void CP_View_Imp_Rich::CommandProcess (  CP_Event_Base &  inEvent  )  [private]
 

void CP_View_Imp_Rich::CommandUpdateStatus (  CP_Event_Base &  inEvent  )  [private]
 

void CP_View_Imp_Rich::Init (  CP_View *  inSuperview,
const CP_Point &  inLocation,
const CP_Size &  inContentSize,
bool  inHasHorizontalScroll = true,
bool  inHasVerticalScroll = true,
bool  inReadOnly = false
)  [private]
 

void CP_View_Imp_Rich::InitEventHandler (  CPLAT::CP_EventHandler &  inEventHandler  )  [private]
 

bool CP_View_Imp_Rich::HandleFieldExitChar (  char  inChar  )  [private]
 

void CP_View_Imp_Rich::TextChanged (   )  [private]
 

DWORD CALLBACK CP_View_Imp_Rich::CP_RichText_StreamInCallback (  DWORD  dwCookie,
LPBYTE  pbBuff,
LONG  cb,
LONG *  pcb
)  [static, private]
 

void CP_View_Imp_Win::Show (   )  [virtual, inherited]
 

Show this view.

Exceptions:
none 
Returns:
void

Reimplemented from CP_View_Imp_Base.

void CP_View_Imp_Win::Hide (   )  [virtual, inherited]
 

Hide this view.

Exceptions:
none 
Returns:
void

Reimplemented from CP_View_Imp_Base.

void CP_View_Imp_Win::Enable (   )  [virtual, inherited]
 

Enable this control.

Exceptions:
none 
Returns:
void

Reimplemented from CP_View_Imp_Base.

void CP_View_Imp_Win::Disable (   )  [virtual, inherited]
 

Disable this control.

Exceptions:
none 
Returns:
void

Reimplemented from CP_View_Imp_Base.

CP_Canvas CP_View_Imp_Win::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_Win::Draw (   )  [virtual, inherited]
 

Reimplemented from CP_View_Imp_Base.

void CP_View_Imp_Win::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.

void CP_View_Imp_Win::FinishDrawing (  CP_Canvas &  drawCanvas  )  [virtual, inherited]
 

Reimplemented from CP_View_Imp_Base.

CP_Rect CP_View_Imp_Win::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.

OSWindow CP_View_Imp_Win::CreateChildWindow (  const CP_String &  inTitle,
const CP_String &  inWindowType,
DWORD  inWindowFlags,
DWORD  inExWindowFlags,
const CP_Point &  inUpperLeft,
const CP_Size &  inSize
)  [inherited]
 

Create the Windows child window that is used to display the contents of this pane.

Parameters:
inTitle Any text displayed by the window.
inWindowType A string describing the type of window to create.
inWindowFlags Flags used to create the Windows child window.
inExWindowFlags Extended flags used to create the Windows child window.
inUpperLeft Upper left location to create the window.
inSize Size to make the child window.
Exceptions:
none 
Returns:
OSWindow Windows child window of this pane.

void CP_View_Imp_Win::CreateWindowsChildWindow (  const CP_Point &  inUpperLeft,
const CP_Size &  inContentSize
)  [inherited]
 

Creates the Windows child HWND that is used to implement this class under Windows. If the user has not changed the default flags used to create the child window, they will be created with the following flags:

  • WS_CHILD | WS_CLIPCHILDREN | WS_CLIPSIBLINGS

Parameters:
inUpperLeft Upper left coordinate of the window in local coordinates.
inContentSize Size of the content area of the view.
Exceptions:
none 
Returns:
void

bool CP_View_Imp_Win::GetIsCustomPane (   )  [inherited]
 

void CP_View_Imp_Win::SetIsCustomPane (  bool  inIsCustomPane  )  [inherited]
 

void CP_View_Imp_Win::InitEventHandler (  CP_EventHandler &  inEventHandler  )  [virtual, inherited]
 

Initialize the event handler data member for this class. This will register the Windows messages that are handled by this class with their respective CP_EventSignal handlers.

Parameters:
inEventHandler The CP_EventHandler that handles the view events.
Exceptions:
none 
Returns:
void

Reimplemented from CP_View_Imp_Base.

Reimplemented in CP_View_Imp_WinToolbar.

LRESULT CP_View_Imp_Win::HandleWinProcMessage (  HWND  hwnd,
UINT  iMsg,
WPARAM  wParam,
LPARAM  lParam
)  [inherited]
 

Handle any Windows specific message for this pane. This is the routine that is called from the windows pane handler. You need override the protected OnHandleWinProcMessage method to handle the specific messages you need to in your class.

This method will catch any exceptions thrown in your methods to prevent propagating into the Windows callback.

Parameters:
hwnd the HWND that the message applies to.
iMsg the incoming message to handle.
wParam the wParam for the message.
lParam the lParam for the message.
Exceptions:
none 
Returns:
LRESULT Returns the result of the operation.

void CP_View_Imp_Win::HandleMouseEnteredEvent (  CP_Event_Base &  inEvent  )  [inherited]
 

void CP_View_Imp_Win::HandleMouseExitedEvent (  CP_Event_Base &  inEvent  )  [inherited]
 

virtual CP_EventHandler& CP_View_Imp_Win::GetEventHandler (   )  [virtual, inherited]
 

Reimplemented from CP_View_Imp_Base.

WNDPROC CP_View_Imp_Win::GetOldWinProc (   )  [inherited]
 

HBRUSH CP_View_Imp_Win::GetBackgroundBrush (   )  [inherited]
 

static CP_View_Imp_Win* CP_View_Imp_Win::GetLastViewWithMouse (   )  [static, inherited]
 

static void CP_View_Imp_Win::SetLastViewWithMouse (  CP_View_Imp_Win *  inView  )  [static, inherited]
 

void CP_View_Imp_Win::Move (  const CP_Point &  inOffset  )  [virtual, inherited]
 

Reimplemented from CP_View_Imp_Base.

void CP_View_Imp_Win::SetOldWinProc (  WNDPROC  inOldWndProc  )  [inherited]
 

Sets the data member and event handler to the passed in Windows window proc that was used in a created child window. This is the previous one that we are subclassing.

Parameters:
inOldWndProc The WNDPROC we are saving.
Exceptions:
none 
Returns:
void

SInt16 CP_View_Imp_Win::GetWinViewID (   )  [inherited]
 

void CP_View_Imp_Win::SetWinViewID (  SInt16  inWinViewID  )  [inherited]
 

bool CP_View_Imp_Win::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_Win::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_Win::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_Win::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.
Exceptions:
none 
Returns:
void

Reimplemented from CP_View_Imp_Base.

void CP_View_Imp_Win::HandleErase (  CP_Event_Base &  inEvent  )  [protected, virtual, inherited]
 

void CP_View_Imp_Win::CreateViewChildWindow (  DWORD  inExWindowFlags,
const CP_Point &  inUpperLeft,
const CP_Size &  inContentSize
)  [protected, inherited]
 

Creates the Windows child window for our view class. This is called by the other methods to create our custom window class used to implmement this class under Windows.

Parameters:
inExWindowFlags Extended flags used in the creation of the window.
inUpperLeft Upper left coordinate of the window in local coordinates.
inContentSize Size of the content area of the view.
Exceptions:
none 
Returns:
void

void CP_View_Imp_Win::RegisterWindowClass (   )  [protected, inherited]
 

Register the window class used for the panes child window with Windows.

Exceptions:
none 
Returns:
void

void CP_View_Imp_Win::SetLocation (  const CP_Point &  inLocation  )  [protected, 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_Win::SetSize (  const CP_Size &  inSize  )  [protected, 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.

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_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]
 

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]
 

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

Reimplemented in CP_View_Imp_Control, CP_View_Imp_ControlScroller, and CP_View_Imp_MLTE.

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::AddSubview (  CP_View_Imp *   )  [virtual, inherited]
 

Reimplemented in CP_View_Imp_Control.

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

Reimplemented in CP_View_Imp_Control.

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]
 

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]
 

Member Data Documentation

CP_KeyInputFilter* CP_View_Imp_Rich::fKeyFilter [protected]
 

CP_DataValueSignal CP_View_Imp_Rich::fFieldExitSignal [protected]
 

CP_EventHandler CP_View_Imp_Win::fEventHandler [protected, inherited]
 

CP_Point CP_View_Imp_Win::fLocation [protected, inherited]
 

Class that handles all of the events for this windnow.

Reimplemented from CP_View_Imp_Base.

UInt32 CP_View_Imp_Win::fWinStyleFlags [protected, inherited]
 

UInt32 CP_View_Imp_Win::fWinExtStyleFlags [protected, inherited]
 

The Windows style flags used to create the pane.

WNDPROC CP_View_Imp_Win::fnOldWndProc [protected, inherited]
 

The Windows extended style flags used to create the pane.

SInt16 CP_View_Imp_Win::fsWinViewID = 0 [static, protected, inherited]
 

The standard Windows window callback. This is the one returned before we set the callback to our panes callback.

bool CP_View_Imp_Win::fIsCustomPane [protected, inherited]
 

View id of this viewe under Windows.

HBRUSH CP_View_Imp_Win::fsBackgroundBrush [static, protected, inherited]
 

Is this view a custom pane, and not a Windows control.

CP_View_Imp_Win * CP_View_Imp_Win::fsLastViewWithMouse = NULL [static, protected, inherited]
 

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_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]
 

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.

The documentation for this class was generated from the following files:
Generated on Sat Sep 17 20:02:27 2005 for CPLAT by  doxygen 1.4.0