CascadeVesselPanel Class Reference

#include <CascadeVesselPanel.h>

Inheritance diagram for CascadeVesselPanel:

List of all members.

Public Types
typedef void()	ActiveVesselChangeCallback (const Vessel *newActiveVessel, void *pClientData)
typedef void()	VesselInsertedCallback (const Vessel *newActiveVessel, void *pClientData)
typedef void()	VesselRemovedCallback (const CascadeString &vesselMountPath, void *pClientData)
Public Member Functions
	CascadeVesselPanel ()
virtual	~CascadeVesselPanel ()
void	SetAcquireGraphicsOnPaint (bool bAcquireOnPaint)
void	RegisterActiveVesselChangeCallback (ActiveVesselChangeCallback *pCallback, void *pClientData)
void	RegisterVesselWorkingPathChangeCallback (ActiveVesselChangeCallback *pCallback, void *pClientData)
void	RegisterVesselInsertedCallback (VesselInsertedCallback *pCallback, void *pClientData)
void	RegisterVesselRemovedCallback (VesselRemovedCallback *pCallback, void *pClientData)
void	OnMountMessage (const CascadeMountMessage &mountMessage)
Vessel *	GetActiveVessel ()
u8	GetActiveVesselIndex ()
Vessel *	GetVesselAt (u8 index)
bool	SetActiveVessel (Vessel *pVessel, bool bNotify=true)
bool	SetActiveVessel (CascadeString path, bool bNotify=true)
bool	SetActiveVessel (u32 idx, bool bFullRepaint, bool bNotify=true)
u8	GetNumVessels ()
void	LookForMountedVessels (bool bScanVessels=false)
void	RemoveAllVessels ()
Vessel *	AddVessel (CascadeMountMessage::MediaType type, CascadeString name, CascadeString path)
Vessel *	AddVessel (Vessel *pVessel)
bool	RemoveVessel (CascadeString path)
void	ScanVessel (Vessel *pV)
virtual bool	OnKeyDown (u32 nKey)
virtual void	OnPaint (CascadeBitmap &bitmap)
virtual bool	OnNavKey (u32 nKey, CascadeWindow *&pProposedNewFocusWnd)
virtual bool	WillAcceptFocus ()
Classes
class	Slot

---

Member Typedef Documentation

typedef void() CascadeVesselPanel::ActiveVesselChangeCallback(const Vessel *newActiveVessel, void *pClientData)

typedef void() CascadeVesselPanel::VesselInsertedCallback(const Vessel *newActiveVessel, void *pClientData)

typedef void() CascadeVesselPanel::VesselRemovedCallback(const CascadeString &vesselMountPath, void *pClientData)

---

Constructor & Destructor Documentation

CascadeVesselPanel::CascadeVesselPanel (   )

virtual CascadeVesselPanel::~CascadeVesselPanel (   )  [virtual]

---

Member Function Documentation

Vessel* CascadeVesselPanel::AddVessel (  Vessel *  pVessel  )

Vessel* CascadeVesselPanel::AddVessel (  CascadeMountMessage::MediaType  type, CascadeString  name, CascadeString  path )

Vessel* CascadeVesselPanel::GetActiveVessel (   )

u8 CascadeVesselPanel::GetActiveVesselIndex (   )  [inline]

u8 CascadeVesselPanel::GetNumVessels (   )  [inline]

Vessel* CascadeVesselPanel::GetVesselAt (  u8  index  )

void CascadeVesselPanel::LookForMountedVessels (  bool  bScanVessels = false  )

virtual bool CascadeVesselPanel::OnKeyDown (  u32  nKey  )  [virtual]

called to handle a key down CK_KEY message OnKeyDown() gets called to handle a key down message. return true to indicate you have processed the message; false to allow the message to continue to be dispatched. NOTE that navigation keys (CK_NORTH, etc.) do not get dispatched to OnKeyDown(), they get dispatched to OnNavKey(). Parameters: nKey  the CK_KEY being notified Returns: true to prevent further message processing, false to allow it See also: OnKeyUp() CascadeApp Reimplemented from CascadeWindow.

void CascadeVesselPanel::OnMountMessage (  const CascadeMountMessage &  mountMessage  )

virtual bool CascadeVesselPanel::OnNavKey (  u32  nKey, CascadeWindow *&  pProposedNewFocusWnd )  [virtual]

called to handle a navigation key message OnNavKey() gets called to handle a navigation key message. pProposedNewFocusWnd is the proposed new focus window. Clients who override this function may examine pProposedNewFocusWnd and change it if they want. OnNavKey() will be successively be called on a window and its parents until someone returns true, indicating they wish message dispatch to stop. At that point the pProposedNewFocusWnd (if non-NULL) will be set as the new focus window. The base class implementation returns false to allow its parent a chance to change the pProposedNewFocusWnd. If at the end of this business, pProposedNewFocusWnd doesn't point to a new focus window, then the focus will not change and the nav key will get dispatched to your CascadeApp's OnKeyDown() handler. Parameters: nKey  the navigation key being processed pProposedNewFocusWnd  a settable pointer to the proposed new focus window Returns: true to prevent further message processing, false to allow it See also: CascadeApp Reimplemented from CascadeWindow.

virtual void CascadeVesselPanel::OnPaint (  CascadeBitmap &  bitmap  )  [virtual]

Called to instruct this window to paint OnPaint() is called by the Cascade Windowing system to instruct your window to paint (on the bitmap passed in). Higher system performance will result if you manually clip your painting to the bitmap's clipRect (bitmap.GetClipRect()), though this is not required. It IS required to manually clip your painting to the window's absolute rect (since the graphics library doesn't yet support clipping). OnPaint() will only be called by the Cascade windowing system if some portion of the window's absolute rect intersects with the bitmap's clipRect. clients can manually call OnPaint to instruct the window to paint to an arbitrary bitmap outside of the context of the Cascade windowing system. Note that OnPaint() is a paint handling function for a single window. To cause a window and all of its child windows to paint, call PaintTree() instead. Note: Windows are themselves responsible for determining if they are the active window with input focus and rendering appropriately. Parameters: bitmap  The bitmap to paint onto See also: OnPaint() CascadeBitmap Reimplemented from CascadeWindow.

void CascadeVesselPanel::RegisterActiveVesselChangeCallback (  ActiveVesselChangeCallback *  pCallback, void *  pClientData )

void CascadeVesselPanel::RegisterVesselInsertedCallback (  VesselInsertedCallback *  pCallback, void *  pClientData )

void CascadeVesselPanel::RegisterVesselRemovedCallback (  VesselRemovedCallback *  pCallback, void *  pClientData )

void CascadeVesselPanel::RegisterVesselWorkingPathChangeCallback (  ActiveVesselChangeCallback *  pCallback, void *  pClientData )

void CascadeVesselPanel::RemoveAllVessels (   )

bool CascadeVesselPanel::RemoveVessel (  CascadeString  path  )

void CascadeVesselPanel::ScanVessel (  Vessel *  pV  )

void CascadeVesselPanel::SetAcquireGraphicsOnPaint (  bool  bAcquireOnPaint  )  [inline]

bool CascadeVesselPanel::SetActiveVessel (  u32  idx, bool  bFullRepaint, bool  bNotify = true )

bool CascadeVesselPanel::SetActiveVessel (  CascadeString  path, bool  bNotify = true )

bool CascadeVesselPanel::SetActiveVessel (  Vessel *  pVessel, bool  bNotify = true )

virtual bool CascadeVesselPanel::WillAcceptFocus (   )  [inline, virtual]

by default CascadeWidgets will accept input focus unless they are disabled WillAcceptFocus() is overridden so that the default behavior for CascadeWidget derived classes is to only accept focus if they are not disabled. Returns: whether or not the widget will accept the focus Reimplemented from CascadeWidget.

---

The documentation for this class was generated from the following file:

• CascadeVesselPanel.h

---