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

CP_IconControl Class Reference
[UI]

Implementation of a platforms icon control. More...

Inheritance diagram for CP_IconControl:

CP_PlatformControl CP_View CP_View_Imp CP_M_SubViewHandler CP_M_Persist CP_M_CommandHandler CP_M_DragSource CP_M_DragTarget CP_Object CP_SigSlot::CP_SlotObject CP_NoCopy List of all members.

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 InitFromOSControl (CP_View *inSuperview, OSControl inOSControl)
virtual void SetForeBackColors ()
virtual LRESULT HandleWinHelperProcMessage (HWND hwnd, UINT iMsg, WPARAM wParam, LPARAM lParam)
void DrawViewHierachy ()
void SetLocationAndSubs (const CP_Point &inLocation)
CP_ViewBackgroundGetViewBackground ()
void SetViewBackground (CP_ViewBackground *inViewBackground)
virtual CP_RGBColor GetBackColor ()
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)
void ClearFlavors ()
virtual void OnDragEnter (LPDATAOBJECT pIDataSource, DWORD grfKeyState, POINTL pt, LPDWORD pdwEffect)
virtual void OnDragLeave ()
void SetTargetWindow (OSWindow inWindow)
virtual void OnDragOver (DWORD grfKeyState, POINTL pt, LPDWORD pdwEffect)
virtual void OnDrop (LPDATAOBJECT pIDataSource, DWORD grfKeyState, POINTL pt, LPDWORD pdwEffect)
CP_Point GetDropPoint ()
Constructor / Destructor
 CP_IconControl ()
 Constructor.
 CP_IconControl (CP_View *inSuperview, const CP_Point &inUpperLeft, const CP_Size &inContentSize, const CP_S_ViewContentInfo &inContentInfo, UInt32 inCommand, bool inDontTrack=true)
virtual ~CP_IconControl () throw ()
 Destructor.
Setters
void SetContent (const CP_S_ViewContentInfo &inContentInfo)
Events
virtual void HandleMouseDown (CP_Event_Base &inEvent)
Slots
virtual void HandleCommandProcess (CP_Event_Base &inEvent)
Slots
virtual void HandleCommandProcess (CP_Event_Base &inEvent)
Events
virtual void HandleMouseDown (CP_Event_Base &inEvent)
virtual void HandleMouseUp (CP_Event_Base &inEvent)

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)
Persistance
static CP_M_PersistPersistCreator ()

Protected Member Functions

virtual void FinishInitFromOSControl (OSControl)
virtual bool OnCanAcceptDrag (UInt32 inItem, CP_DragDrop &inDragDrop)=0
virtual bool PtInDropArea (CP_Point &inGlobalPoint)
virtual void HandleControlColor (CP_Event_Base &inEvent)
virtual bool OnCanAcceptDragWin (LPDATAOBJECT pIDataSource, DWORD grfKeyState, POINTL pt, LPDWORD pdwEffect)
Persistance
virtual void OnInitPersist (CP_View *inSuperview, CP_DataValueList &inDataValueList)
Drawing
virtual void OnDraw (CP_Canvas &inCanvas, CP_Region &inUpdateArea)
Drawing
virtual void OnDraw (CP_Canvas &inCanvas, CP_Region &inUpdateArea)

Protected Attributes

CP_S_ViewContentInfo fContentInfo
UInt32 fCommand
SInt32 fValue
SInt32 fMinimum
SInt32 fMaximum
CP_DataValueSignal fValueChangedSignal
CP_DataValueSignal fClickedSignal
CP_DataValueSlot fSetValueSlot
CP_RGBColor fForeColor
CP_RGBColor fBackColor
bool fIsContainer
OSWindow fToolTipWindow
GtkWidget * fContentAreaContainer
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_IDropSourcefIDropSource
CP_IDataObjectfIDataObject
FORMATETC * fDataFormats
DWORD fNumberFormats
CP_EnumeratorfEnumerator
CP_DataStream fData
CP_WindowfWindow
bool fDropAreaIsHilited
bool fCanAcceptCurrentDrag
OSWindow fTargetWindow
CDropTargetfDropTarget
CP_Point fDropPoint
CP_SubViews_ListfSubViews

Static Protected Attributes

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

Private Member Functions

Initialization
void CreatePlatformImp (CP_View *inSuperview, const CP_Point &inUpperLeft, const CP_Size &inContentSize, UInt32 inCommand, bool inDontTrack=true)
Initialization
void CreatePlatformImp (CP_View *inSuperview, const CP_Point &inUpperLeft, const CP_Size &inContentSize, UInt32 inCommand, bool inDontTrack=true)
Initialization
void CreatePlatformImp (CP_View *inSuperview, const CP_Point &inUpperLeft, const CP_Size &inContentSize, UInt32 inCommand, bool inDontTrack=true)

Detailed Description


Constructor & Destructor Documentation

CPLAT_Begin_Namespace_CPLAT CP_IconControl::CP_IconControl  ) 
 

Constructor.

Exceptions:
none 

CP_IconControl::CP_IconControl CP_View inSuperview,
const CP_Point inUpperLeft,
const CP_Size inContentSize,
const CP_S_ViewContentInfo inContentInfo,
UInt32  inCommand,
bool  inDontTrack = true
 

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

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.
inContentInfo Describes the content of the view.
Exceptions:
none 

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

Destructor.

Exceptions:
none 


Member Function Documentation

CP_M_Persist * CP_IconControl::PersistCreator  )  [static]
 

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_IconControl object.

Reimplemented from CP_View.

void CP_IconControl::SetContent const CP_S_ViewContentInfo inContentInfo  ) 
 

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

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_IconControl::CreatePlatformImp CP_View inSuperview,
const CP_Point inUpperLeft,
const CP_Size inContentSize,
UInt32  inCommand,
bool  inDontTrack = true
[private]
 

Structure used to hold information about the contents of the button.

void CP_IconControl::HandleMouseDown CP_Event_Base inEvent  )  [virtual]
 

Reimplemented from CP_View_Imp.

void CP_IconControl::HandleCommandProcess CP_Event_Base inEvent  )  [virtual]
 

Reimplemented from CP_PlatformControl.

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

Reimplemented from CP_View_Imp.

void CP_IconControl::CreatePlatformImp CP_View inSuperview,
const CP_Point inUpperLeft,
const CP_Size inContentSize,
UInt32  inCommand,
bool  inDontTrack = true
[private]
 

virtual void CP_IconControl::HandleCommandProcess CP_Event_Base inEvent  )  [virtual]
 

Reimplemented from CP_PlatformControl.

virtual void CP_IconControl::HandleMouseDown CP_Event_Base inEvent  )  [virtual]
 

Reimplemented from CP_View_Imp.

void CP_IconControl::HandleMouseUp CP_Event_Base inEvent  )  [virtual]
 

Reimplemented from CP_View_Imp.

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

Reimplemented from CP_View_Imp.

void CP_IconControl::CreatePlatformImp CP_View inSuperview,
const CP_Point inUpperLeft,
const CP_Size inContentSize,
UInt32  inCommand,
bool  inDontTrack = true
[private]
 

OSControl CP_PlatformControl::GetOSControl  )  [inherited]
 

Returns the underlying platforms native OS control that provides the interface between CPLAT and the underlying OS.

Returns:
OSControl The platforms native OS control for this pane.
Exceptions:
none 

Reimplemented from CP_View.

void CP_PlatformControl::SendValueChangedSignal SInt32  inValue  )  [inherited]
 

void CP_PlatformControl::SetValueSlot CP_DataValueHolder inValue,
OSStatus inOutStatus
[inherited]
 

Reimplemented in CP_EditField.

void CP_PlatformControl::SetCommand UInt32  inCommand  )  [inherited]
 

Sets the commannd associated with this control.

Parameters:
inCommand The commannd associated with this control.
Exceptions:
none 
Returns:
void

void CP_PlatformControl::SetFontSpec CP_FontSpec inFontSpec  )  [virtual, inherited]
 

Reimplemented in CP_StaticText.

void CP_PlatformControl::SetTitle const CP_String inText  )  [virtual, inherited]
 

Sets the title or text of the control.

Parameters:
inText The title or text for the control. Some controls, such as text fields use the title to represent the actual text of the control.
Exceptions:
none 
Returns:
void

Reimplemented in CP_StaticText.

SInt32 CP_PlatformControl::GetValue  )  [virtual, inherited]
 

Returns the current value of this control.

Exceptions:
none 
Returns:
SInt32 Current value of the control.

Reimplemented in CP_EditField, CP_ProgressBar, CP_ScrollBar, and CP_Slider.

void CP_PlatformControl::SetValue SInt32  inValue  )  [virtual, inherited]
 

Sets the current value of this control.

Parameters:
inValue The value of the control.
Exceptions:
none 
Returns:
void

Reimplemented in CP_CheckBox, CP_EditField, CP_PopupMenu, CP_ProgressBar, CP_RadioButton, CP_RadioGroup, CP_RadioGroup, CP_ScrollBar, CP_Slider, CP_StaticText, and CP_TabView.

SInt32 CP_PlatformControl::GetMin  )  [virtual, inherited]
 

Returns the minimum value allowed for this control.

Exceptions:
none 
Returns:
SInt32 const Minimum value allowed for this control.

Reimplemented in CP_ProgressBar, CP_ScrollBar, and CP_Slider.

void CP_PlatformControl::SetMin SInt32  inValue  )  [virtual, inherited]
 

Sets the minimum value allowed for this control.

Parameters:
inValue The minimum value allowed.
Exceptions:
none 
Returns:
void

Reimplemented in CP_ProgressBar, CP_ScrollBar, and CP_Slider.

SInt32 CP_PlatformControl::GetMax  )  [virtual, inherited]
 

Returns the maximum value allowed for this control.

Exceptions:
none 
Returns:
SInt32 const Maximum value allowed for this control.

Reimplemented in CP_ProgressBar, CP_ScrollBar, and CP_Slider.

void CP_PlatformControl::SetMax SInt32  inValue  )  [virtual, inherited]
 

Sets the maximum value allowed for this control.

Parameters:
inValue The maximum value allowed.
Exceptions:
none 
Returns:
void

Reimplemented in CP_ProgressBar, CP_ScrollBar, and CP_Slider.

void CP_PlatformControl::InitEventHandler CP_EventHandler inEventHandler  )  [protected, virtual, inherited]
 

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

Reimplemented in CP_BevelButton, CP_ChasingArrows, CP_DisclosureButton, CP_DisclosureTriangle, CP_EditField, CP_LittleArrows, CP_PopupButton, CP_PopupMenu, CP_ProgressBar, CP_PushButton, CP_RadioGroup, CP_ScrollBar, CP_SearchField, CP_SegmentView, CP_Slider, CP_TableHeaders, CP_TabView, CP_TextGroupBox, and CP_WindowListHeader.

void CP_PlatformControl::GetControlDataTag SInt16  inPartCode,
FourCharCode  inDataTag,
Size  inDataSize,
void *  inData,
Size *  outDataSize
const [inherited]
 

Gets some data for the MacOS platform control.

Parameters:
inPartCode Part code of the control that the data applies to.
inDataTag The identifier for the data being received.
inDataSize The size of the data being passed in inData parameter.
inData Pointer to the location of the returned data.
outDataSize Actual size of the data returned.
Exceptions:
CP_OSErrorException or CP_MemoryException upon memFullErr
Returns:
void

void CP_PlatformControl::SetControlDataTag SInt16  inPartCode,
FourCharCode  inDataTag,
Size  inDataSize,
void *  inData
[inherited]
 

Sets some data for the MacOS platform control.

Parameters:
inPartCode Part code of the control that the data applies to.
inDataTag The identifier for the data being set.
inDataSize The size of the data being passed in inData parameter.
inData Pointer to the data being set.
Exceptions:
CP_OSErrorException or CP_MemoryException upon memFullErr
Returns:
void

void CP_View::Show  )  [virtual, inherited]
 

Show this view.

Exceptions:
none 
Returns:
void

Reimplemented from CP_View_Imp.

Reimplemented in CP_Window_Imp, CP_Window_Imp, CP_DrawerWindow, CP_QT_MovieView, CP_SheetWindow, CP_TabView, CP_Window, and CP_Window_Imp.

void CP_View::Hide  )  [virtual, inherited]
 

Hide this view.

Exceptions:
none 
Returns:
void

Reimplemented from CP_View_Imp.

Reimplemented in CP_Window_Imp, CP_Window_Imp, CP_DrawerWindow, CP_QT_MovieView, CP_SheetWindow, CP_TabView, CP_Window, and CP_Window_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.

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

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

Sets the location of this view relative to its superview.

Parameters:
inLocation Location of the view, releative to its containing or superview.
Exceptions:
none 
Returns:
void

Reimplemented from CP_View_Imp.

Reimplemented in CP_Window_Imp, and CP_Window.

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

Sets the size of this view.

Parameters:
inSize The size of the view.
Exceptions:
none 
Returns:
void

Reimplemented from CP_View_Imp.

Reimplemented in CP_Window_Imp, and CP_Window.

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::IsVisible  )  const [virtual, inherited]
 

Returns true if this view is visible.

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

Reimplemented from CP_View_Imp.

Reimplemented in CP_Window_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.

Reimplemented in CP_Window_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::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.

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.

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

LRESULT CP_View::HandleWinHelperProcMessage HWND  hwnd,
UINT  iMsg,
WPARAM  wParam,
LPARAM  lParam
[virtual, 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.
wPa ram the wParam for the message.
lParam the lParam for the message.
Exceptions:
none 
Returns:
LRESULT Returns the result of the operation.

Reimplemented in CP_CheckGroupBox.

void CP_View::DrawViewHierachy  )  [inherited]
 

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

GtkWidget* CP_View::GetContentAreaContainer  )  [inherited]
 

Reimplemented in CP_Window_Imp.

void CP_View::SetContentAreaContainer GtkWidget *  inContentAreaContainer  )  [inherited]
 

Reimplemented in CP_Window_Imp.

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

Converts the passed in point from global to port coordinates.

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

Reimplemented in CP_Window_Imp.

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::PortToGlobal CP_Point inPortPoint  )  [virtual, inherited]
 

Reimplemented in CP_Window_Imp.

void CP_View_Imp::PortToGlobal CP_Rect inPortRect  )  [virtual, inherited]
 

Reimplemented in CP_Window_Imp.

void CP_View_Imp::LocalToPort CP_Point inPortPoint  )  [inherited]
 

void CP_View_Imp::LocalToPort CP_Rect inPortRect  )  [inherited]
 

void CP_View_Imp::GetData UInt32  inTagName,
SInt32  inDataSize,
void *  inData
[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 in CP_Window_Imp.

HRESULT CP_M_DragSource::GetData LPFORMATETC  lpfe,
LPSTGMEDIUM  lpstg
[inherited]
 

GetData method. Caller is asking if we can supply data in a given format and medium. Subclasses should override the OnGetData method to return the data.

Parameters:
lpfe Pointer to a FORMATETC structure.
lpstg Pointer to a STGMEDIUM structure.
Exceptions:
none 
Returns:
HRESULT

void CP_View_Imp::SetData UInt32  inTagName,
SInt32  inDataSize,
const void *  inData
[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 in CP_Window_Imp.

HRESULT CP_M_DragSource::SetData LPFORMATETC  lpfe,
STGMEDIUM *  lpst,
BOOL  fRelease
[inherited]
 

SetData method. Calls OnSetData which you should override if needed.

Parameters:
lpfe Pointer to a FORMATETC structure.
lpstg Pointer to a STGMEDIUM structure.
fRelease Flag to indicate if the data is to be released.
Exceptions:
none 
Returns:
HRESULT

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.

Reimplemented in CP_Window_Imp, CP_MDIFrameWindow, and CP_Window_Imp.

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

Return the CP_Window that contains this pane.

Exceptions:
none 
Returns:
CP_Window * Returns the window this pane is contained in.

Reimplemented in CP_Window.

CP_View * CP_View_Imp::GetSuperview  )  [inherited]
 

Return the superview of this view.

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

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

Reimplemented in CP_Window_Imp, and CP_Window_Imp.

CP_Rect CP_View_Imp::GetPortBounds  )  [virtual, inherited]
 

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

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

Reimplemented in CP_Window_Imp, and CP_Window_Imp.

CP_Rect CP_View_Imp::GetContentBounds  )  [virtual, inherited]
 

Reimplemented in CP_Window_Imp, and CP_Scroller.

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

Return the location of this pane. This is the panes location relative its superviews top left corner.

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

Reimplemented in CP_Window_Imp.

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

Return the size of this pane.

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

Reimplemented in CP_Window_Imp, and CP_Window_Imp.

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

void CP_View_Imp::Refresh  )  [virtual, inherited]
 

Cause the view to redraw itself on the next chance it gets. This will mark the view as dirty, and redraw itself the next time the underlying OS updates dirty views. If used in a loop, the view will not be redrawn untill the underlying OS can process an event.

Exceptions:
none 
Returns:
void

Reimplemented in CP_Window_Imp.

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::SetPortBounds const CP_Rect inBounds  )  [virtual, inherited]
 

Sets the bounds of this view in port coordinates.

Parameters:
inBounds Bounds of the view in port coordinates.
Exceptions:
none 
Returns:
void

Reimplemented in CP_Window_Imp.

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

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

Linux - Returns true if this view supports drag and drop. This default implementation just returns true if the CP_E_ViewFlags_SupportsDragAndDrop is set, and does not check the contents of the drag and drop. Users should override this to perform a check on the contents of the drag and drop to determine if an item is acceptable.

Parameters:
inItem Index of the item to check.
inDragDrop CP_DragDrop object that is handling this drag and drop.
Exceptions:
none 
Returns:
bool Returns true if the view flags support drag and drop.

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.

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

Slot to disable a view.

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.

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.

CP_RGBColor CP_View_Imp::GetBackColor  )  [virtual, inherited]
 

Windows - Returns the background color of this view. The default is to return white. Other views that have a colored background will return the controls color for that view.

Exceptions:
none 
Returns:
CP_RGBColor The color of this views background.

Reimplemented in CP_TabView, and CP_Window.

void CP_View_Imp::HandleControlColor CP_Event_Base inEvent  )  [protected, virtual, inherited]
 

Windows - Handles the Windows control color event to setup and return an HBRUSH that corresponds to the correct background color to use.

Parameters:
inEvent The control color event where the result is returned in.
Exceptions:
none 
Returns:
void

Reimplemented in CP_EditField.

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

CP_IDropSource* CP_M_DragSource::GetIDropSource  )  [inherited]
 

Return the CP_IDropSource object for the Windows OLE IDropSource interface .

CP_IDataObject* CP_M_DragSource::GetIDataObject  )  [inherited]
 

Return the CP_IDataObject object for the Windows OLE IDataObject interface .

HRESULT CP_M_DragSource::GetDataHere LPFORMATETC  lpfe,
LPSTGMEDIUM  lpst
[inherited]
 

GetDataHere method.

Parameters:
lpfe Pointer to a FORMATETC structure.
lpstg Pointer to a STGMEDIUM structure.
Exceptions:
none 
Returns:
HRESULT

HRESULT CP_M_DragSource::EnumFormatEtc DWORD  dwDir,
LPENUMFORMATETC *  lpEnum
[inherited]
 

Return a FORMATETC enumerator object to enumerate over the types of formats we supply.

Parameters:
dwDir Not used.
lpEnum Pointer to a ENUMFORMATEC structure.
Exceptions:
none 
Returns:
HRESULT

HRESULT CP_M_DragSource::GetCanonicalFormatEtc LPFORMATETC  lpout,
LPFORMATETC  lpin
[inherited]
 

GetCanonicalFormatEtc method.

Parameters:
lpfe Pointer to a FORMATETC structure.
lpstg Pointer to a STGMEDIUM structure.
Exceptions:
none 
Returns:
HRESULT

HRESULT CP_M_DragSource::QueryGetData LPFORMATETC  lpfe  )  [inherited]
 

Caller is asking for data in a specified format.

Parameters:
lpfe Pointer to a FORMATETC structure.
Exceptions:
none 
Returns:
HRESULT

HRESULT CP_M_DragSource::DAdvise FORMATETC *  lpfe,
DWORD  dw,
LPADVISESINK  lpas,
DWORD FAR *  lpdw
[inherited]
 

DAdvise method. Calls OnDAdvise which you should override if needed.

Parameters:
lpfe Pointer to a FORMATETC structure.
Exceptions:
none 
Returns:
HRESULT

HRESULT CP_M_DragSource::DUnadvise DWORD  dw  )  [inherited]
 

DAdvise method. Calls OnDUnadvise which you should override if needed.

Exceptions:
none 
Returns:
HRESULT

HRESULT CP_M_DragSource::EnumDAdvise LPENUMSTATDATA *  lpen  )  [inherited]
 

DAdvise method. Calls OnEnumDAdvise which you should override if needed.

Exceptions:
none 
Returns:
HRESULT

void CP_M_DragSource::ClearFlavors  )  [inherited]
 

Empty the list of data flavors currently being stored.

Exceptions:
none 
Returns:
void

HRESULT CP_M_DragSource::OnGetData LPFORMATETC  lpfe,
LPSTGMEDIUM  lpstg
[protected, virtual, inherited]
 

GetData Method. Caller is asking if we can supply data in a given format and medium. If your data is in a format other than kCP_E_ClipboardFormat_DataStream you need to override this to provide your data.

Parameters:
lpfe Pointer to a FORMATETC structure.
lpstg Pointer to a STGMEDIUM structure.
Exceptions:
none 
Returns:
HRESULT

HRESULT CP_M_DragSource::OnQueryGetData LPFORMATETC  lpfe  )  [protected, virtual, inherited]
 

GetData Method. Caller is asking if we can supply data in a given format. If your data is in a format other than kCP_E_ClipboardFormat_DataStream you need to override this to provide your data.

Parameters:
lpfe Pointer to a FORMATETC structure.
Exceptions:
none 
Returns:
HRESULT

HRESULT CP_M_DragSource::OnGetDataHere LPFORMATETC  lpfe,
LPSTGMEDIUM  lpst
[protected, virtual, inherited]
 

OnGetDataHere method. Returns E_NOTIMPL. Subclasses need to override if they implement.

Exceptions:
none 
Returns:
HRESULT

HRESULT CP_M_DragSource::OnGetCanonicalFormatEtc LPFORMATETC  lpout,
LPFORMATETC  lpin
[protected, virtual, inherited]
 

OnGetCanonicalFormatEtc method. Returns E_NOTIMPL. Subclasses need to override if they implement.

Exceptions:
none 
Returns:
HRESULT

HRESULT CP_M_DragSource::OnSetData LPFORMATETC  lpfe,
STGMEDIUM *  lpst,
BOOL  fRelease
[protected, virtual, inherited]
 

OnSetData method. Returns E_NOTIMPL. Subclasses need to override if they implement.

Exceptions:
none 
Returns:
HRESULT

HRESULT CP_M_DragSource::OnDAdvise FORMATETC *  lpfe,
DWORD  dw,
LPADVISESINK  lpas,
DWORD FAR *  lpdw
[protected, virtual, inherited]
 

OnDAdvise method. Returns E_NOTIMPL. Subclasses need to override if they implement.

Exceptions:
none 
Returns:
HRESULT

HRESULT CP_M_DragSource::OnDUnadvise DWORD  dw  )  [protected, virtual, inherited]
 

OnDUnadvise method. Returns E_NOTIMPL. Subclasses need to override if they implement.

Exceptions:
none 
Returns:
HRESULT

HRESULT CP_M_DragSource::OnEnumDAdvise LPENUMSTATDATA *  lpen  )  [protected, virtual, inherited]
 

OnEnumDAdvise method. Returns E_NOTIMPL. Subclasses need to override if they implement.

Exceptions:
none 
Returns:
HRESULT

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 

bool CP_M_DragTarget::CanAcceptDrag CP_DragDrop inDragDrop  )  [inherited]
 

Screen location where drop occurred.

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

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::OnDragEnter LPDATAOBJECT  pIDataSource,
DWORD  grfKeyState,
POINTL  pt,
LPDWORD  pdwEffect
[virtual, inherited]
 

Called when we are entering a new drag target.

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::OnDragLeave  )  [virtual, inherited]
 

Called when we leave the current target.

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_DragTarget::SetTargetWindow OSWindow  inWindow  )  [inherited]
 

Register a Windows HWND as a possible target for dropping objects onto.

Parameters:
inWindow - the Windows HWND that is to be the target.

void CP_M_DragTarget::OnDragOver DWORD  grfKeyState,
POINTL  pt,
LPDWORD  pdwEffect
[virtual, inherited]
 

Called while we are dragging over the target object.

void CP_M_DragTarget::OnDrop LPDATAOBJECT  pIDataSource,
DWORD  grfKeyState,
POINTL  pt,
LPDWORD  pdwEffect
[virtual, inherited]
 

Called when the data is dropped onto the target object. Subclasses need to override this method.

CP_Point CP_M_DragTarget::GetDropPoint  )  [inherited]
 

bool CP_M_DragTarget::OnCanAcceptDragWin LPDATAOBJECT  pIDataSource,
DWORD  grfKeyState,
POINTL  pt,
LPDWORD  pdwEffect
[protected, virtual, inherited]
 

Return true if this object can accept the dropped data. Subclasses need to override.

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


Member Data Documentation

CP_S_ViewContentInfo CP_IconControl::fContentInfo [protected]
 

UInt32 CP_PlatformControl::fCommand [protected, inherited]
 

SInt32 CP_PlatformControl::fValue [protected, inherited]
 

The command sent when the control is clicked.

SInt32 CP_PlatformControl::fMinimum [protected, inherited]
 

SInt32 CP_PlatformControl::fMaximum [protected, inherited]
 

CP_DataValueSignal CP_PlatformControl::fValueChangedSignal [protected, inherited]
 

CP_DataValueSignal CP_PlatformControl::fClickedSignal [protected, inherited]
 

Signal sent when the value changes.

CP_DataValueSlot CP_PlatformControl::fSetValueSlot [protected, inherited]
 

Signal sent when the control is clicked.

CP_RGBColor CP_PlatformControl::fForeColor [protected, inherited]
 

CP_RGBColor CP_PlatformControl::fBackColor [protected, inherited]
 

bool CP_View::fIsContainer [protected, inherited]
 

OSWindow CP_View::fToolTipWindow [protected, inherited]
 

GtkWidget* CP_View::fContentAreaContainer [protected, inherited]
 

Reimplemented in CP_Window_Imp.

CP_Point CP_View::fPrintLocation [protected, inherited]
 

Gtk container widget that all subviews are contained in for this view.

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]
 

CP_IDropSource* CP_M_DragSource::fIDropSource [protected, inherited]
 

CP_IDataObject* CP_M_DragSource::fIDataObject [protected, inherited]
 

Windows OLE IDropSource interface object.

FORMATETC* CP_M_DragSource::fDataFormats [protected, inherited]
 

Windows OLE IDataObject interface object.

DWORD CP_M_DragSource::fNumberFormats [protected, inherited]
 

Array of FORMATETC structure with desired formats.

CP_Enumerator* CP_M_DragSource::fEnumerator [protected, inherited]
 

Number of FORMATETC structures.

CP_DataStream CP_M_DragSource::fData [protected, inherited]
 

CP_Enumerator object.

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]
 

OSWindow CP_M_DragTarget::fTargetWindow [protected, inherited]
 

CDropTarget* CP_M_DragTarget::fDropTarget [protected, inherited]
 

Windows HWND for the target.

CP_Point CP_M_DragTarget::fDropPoint [protected, inherited]
 

OLE drop target interface object.

CP_SubViews_List* CP_M_SubViewHandler::fSubViews [protected, inherited]
 


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