CamArtProvider Class Reference

A derived event handler which providers art for bitmap buttons and other controls within Camelot Notes: In the OIL See Also:. More...

#include <cartprov.h>

List of all members.

Public Member Functions
	CamArtProvider ()
	Constructor.
	~CamArtProvider ()
	Destructor.
void	GetBitmapEvent (wxCamArtProviderEvent &event)
	Called when we need to load some art.
void	InvalidateArtEvent (wxCamArtProviderEvent &event)
	Called when we need to load some art.
void	Draw (wxDC &dc, const wxRect &rect, ResourceID Resource, CamArtFlags Flags=CAF_DEFAULT, const wxString &text=wxEmptyString)
	Draws the art into the appropriate DC.
wxSize	GetSize (ResourceID r, CamArtFlags Flags=CAF_DEFAULT, const wxString &text=wxEmptyString)
void	EnsureBitmapLoaded (ResourceID Resource, BOOL SkipArtLoad=FALSE)
	Passes an event to DialogManager::Event.
void	EnsureChildBitmapsLoaded (wxWindow *pWindow=NULL, BOOL SkipArtLoad=FALSE)
	Invalidates every window which has art in it.
void	ReloadAllArt ()
	Reloads all the art.
wxBitmap *	FindBitmap (ResourceID Resource, CamArtFlags Flags=CAF_DEFAULT, BOOL SkipArtLoad=FALSE)
	Finds the cached bitmap with the relevant resource ID & flags.
wxImage *	FindImage (ResourceID Resource, CamArtFlags Flags=CAF_DEFAULT, BOOL SkipArtLoad=FALSE)
	Finds the cached bitmap with the relevant resource ID & flags.
wxImage *	GetMissingImage () const
wxBitmap *	GetMissingBitmap () const
Static Public Member Functions
static BOOL	Init ()
	Initialize the class.
static void	DeInit ()
	Initialize resources.
static CamArtProvider *	Get ()
static CamArtFlags	GetBitmapFlags (const wxString &str)
static wxString	MakeBitmapFlagString (const CamArtFlags flags)
Protected Member Functions
ResIDWithFlagsToBitmapPtr::iterator	Find (ResourceID Resource, CamArtFlags Flags, BOOL SkipArtLoad)
	Finds the cached bitmap with the relevant resource ID & flags.
ResourceIDWithFlags	CombineFlags (ResourceID Resource, CamArtFlags Flags)
CamArtFlags	GetFlags (ResourceIDWithFlags ResWithFlags)
ResourceID	GetResourceID (ResourceIDWithFlags ResWithFlags)
wxImage *	MakeBitmap (ResourceIDWithFlags ResWithFlags)
	Makes a bitmap from the appropraite resource.
void	InvalidateAllArt ()
	Invalidates every window which has art in it.
void	InvalidateAllArtInChildren (wxWindow *pWindow)
	Invalidates every window which has art in it.
void	DeleteHashContents ()
	Delete every hash table entry.
void	ArtLoad (BOOL newbitmaps=FALSE, BOOL defer=TRUE)
	Schedule a GetBitmap event, unless one is already scheduled.
wxSize	GetBorderSize (CamArtFlags Flags=CAF_DEFAULT)
wxString	GetTextInfoOrDraw (ResourceID r, CamArtFlags f, wxDC &dc, BOOL Draw=FALSE, wxCoord *w=NULL, wxCoord *h=NULL, wxCoord x=0, wxCoord y=0, wxCoord MaxWidth=-1, const wxString &text=wxEmptyString)
	Sets up the DC and returns the text.
Static Protected Member Functions
static wxColor	DarkenColour (const wxColor &c, INT32 amount)
	Returns a darkened colour.
static wxColor	LightenColour (const wxColor &c, INT32 amount)
	Returns a lightened colour.
Protected Attributes
ResIDWithFlagsToBitmapPtr *	m_pHash
BOOL	m_GetBitmapEventPending
BOOL	m_InvalidateArtEventPending
wxImage *	m_pMissingImage
wxBitmap *	m_pMissingBitmap
Static Private Attributes
static CamArtProvider *	m_ArtProvider = NULL

---

Detailed Description

A derived event handler which providers art for bitmap buttons and other controls within Camelot Notes: In the OIL See Also:.

Author:

Alex_Bligh <alex@alex.org.uk>

Date:

19/12/2005

This class is specificly written so it will provided cached vector-drawn art.

Definition at line 203 of file cartprov.h.

---

Constructor & Destructor Documentation

CamArtProvider::CamArtProvider (   )

Constructor. Author: Alex_Bligh <alex@alex.org.uk> Date: 30/12/2005 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 142 of file cartprov.cpp. { m_pHash = NULL; m_GetBitmapEventPending = FALSE; m_InvalidateArtEventPending = FALSE; m_pMissingImage = NULL; m_pMissingImage = new wxImage; // if this returns NULL, all missing bitmaps will be blank. Oh well if (m_pMissingImage) CamResource::LoadwxImage(*m_pMissingImage, _T("missing.png") ); if (m_pMissingImage) m_pMissingBitmap=new wxBitmap(*m_pMissingImage, -1); m_pHash = new ResIDWithFlagsToBitmapPtr; // if this returns NULL, Init will whinge, so don't check }

CamArtProvider::~CamArtProvider (   )

Destructor. Author: Alex_Bligh <alex@alex.org.uk> Date: 30/12/2005 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 172 of file cartprov.cpp. { if (m_pHash) { DeleteHashContents(); if (m_pHash) delete m_pHash; m_pHash = NULL; } if (m_pMissingImage) { delete(m_pMissingImage); m_pMissingImage=NULL; } if (m_pMissingBitmap) { delete(m_pMissingBitmap); m_pMissingBitmap=NULL; } }

---

Member Function Documentation

void CamArtProvider::ArtLoad (  BOOL  newbitmaps = FALSE, BOOL  defer = TRUE )  [protected]

Schedule a GetBitmap event, unless one is already scheduled. Author: Alex_Bligh <alex@alex.org.uk> Date: 30/12/2005 Parameters: newbitmaps  - set TRUE if we should forget cache of all bitmaps that were [INPUTS] missing last time. Also causes existing pending event flag to be ignored in case an event got lost (should never happen). defer - set TRUE if the art load is to be deferred -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 347 of file cartprov.cpp. { // If we already have an event pending, don't generate a new one if (m_GetBitmapEventPending && !newbitmaps) return; if (newbitmaps && m_pMissingImage && m_pHash && !m_pHash->empty()) { ResIDWithFlagsToBitmapPtr::iterator current; for( current = m_pHash->begin(); current != m_pHash->end(); ++current ) { // we don't need to worry about memory management as deleting the // bitmaps are CamResource::'s responsibility if (current->second.m_pImage == m_pMissingImage) m_pMissingImage = NULL; // mark as required to be loaded on the event } } // Send ourselves a deferred event m_GetBitmapEventPending = TRUE; wxCamArtProviderEvent event (wxEVT_CAMARTPROVIDER_GETBITMAP, 0, defer); if (defer) AddPendingEvent(event); else ProcessEvent(event); }

ResourceIDWithFlags CamArtProvider::CombineFlags (  ResourceID  Resource, CamArtFlags  Flags )  [inline, protected]

Definition at line 238 of file cartprov.h. { return Resource | (((UINT64)Flags)<<32) ; }

wxColor CamArtProvider::DarkenColour (  const wxColor &  c, INT32  amount )  [static, protected]

Returns a darkened colour. Author: Alex_Bligh <alex@alex.org.uk> Date: 30/12/2005 Parameters: c  - a wxColour [INPUTS] amount - amount to darken it by a  darkened colour [OUTPUTS] Returns: - Errors: - See also: - Definition at line 209 of file cartprov.cpp. { INT32 r = c.Red(), g = c.Green(), b = c.Blue(); return wxColour((r*amount)/100, (g*amount)/100, (b*amount)/100); }

void CamArtProvider::DeInit (  void   )  [static]

Initialize resources. Author: Alex_Bligh <alex@alex.org.uk> Date: 30/12/2005 Parameters: None  [INPUTS] None  [OUTPUTS] Returns: TRUE if succeeded, FALSE if fails Errors: via wxMessageBox See also: - Definition at line 279 of file cartprov.cpp. { if (m_ArtProvider) { delete m_ArtProvider; m_ArtProvider = FALSE; } }

void CamArtProvider::DeleteHashContents (   )  [protected]

Delete every hash table entry. Author: Alex_Bligh <alex@alex.org.uk> Date: 30/12/2005 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Note we don't need to delete the bitmaps themselves - CamResource:: does that. Thus right now this routine does nothing much with the hash contents. Definition at line 307 of file cartprov.cpp. { if (m_pHash) { ResIDWithFlagsToBitmapPtr::iterator current; while (!m_pHash->empty()) { current = m_pHash->begin(); // wxImage * s=current->second.m_pImage; m_pHash->erase(current); // delete s; -- we don't need to do this, CamResource:: does this } // for good measure m_pHash->clear(); delete (m_pHash); m_pHash = NULL; } }

void CamArtProvider::Draw (  wxDC &  dc, const wxRect &  rect, ResourceID  Resource, CamArtFlags  Flags = CAF_DEFAULT, const wxString &  text = wxEmptyString )

Draws the art into the appropriate DC. Author: Alex_Bligh <alex@alex.org.uk> Date: 30/12/2005 Parameters: dc  - the wxDC to draw into [INPUTS] Resource - the ResourceID to load CamArtFlags - the flags to use for drawing InternalBorder - the internal border (in pixels) - see note -  [OUTPUTS] Returns: pointer to a string containing the event number Errors: - See also: - Note that the internal border is the TOTAL internal border (i.e. left plus right). Border pixels will be allocated preferentially on left and top, to right and bottom. Rect should already have been inflated (wxCamArtControl does this by increasing its client area). Definition at line 756 of file cartprov.cpp. { dc.SetBrush(wxSystemSettings::GetColour(wxSYS_COLOUR_3DFACE)); dc.SetPen(*wxTRANSPARENT_PEN); // dc.DrawRectangle(rect.x, rect.y, rect.width, rect.height); // dc.SetBrush(wxSystemSettings::GetColour(wxSYS_COLOUR_3DFACE)); dc.SetBrush(*wxTRANSPARENT_BRUSH); // Needed in case we need to paint 3D furniture, but not the button top (ALWAYS3D) wxRect brect = rect; UINT32 bitmapoffsetX=0; UINT32 bitmapoffsetY=0; if ((Flags & CAF_PUSHBUTTON) && !rect.IsEmpty()) { // 3Dness brect.width-=1; brect.height-=1; if (Flags & CAF_SELECTED) { // It's pushed in brect.x++; brect.y++; } UINT32 InternalBorderX = (Flags & CAF_NOINTERNALBORDER)?0:2; UINT32 InternalBorderY = (Flags & CAF_NOINTERNALBORDER)?0:1; bitmapoffsetX=1+((InternalBorderX+1)>>1); // this is a completely independent offset to the brect stuff, which gives the bitmap a border bitmapoffsetY=1+((InternalBorderY+1)>>1); // this is a completely independent offset to the brect stuff, which gives the bitmap a border // BOOL FaceSelected = ( (Flags & CAF_SELECTED) || (Flags & CAF_BUTTONHOVER) ); // BOOL Border3D = ( (Flags & CAF_SELECTED) || (Flags & CAF_ALWAYS3D)); BOOL FaceSelected = ( (Flags & CAF_SELECTED) || ((Flags & CAF_ALWAYS3D) && (Flags & CAF_BUTTONHOVER)) ); // highlight face on hover if always3D BOOL Border3D = ( (Flags & CAF_SELECTED) || (Flags & CAF_ALWAYS3D) || (Flags & CAF_BUTTONHOVER)); // Change the brush if the face is selected if (FaceSelected) { if (Flags & CAF_TOOLBACKGROUND) dc.SetBrush(wxColour(255,255,192)); // A light yellow - we should load this from somewhere else else { if (Flags & CAF_BUTTONHOVER) dc.SetBrush(wxSystemSettings::GetColour(wxSYS_COLOUR_3DHIGHLIGHT)); else dc.SetBrush(wxSystemSettings::GetColour(wxSYS_COLOUR_BTNFACE)); } } if (Border3D) { // draw the light highlights dc.SetPen(wxSystemSettings::GetColour((Flags & CAF_SELECTED)?wxSYS_COLOUR_3DHIGHLIGHT:wxSYS_COLOUR_3DDKSHADOW)); // draw the background behind the button undisplaced dc.DrawRectangle(rect.x, rect.y, rect.width, rect.height); // now draw the left & top bits dc.SetPen(wxSystemSettings::GetColour((Flags & CAF_SELECTED)?wxSYS_COLOUR_3DDKSHADOW:wxSYS_COLOUR_3DHIGHLIGHT)); dc.DrawLine(rect.x, rect.y, rect.x+rect.width-1, rect.y); dc.DrawLine(rect.x, rect.y, rect.x, rect.y+rect.height-1); } else if (FaceSelected) // if not FaceSelected, we've already drawn it { // draw the background behind the button displaced dc.DrawRectangle(brect.x, brect.y, brect.width, brect.height); } } // Now apply justification to the object wxRect BestSize(GetSize(Resource, Flags, text)); if (BestSize.width != rect.width) { if (Flags & CAF_RIGHT) { bitmapoffsetX += (rect.width-BestSize.width); } else if (Flags & CAF_LEFT) { // do nothing } else { bitmapoffsetX += (rect.width-BestSize.width)/2; } } if (BestSize.height != rect.height) { if (Flags & CAF_BOTTOM) { bitmapoffsetY += (rect.height-BestSize.height); } else if (Flags & CAF_TOP) { // do nothing } else { bitmapoffsetY += (rect.height-BestSize.height)/2; } } if (Flags & CAF_TEXT) { // The max width is the width of the entire control, less the internal border width wxCoord MaxWidth = rect.GetWidth() - GetBorderSize(Flags).GetWidth(); if (MaxWidth<0) MaxWidth=0; wxString ctext = GetTextInfoOrDraw(Resource, Flags, dc, TRUE, NULL, NULL, brect.x+bitmapoffsetX, brect.y+bitmapoffsetY, MaxWidth, text); } else { // Get the bitmap with the correct flags. We here pretend the button is selected if we are // hovering. We can't do this in the control (grrr...) because else by the time the flags get // here we cannot distinguish selection from hover, which means we slab wrongly wxBitmap *pBitmap = FindBitmap(Resource, (CamArtFlags)(Flags|((Flags & CAF_BUTTONHOVER)?CAF_SELECTED:0) )); // plot the bitmap if (pBitmap) dc.DrawBitmap(*pBitmap, brect.x+bitmapoffsetX, brect.y+bitmapoffsetY, TRUE); } }

void CamArtProvider::EnsureBitmapLoaded (  ResourceID  Resource, BOOL  SkipArtLoad = FALSE )

Passes an event to DialogManager::Event. Author: Alex_Bligh <alex@alex.org.uk> Date: 30/12/2005 Parameters: Resource  - the ResourceID of the art to ensure is loaded [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 535 of file cartprov.cpp. { UINT32 f; for (f = 0; f<CAF_CACHE_MAX; f++) { FindBitmap(Resource, (CamArtFlags)f, SkipArtLoad); // Find all the variants of the bitmap, thus ensuring a load } }

void CamArtProvider::EnsureChildBitmapsLoaded (  wxWindow *  pWindow = NULL, BOOL  SkipArtLoad = FALSE )

Invalidates every window which has art in it. Author: Alex_Bligh <alex@alex.org.uk> Date: 30/12/2005 Parameters: event  - the wxEvent [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Note this function should do a broadcast to all, which will allow others to invalidate themselves. Note that we bunch up all the art loading until the end by ensuring that internally we call with SkipArtLoad set. Definition at line 565 of file cartprov.cpp. { if (!pWindow) pWindow = CCamFrame::GetMainFrame(); if (!pWindow) return; // Process this one if ( (pWindow->IsKindOf(CLASSINFO(wxCamArtControl))) && !(((wxCamArtControl*)pWindow)->GetStyle() & wxCACS_TEXT) ) // don't bother finding bitmaps for text ones, as there isn't one! EnsureBitmapLoaded((ResourceID)(pWindow->GetId()), TRUE); // always skip the art load // Now process children if any wxWindowList::Node * pNode = pWindow->GetChildren().GetFirst(); while (pNode) { EnsureChildBitmapsLoaded(pNode->GetData(), TRUE); // Always skip the art load pNode = pNode->GetNext(); } if (!SkipArtLoad) ArtLoad(FALSE, FALSE); return; }

ResIDWithFlagsToBitmapPtr::iterator CamArtProvider::Find (  ResourceID  Resource, CamArtFlags  Flags, BOOL  SkipArtLoad )  [protected]

Finds the cached bitmap with the relevant resource ID & flags. Author: Alex_Bligh <alex@alex.org.uk> Date: 30/12/2005 Parameters: Resource  - the resource ID to find [INPUTS] Flags - the flags to find -  [OUTPUTS] Returns: a pointer to the bitmap that has been foudn Errors: - See also: - may return NULL if there is no default "missing bitmap" that could be loaded Definition at line 634 of file cartprov.cpp. { ResourceIDWithFlags f = CombineFlags(Resource, (CamArtFlags)(Flags & (CAF_CACHE_MAX-1))); if (!m_pHash) return m_pHash->end(); // get the bitmap from the hash ResIDWithFlagsToBitmapPtr::iterator i=m_pHash->find(f); if (i==m_pHash->end()) { // Oh dear, we haven't found an entry. We thus create one and schedule a load ImageAndBitmap IandB; (*m_pHash)[f]=IandB; if (!SkipArtLoad) ArtLoad(FALSE, FALSE); // See if it's appeared i=m_pHash->find(f); } return i; }

wxBitmap * CamArtProvider::FindBitmap (  ResourceID  Resource, CamArtFlags  Flags = CAF_DEFAULT, BOOL  SkipArtLoad = FALSE )

Finds the cached bitmap with the relevant resource ID & flags. Author: Alex_Bligh <alex@alex.org.uk> Date: 30/12/2005 Parameters: Resource  - the resource ID to find [INPUTS] Flags - the flags to find -  [OUTPUTS] Returns: a pointer to the bitmap that has been foudn Errors: - See also: - may return NULL if there is no default "missing bitmap" that could be loaded We look for an image, and if there is an attached bitmap, use that, else make one Definition at line 709 of file cartprov.cpp. { ResIDWithFlagsToBitmapPtr::iterator i=Find(Resource, Flags, SkipArtLoad); if (i==m_pHash->end()) { return m_pMissingBitmap; } wxBitmap *pBitmap = i->second.m_pBitmap; if (pBitmap) return pBitmap; // No bitmap. Do we have an image? wxImage *pImage = i->second.m_pImage; if (!pImage || (pImage==m_pMissingImage)) return m_pMissingBitmap; // OK make a bitmap pBitmap = new wxBitmap(*pImage, -1); // for now, always use screen depth, not least as GDK doesn't support anything except this & 1bpp if (!pBitmap) return m_pMissingBitmap; i->second.m_pBitmap=pBitmap; return pBitmap; }

wxImage * CamArtProvider::FindImage (  ResourceID  Resource, CamArtFlags  Flags = CAF_DEFAULT, BOOL  SkipArtLoad = FALSE )

Finds the cached bitmap with the relevant resource ID & flags. Author: Alex_Bligh <alex@alex.org.uk> Date: 30/12/2005 Parameters: Resource  - the resource ID to find [INPUTS] Flags - the flags to find -  [OUTPUTS] Returns: a pointer to the bitmap that has been foudn Errors: - See also: - may return NULL if there is no default "missing bitmap" that could be loaded Definition at line 675 of file cartprov.cpp. { ResIDWithFlagsToBitmapPtr::iterator i=Find(Resource, Flags, SkipArtLoad); if (i==m_pHash->end()) { return m_pMissingImage; } wxImage *pImage = i->second.m_pImage; return pImage?pImage:m_pMissingImage; }

static CamArtProvider* CamArtProvider::Get (   )  [inline, static]

Definition at line 215 of file cartprov.h. {return m_ArtProvider;}

void CamArtProvider::GetBitmapEvent (  wxCamArtProviderEvent &  event  )

Called when we need to load some art. Author: Alex_Bligh <alex@alex.org.uk> Date: 30/12/2005 Parameters: event  - the wxEvent [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 392 of file cartprov.cpp. { if (m_pHash && !m_pHash->empty()) { BOOL FoundBitmapToLoad = FALSE; ResIDWithFlagsToBitmapPtr::iterator current; for( current = m_pHash->begin(); current != m_pHash->end(); ++current ) { if (!current->second.m_pImage) // we have no blank bitmap { FoundBitmapToLoad = TRUE; // ResourceID r = GetResourceID(current->first); // CamArtFlags f = GetFlags(current->first); // TRACE(_T("Hash for bitmap 0x%x:%d %s"),f,r,CamResource::GetObjectName(r)); wxImage * pBitmap = MakeBitmap(current->first); current->second.m_pImage = pBitmap?pBitmap:m_pMissingImage; } } if (FoundBitmapToLoad) { if (!m_InvalidateArtEventPending) { m_InvalidateArtEventPending = TRUE; BOOL defer=!event.m_deferred; //Defer the invalidate if this is immediate wxCamArtProviderEvent event (wxEVT_CAMARTPROVIDER_INVALIDATEART, 0, defer); if (defer) AddPendingEvent(event); else ProcessEvent(event); } } } m_GetBitmapEventPending=FALSE; }

CamArtFlags CamArtProvider::GetBitmapFlags (  const wxString &  str  )  [static]

Author: Alex_Bligh <alex@alex.org.uk> Date: 24/01/2005 Parameters: str  - sting to look at [INPUTS] None  [OUTPUTS] Returns: Flags associated with a bitmap string Errors: - See also: - Definition at line 1205 of file cartprov.cpp. { wxString ext=CamResource::GetBitmapFlagString(str); return (CamArtFlags)( ((ext.Find('s')>=0)?CAF_SMALL:0) | ((ext.Find('f')>=0)?CAF_FOCUS:0) | ((ext.Find('x')>=0)?CAF_SELECTED:0) | ((ext.Find('g')>=0)?CAF_GREYED:0) | 0); }

wxSize CamArtProvider::GetBorderSize (  CamArtFlags  Flags = CAF_DEFAULT  )  [protected]

Author: Alex_Bligh <alex@alex.org.uk> Date: 25/01/2005 Parameters: Flags  - the flags [INPUTS] -  [OUTPUTS] Returns: The size of the border around the control Errors: - See also: - Note that the internal border is the TOTAL internal border (i.e. left plus right). Border pixels will be allocated preferentially on left and top, to right and bottom. Rect should already have been inflated (wxCamArtControl does this by increasing its client area). Definition at line 946 of file cartprov.cpp. { UINT32 InternalBorderX = (Flags & CAF_NOINTERNALBORDER)?0:2; UINT32 InternalBorderY = (Flags & CAF_NOINTERNALBORDER)?0:1; // 3 extra pixels for push buttons, 2 border (one on each side) and one for push displacement UINT32 extraX=InternalBorderX+3*((Flags & CAF_ALWAYS3D) || (Flags & CAF_PUSHBUTTON)); // 3 or 0 UINT32 extraY=InternalBorderY+3*((Flags & CAF_ALWAYS3D) || (Flags & CAF_PUSHBUTTON)); // 3 or 0 return wxSize(extraX, extraY); }

CamArtFlags CamArtProvider::GetFlags (  ResourceIDWithFlags  ResWithFlags  )  [inline, protected]

Definition at line 239 of file cartprov.h. { return (CamArtFlags)(ResWithFlags>>32); }

wxBitmap* CamArtProvider::GetMissingBitmap (   )  const [inline]

Definition at line 233 of file cartprov.h. {return m_pMissingBitmap;}

wxImage* CamArtProvider::GetMissingImage (   )  const [inline]

Definition at line 232 of file cartprov.h. {return m_pMissingImage;}

ResourceID CamArtProvider::GetResourceID (  ResourceIDWithFlags  ResWithFlags  )  [inline, protected]

Definition at line 240 of file cartprov.h. { return (ResourceID)(ResWithFlags & 0xFFFFFFFF); } // mask unnecessary but for clarity

wxSize CamArtProvider::GetSize (  ResourceID  r, CamArtFlags  Flags = CAF_DEFAULT, const wxString &  text = wxEmptyString )

Author: Alex_Bligh <alex@alex.org.uk> Date: 25/01/2005 Parameters: r  - the resource [INPUTS] Flags - the flags -  [OUTPUTS] Returns: The size of the control Errors: - See also: - Note that the internal border is the TOTAL internal border (i.e. left plus right). Border pixels will be allocated preferentially on left and top, to right and bottom. Rect should already have been inflated (wxCamArtControl does this by increasing its client area). Definition at line 902 of file cartprov.cpp. { wxCoord w=24; wxCoord h=24; if (Flags & CAF_TEXT) { wxScreenDC dc; wxString ctext = GetTextInfoOrDraw(r, Flags, dc, FALSE, &w, &h, 0, 0, -1, text); } else { wxBitmap * pBitmap=FindBitmap(r, Flags); if (pBitmap) { w=pBitmap->GetWidth(); h=pBitmap->GetHeight(); } } wxSize Border=GetBorderSize(Flags); return wxSize(w+Border.GetWidth(), h+Border.GetHeight()); }

wxString CamArtProvider::GetTextInfoOrDraw (  ResourceID  r, CamArtFlags  f, wxDC &  dc, BOOL  Draw = FALSE, wxCoord *  w = NULL, wxCoord *  h = NULL, wxCoord  x = 0, wxCoord  y = 0, wxCoord  MaxWidth = -1, const wxString &  text = wxEmptyString )  [protected]

Sets up the DC and returns the text. Author: Alex_Bligh <alex@alex.org.uk> Date: 24/04/2006 Parameters: r  - the resource [INPUTS] Flags - the flags Draw = TRUE to draw the text x, y - location to draw the text (if Draw is set) MaxWidth - the maximum width or the text (use -1 when calculating for no max width) w,h,pointers  to fill in (can be NULL) for the text extent. Either both or neither must be NULL [OUTPUTS] Returns: The text Errors: - See also: - Definition at line 977 of file cartprov.cpp. { // find the name by looking up the ID as a string const TCHAR * tcname=text; if (w) *w=0; if (h) *h=0; if (text.IsEmpty()) { tcname = CamResource::GetTextFail(r); if (!tcname || ( (tcname[0]==_T('-')) && !tcname[1]) ) { // default to object name tcname = CamResource::GetObjectNameFail(r); } if (!tcname) { // If this goes off, then somehow we've been passed a resource ID without a reverse // bitmap lookup. This can normally only happen if the resource ID is corrupted, or // the resources are corrupted ERROR3_PF(("Cannot get text for resource %d",r)); return wxEmptyString; } } dc.SetTextForeground(wxSystemSettings::GetColour((f & CAF_GREYED)?wxSYS_COLOUR_GRAYTEXT:wxSYS_COLOUR_BTNTEXT)); wxFont font = wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT); font.SetPointSize((f & CAF_HALFHEIGHT)?7:8); dc.SetFont(font); wxString RenderText(tcname); if (!(f & CAF_STATUSBARTEXT)) { if (h && w) dc.GetTextExtent(RenderText, w, h); if (Draw) dc.DrawText(RenderText, x, y); } else { // It's status bar text. We have to go through the tokens individually // First tokenize the string INT32 i=0; wxArrayString Tokens; wxArrayString Separators; wxString SubString=wxEmptyString; INT32 BoldBreak=-1; for (i=0; i<(INT32)(RenderText.Length()); i++) { wxChar c = RenderText[i]; if ( (c==_T(';')) || ((c==_T(':')) && (i<((INT32)RenderText.Length())-1) && (RenderText[i+1]==_T(':')) ) ) { // We found a separator Tokens.Add(SubString); Separators.Add(wxString(c)); // Was it a colon separator? if (c==_T(':')) { // Remember it's now bold up to here BoldBreak=Tokens.GetCount(); // Skip over the second colon i++; } SubString=wxEmptyString; } else SubString+=c; // It's not a separator, add it to the substring } // add the final token if (!SubString.IsEmpty()) { Tokens.Add(SubString); Separators.Add(wxEmptyString); } BOOL Stop = FALSE; wxCoord CumWidth = 0; // The cumulative width used so far wxCoord MaxHeight = 0; // The max height used so far wxFont BoldFont = font; BoldFont.SetWeight(wxFONTWEIGHT_BOLD); for (i=0; i<(INT32)(Tokens.GetCount()) && !Stop; i++) { wxString TextBlob = Tokens[i] + Separators[i]; // Set the font up if (i<BoldBreak) dc.SetFont(BoldFont); else dc.SetFont(font); // Find out how large this blob is wxCoord ww=0; wxCoord hh=0; dc.GetTextExtent(TextBlob, &ww, &hh); // Does it fit (or do we force it to fit because it is the first text) if ((MaxWidth<0) || (i==0) || (CumWidth+ww<=MaxWidth)) { // Draw it if necessary if (Draw) dc.DrawText(TextBlob, x+CumWidth, y); // Account for its width CumWidth+=ww; if (hh>MaxHeight) MaxHeight=hh; } else Stop=TRUE; } if (h) *h = MaxHeight; if (w) *w = CumWidth; } return RenderText; }

BOOL CamArtProvider::Init (  void   )  [static]

Initialize the class. Author: Alex_Bligh <alex@alex.org.uk> Date: 30/12/2005 Parameters: None  [INPUTS] None  [OUTPUTS] Returns: TRUE if succeeded, FALSE if fails Errors: via wxMessageBox See also: - Definition at line 254 of file cartprov.cpp. { ERROR3IF(m_ArtProvider, "Double Init of ArtProvider"); m_ArtProvider=new(CamArtProvider); ERROR2IF(!m_ArtProvider, FALSE, "Cannot get an ArtProvider"); return TRUE; }

void CamArtProvider::InvalidateAllArt (   )  [protected]

Invalidates every window which has art in it. Author: Alex_Bligh <alex@alex.org.uk> Date: 30/12/2005 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Note this function should do a broadcast to all, which will allow others to invalidate themselves. Definition at line 473 of file cartprov.cpp. { wxWindow * pWindow = CCamFrame::GetMainFrame(); if (pWindow) InvalidateAllArtInChildren(pWindow); // Broadcast an art changing message here! }

void CamArtProvider::InvalidateAllArtInChildren (  wxWindow *  pWindow  )  [protected]

Invalidates every window which has art in it. Author: Alex_Bligh <alex@alex.org.uk> Date: 30/12/2005 Parameters: event  - the wxEvent [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Note this function should do a broadcast to all, which will allow others to invalidate themselves. Definition at line 502 of file cartprov.cpp. { // Process this one if (pWindow->IsKindOf(CLASSINFO(wxCamArtControl))) ((wxCamArtControl *)pWindow)->NewBitmap(); // Now process children if any wxWindowList::Node * pNode = pWindow->GetChildren().GetFirst(); while (pNode) { InvalidateAllArtInChildren(pNode->GetData()); pNode = pNode->GetNext(); } return; }

void CamArtProvider::InvalidateArtEvent (  wxCamArtProviderEvent &  event  )

Called when we need to load some art. Author: Alex_Bligh <alex@alex.org.uk> Date: 30/12/2005 Parameters: event  - the wxEvent [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 447 of file cartprov.cpp. { m_InvalidateArtEventPending = FALSE; InvalidateAllArt(); }

wxColor CamArtProvider::LightenColour (  const wxColor &  c, INT32  amount )  [static, protected]

Returns a lightened colour. Author: Alex_Bligh <alex@alex.org.uk> Date: 30/12/2005 Parameters: c  - a wxColour [INPUTS] amount - amount to lighten it by a  lightened colour [OUTPUTS] Returns: - Errors: - See also: - Definition at line 232 of file cartprov.cpp. { INT32 r = 255-c.Red(), g = 255-c.Green(), b = 255-c.Blue(); return wxColour(255-(r*amount)/100, 255-(g*amount)/100, 255-(b*amount)/100); }

wxImage * CamArtProvider::MakeBitmap (  ResourceIDWithFlags  ResWithFlags  )  [protected]

Makes a bitmap from the appropraite resource. Author: Alex_Bligh <alex@alex.org.uk> Date: 30/12/2005 Parameters: ResWithFlags  - the hash key to make a bitmap for (ResourceID combined with flags) [INPUTS] Grey - true if we should grey (in software) the image we find. Don't set this when calling, set CAF_GREYED which will use a greyed preprepared version if available -  [OUTPUTS] Returns: a pointer to the bitmap, or NULL if one could not be made Errors: - See also: - This routine is abstracted to allow an easy switch to vector art. Simlarly, it is only called from the main event loop, so we are safe to muck arround with the current document etc. so we can do a true render. Definition at line 1131 of file cartprov.cpp. { ResourceID r = GetResourceID(ResWithFlags); CamArtFlags f = GetFlags(ResWithFlags); wxImage * pBitmap = NULL; // find the name by looking up the ID as a string const TCHAR * tcname = NULL; /*CamResource::GetTextFail(r);*/ if (!tcname || ( (tcname[0]==_T('-')) && !tcname[1]) ) { // default to object name tcname = CamResource::GetObjectNameFail(r); } if (!tcname) { // If this goes off, then somehow we've been passed a resource ID without a reverse // bitmap lookup. This can normally only happen if the resource ID is corrupted, or // the resources are corrupted ERROR3_PF(("Cannot get bitmap name for resource %d",r)); delete pBitmap; return FALSE; } wxString basename(tcname); wxString resname; // Iterate over all extensions INT32 ext; for (ext=0; ext<(INT32)(CamResource::BitmapExtensions.GetCount()); ext++) { resname=CamResource::MakeBitmapString(basename, MakeBitmapFlagString(f), CamResource::BitmapExtensions[ext]); pBitmap=CamResource::GetCachedBitmap(resname.c_str()); if (pBitmap) return pBitmap; // OK, it didn't work. Try deleting the flags in order and seeing whether // that works. Note each of these will itself try deleting flags. Thus recursively // we work our way down to the base bitmap. #ifdef _DEBUG static INT32 recursion=0; recursion++; ERROR3IF(recursion>16,"Too much recursion in CamArtProvider::MakeBitmap"); #endif if (!pBitmap && (f & CAF_SELECTED)) pBitmap=MakeBitmap(CombineFlags(r, (CamArtFlags)(f & ~CAF_SELECTED))); if (!pBitmap && (f & CAF_FOCUS)) pBitmap=MakeBitmap(CombineFlags(r, (CamArtFlags)(f & ~CAF_FOCUS))); if (!pBitmap && (f & CAF_SMALL)) pBitmap=MakeBitmap(CombineFlags(r, (CamArtFlags)(f & ~CAF_SMALL))); if (!pBitmap && (f & CAF_GREYED)) pBitmap=MakeBitmap(CombineFlags(r, (CamArtFlags)(f & ~CAF_GREYED))); #if _DEBUG recursion--; #endif if (pBitmap) return pBitmap; } return NULL; }

wxString CamArtProvider::MakeBitmapFlagString (  const CamArtFlags  flags  )  [static]

Author: Alex_Bligh <alex@alex.org.uk> Date: 24/01/2005 Parameters: flags  - the flags to look at [INPUTS] None  [OUTPUTS] Returns: Flags string associated with a bitmap Errors: - See also: - Definition at line 1232 of file cartprov.cpp. { wxString mod; if (flags & CAF_SMALL) mod+=_T("s"); if (flags & CAF_FOCUS) mod+=_T("f"); if (flags & CAF_SELECTED) mod+=_T("x"); if (flags & CAF_GREYED) mod+=_T("g"); return mod; }

void CamArtProvider::ReloadAllArt (   )

Reloads all the art. Author: Alex_Bligh <alex@alex.org.uk> Date: 30/12/2005 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 607 of file cartprov.cpp. { m_GetBitmapEventPending=FALSE; // to be sure DeleteHashContents(); EnsureChildBitmapsLoaded(); }

---

Member Data Documentation

CamArtProvider * CamArtProvider::m_ArtProvider = NULL [static, private]

Definition at line 210 of file cartprov.h.

BOOL CamArtProvider::m_GetBitmapEventPending [protected]

Definition at line 256 of file cartprov.h.

BOOL CamArtProvider::m_InvalidateArtEventPending [protected]

Definition at line 257 of file cartprov.h.

ResIDWithFlagsToBitmapPtr* CamArtProvider::m_pHash [protected]

Definition at line 255 of file cartprov.h.

wxBitmap* CamArtProvider::m_pMissingBitmap [protected]

Definition at line 259 of file cartprov.h.

wxImage* CamArtProvider::m_pMissingImage [protected]

Definition at line 258 of file cartprov.h.

---

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

• wxOil/cartprov.h (r1785/r1282)
• wxOil/cartprov.cpp (r1785/r1013)

---