FontDropDown Class Reference

FontDropDown class itself. More...

#include <fontdrop.h>

Inheritance diagram for FontDropDown:

List of all members.

Public Member Functions
	FontDropDown ()
	Default constructor for FontDropDown Class... Notes: If you mistakenly replace the F with a D you get a great song title...
virtual	~FontDropDown ()
	Default destructor for FontDropDown Class... Notes: If you mistakenly replace the F with a D you get a great song title...
virtual BOOL	Init (CWindowID ParentWindow, CGadgetID ParentControl)
	FontDropDown initialiser.
void	KillList (void)
	Kills all the items in the drop down and deletes them...
BOOL	AddFontToList (TCHAR *FontName, FontClass Type)
	Called for each font installed on the system. Effectively creates the FontPullDown items from the given info.
BOOL	FillInFontList ()
	"Fills in" the attached control with appropriate entries for the current FontDropDown settings
BOOL	SetTopFontName (StringBase *StrValue, FontClass Type, BOOL Deselect=TRUE)
	Changes the string and bmp in the icon above the font pull down to reflect whatever you give it...
BOOL	SetSelection (FontDropItem *TheFont)
	To set the selected item in the list.
FontDropItem *	DecodeSelection (INT32 SelectionIndex)
	Decodes an index in the dropdown list back into a font.
Public Attributes
List	Fonts
BOOL	m_MissingItemAdded
FontDropItem	TheTopItem
Static Public Attributes
static void *	CurrentFontDropDown = 0
Protected Member Functions
virtual BOOL	HasIcon (void *ItemData)
	Determine if an item needs an icon next to it.
virtual BOOL	DrawIcon (void *ItemData, wxDC &dc, wxRect &IconRect, BOOL Disabled, INT32 flags)
	Draws the icon for an item.
virtual wxString	GetText (void *ItemData, INT32 Item)
Friends
class	DialogManager

---

Detailed Description

FontDropDown class itself.

Author:

Richard_Millican (Xara Group Ltd) <camelotdev@xara.com>

Date:

3/10/95

Definition at line 170 of file fontdrop.h.

---

Constructor & Destructor Documentation

FontDropDown::FontDropDown (   )

Default constructor for FontDropDown Class... Notes: If you mistakenly replace the F with a D you get a great song title... Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 4/10/95 Definition at line 231 of file fontdrop.cpp. { TheTopItem.FontName = _R(IDS_ATM_DEFAULT); // "Default"; TheTopItem.Type = FC_UNDEFINED; m_MissingItemAdded = FALSE; }

FontDropDown::~FontDropDown (   )  [virtual]

Default destructor for FontDropDown Class... Notes: If you mistakenly replace the F with a D you get a great song title... Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 5/10/95 Definition at line 250 of file fontdrop.cpp. { }

---

Member Function Documentation

BOOL FontDropDown::AddFontToList (  TCHAR *  FontName, FontClass  Type )

Called for each font installed on the system. Effectively creates the FontPullDown items from the given info. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 3/10/95 Parameters: FontName  - Name of font [INPUTS] Type - Type of font Returns: TRUE if the font was added to the list ok. Definition at line 324 of file fontdrop.cpp. { FontDropItem *Item = new FontDropItem(FontName, Type); if(Item == NULL) { ERROR3("FontDropDown::AddFontToList couldn't create Item"); return FALSE; } // Add the item into the list, in a sorted fashion... ListItem *TheItem = Fonts.GetHead(); if(TheItem == NULL) { Fonts.AddTail(Item); return TRUE; } if( ((FontDropItem *)TheItem)->FontName > String_64(FontName)) { Fonts.InsertBefore(TheItem, Item); return TRUE; } while (TheItem != NULL) { ListItem *TheNextItem = Fonts.GetNext(TheItem); if(TheNextItem == NULL) { Fonts.InsertAfter(TheItem, Item); return TRUE; } if(((FontDropItem *)TheNextItem)->FontName > String_64(FontName)) { Fonts.InsertBefore(TheNextItem, Item); return TRUE; } // Try the next item TheItem = TheNextItem; } return TRUE; }

FontDropItem * FontDropDown::DecodeSelection (  INT32  SelectionIndex  )

Decodes an index in the dropdown list back into a font. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 4/10/95 Parameters: SelectionIndex  - The index of the item (which is usually the selected one) [INPUTS] in the combo box. Returns: A FontDropItem which is selected... Or NULL if nothing's selected NOTE that if the list is empty, it will return NULL See also: FontDropDown::FillInColourList; FontDropDown::AddSpecialEntry Definition at line 562 of file fontdrop.cpp. { // do not allow the extra "missing" item to be selected if (SelectionIndex == GetNumberOfItems() - 1 && m_MissingItemAdded) return NULL; FontDropItem *Fred = (FontDropItem *) GetItemData(SelectionIndex); if (Fred==&TheTopItem) return(NULL); return Fred; }

BOOL FontDropDown::DrawIcon (  void *  ItemData, wxDC &  dc, wxRect &  IconRect, BOOL  Disabled, INT32  flags )  [protected, virtual]

Draws the icon for an item. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 4/10/95 Parameters: ItemData  - Your item data [INPUTS] hDC - The DC to render into IconRect - points at a rectangle (square in fact) to be drawn within Disabled - TRUE if this item is disabled so the icon should be drawn greyed Returns: TRUE if this item needs an icon to the left of it, FALSE if not Notes: Called by HandleDrawItemInternal when this object has been identified as the owner of the control to be redrawn, if HasIcon returned TRUE This method MUST be overridden by derived classes to provide redraw of their FontDropDown list items. The base class does nothing. On entry, the DC is ready for you to draw into, including having the camelot palette selected in etc. See also: FontDropDown::DrawIcon; FontDropDown::DrawText Reimplemented from DropDown. Definition at line 638 of file fontdrop.cpp. { ResourceID BitmapID = 0; FontClass Type; if ((ItemData==&TheTopItem) || !ItemData) Type = TheTopItem.Type; else Type = ((FontDropItem *)ItemData)->Type; switch(Type) { case FC_TRUETYPE: BitmapID = _R(IDB_TTF_SYMBOL); break; case FC_ATM: BitmapID = _R(IDB_ATM_SYMBOL); break; case FC_UNDEFINED: BitmapID = _R(IDB_UNKNOWNFONT_SYMBOL); break; default: BitmapID = 0; break; } if(BitmapID == 0) return FALSE; wxBitmap * pBitmap = CamArtProvider::Get()->FindBitmap(BitmapID, (CamArtFlags)(CAF_DEFAULT|(Disabled?CAF_GREYED:0))); if (!pBitmap) return FALSE; dc.DrawBitmap(*pBitmap, IconRect.GetLeft(), IconRect.GetTop(), TRUE); return TRUE; }

BOOL FontDropDown::FillInFontList (   )

"Fills in" the attached control with appropriate entries for the current FontDropDown settings Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 3/10/95 Parameters: [INPUTS]  Returns: TRUE if it filled in the list successfully See also: FontDropDown::DecodeSelection; FontDropDown::AddSpecialEntry Definition at line 389 of file fontdrop.cpp. { ERROR2IF(ParentDlg == NULL, FALSE, "FontDropDown not properly initialised"); TRACEUSER("wuerthne", _T("FillInFontList")); SetListRedraw(FALSE); // Disable redraw while updating ClearList(); // Delete combobox contents // Setup the static class pointer variable so we can add things to this dropdown... CurrentFontDropDown = (void *)this; if(Fonts.GetCount() == 0) { TRACEUSER("wuerthne", _T("FontDropDown enumerating fonts")); FontDropEnumFont EnumObj; EnumObj.Execute(); // Loop through the list, checking for ATM / TTF duplicates, and remove the TTF ones from the list FontDropItem *Item = (FontDropItem *)Fonts.GetHead(); while (Item != NULL) { FontClass ItemType = Item->Type; if(ItemType == FC_ATM) { // It's an ATM font, go through whole list checking for TTF equiv. BOOL Removed = FALSE; String_64 ItemName(Item->FontName); FontDropItem *InnerLoopItem = (FontDropItem *)Fonts.GetHead(); while (InnerLoopItem != NULL && Removed == FALSE) { // Have we found our font ? Remove it if we have... if((InnerLoopItem->Type == FC_TRUETYPE) && (InnerLoopItem->FontName == ItemName)) { Fonts.RemoveItem((ListItem *)InnerLoopItem); delete InnerLoopItem; InnerLoopItem = NULL; Removed = TRUE; } // Get the next item if(!Removed) InnerLoopItem = (FontDropItem *)Fonts.GetNext((ListItem *)InnerLoopItem); } } // Get the next item Item = (FontDropItem *)Fonts.GetNext((ListItem *)Item); } } ListItem *Item = Fonts.GetHead(); while (Item != NULL) { // Add the font in the list to the combo box AddItem((void *) Item); // Try the next item Item = Fonts.GetNext(Item); } SetListRedraw(TRUE); // Re-enable redraw return(TRUE); }

wxString FontDropDown::GetText (  void *  ItemData, INT32  Item )  [protected, virtual]

Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 3/10/95 Parameters: ItemData  - Your item data [INPUTS] Returns: The text Reimplemented from DropDown. Definition at line 694 of file fontdrop.cpp. { ERROR3IF(ItemData == NULL, "NULL Itemdata in FontDropDown::DrawText"); String_64 TextToDisplay(_T("")); if (!ItemData || Item<0 || (ItemData==&TheTopItem)) TextToDisplay = TheTopItem.FontName; else TextToDisplay = (((FontDropItem *)ItemData)->FontName); // and draw the text... return(wxString((TCHAR *)TextToDisplay)); }

BOOL FontDropDown::HasIcon (  void *  ItemData  )  [protected, virtual]

Determine if an item needs an icon next to it. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 13/9/95 Parameters: ItemData  - Your item data [INPUTS] Returns: TRUE if this item needs an icon to the left of it, FALSE if not Notes: Called by HandleDrawItemInternal when this object has been identified as the owner of the control to be redrawn. This method MUST be overridden by derived classes to provide redraw of their FontDropDown list items. The base class returns FALSE If you return TRUE, you must also provide the DrawIcon method See also: FontDropDown::DrawIcon; FontDropDown::DrawText Reimplemented from DropDown. Definition at line 600 of file fontdrop.cpp. { // All our items have a space for a truetype icon to their left return(TRUE); }

BOOL FontDropDown::Init (  CWindowID  Window, CGadgetID  Gadget )  [virtual]

FontDropDown initialiser. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 26/10/95 Parameters: Window  - The Window in which your dropdown list gadget resides [INPUTS] Gadget - The GadgetID of the deropdown list gadget Returns: TRUE if initialised ok... Reimplemented from DropDown. Definition at line 272 of file fontdrop.cpp. { BOOL ok = DropDown::Init(Window, Gadget); return ok; }

void FontDropDown::KillList (  void   )  [virtual]

Kills all the items in the drop down and deletes them... Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 5/10/95 Reimplemented from DropDown. Definition at line 290 of file fontdrop.cpp. { ClearList(); ListItem *Item = Fonts.GetTail(); // Loop through list, deleting items and reclaiming memory while(Item != NULL) { ListItem* Prev = Fonts.GetPrev(Item); delete( (FontDropItem*)((Fonts.RemoveItem(Item))) ); Item = Prev; } m_MissingItemAdded = FALSE; }

BOOL FontDropDown::SetSelection (  FontDropItem *  TheFont  )

To set the selected item in the list. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 4/10/95 Parameters: TheFont  - FontDropItem to select [INPUTS] Returns: TRUE if it set the selection OK See also: FontDropDown::DecodeSelection; FontDropDown::FillInColourList Definition at line 473 of file fontdrop.cpp. { ERROR2IF(ParentDlg == NULL, FALSE, "FontDropDown not properly initialised"); INT32 SelectedIndex = -1; TRACEUSER("wuerthne", _T("SetSelection to %s"), (TCHAR*)TheFont->FontName); INT32 Index = 0; INT32 MaxIndex = GetNumberOfItems(); while (Index < MaxIndex) { if ( (TheFont->FontName == ((FontDropItem *) GetItemData(Index))->FontName) && (TheFont->Type == ((FontDropItem *) GetItemData(Index))->Type) ) { SelectedIndex = Index; break; } Index++; } if (Index == MaxIndex) { TRACEUSER("wuerthne", _T("font not in list, Index = %d"), Index); // font was not in the list, so make sure there is a special item at the // end to accomodate it String_64 NewName(TheFont->FontName); NewName += String_64(_R(IDS_FONTMISSING)); if (m_MissingItemAdded) { TRACEUSER("wuerthne", _T("update missing item")); FontDropItem *Item = (FontDropItem*)Fonts.GetTail(); Item->SetInfo(NewName, FC_UNDEFINED); SelectedIndex = Index - 1; } else { TRACEUSER("wuerthne", _T("add missing item")); FontDropItem *Item = new FontDropItem(NewName, FC_UNDEFINED); Fonts.AddTail(Item); AddItem((void*) Item); m_MissingItemAdded = TRUE; SelectedIndex = Index; } } else { // the font was in the list, so if there is a "missing" item at the end remove it // (unless of course, the selected item *is* the "missing" item, but this cannot // normally happen because our item has the added text " (missing)") if (m_MissingItemAdded && SelectedIndex != MaxIndex - 1) { TRACEUSER("wuerthne", _T("remove missing item")); delete( (FontDropItem*)((Fonts.RemoveItem(Fonts.GetTail()))) ); m_MissingItemAdded = FALSE; // delete the item from the combo box DeleteItem(MaxIndex - 1); } } TRACEUSER("wuerthne", _T("setting index to %d"), SelectedIndex); SetSelectedIndex(SelectedIndex); // And set the appropriate selected item TRACEUSER("wuerthne", _T("SetSelection done")); return(TRUE); }

BOOL FontDropDown::SetTopFontName (  StringBase *  StrValue, FontClass  Type, BOOL  Deselect = TRUE )

Changes the string and bmp in the icon above the font pull down to reflect whatever you give it... Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 4/10/95 Parameters: StrValue  - Font name, or whatever you want in the icon above the pull down [INPUTS] Type - Type of font - TTF, ATM, etc.... Deselect - If we do an explicit SetSelectedIndex (Or SetSelected) after this call, then set this to FALSE to avoid unneccesary flicker Returns: TRUE if ok See also: DropDown::HasIcon; DropDown::DrawIcon; DropDown::DrawText Definition at line 732 of file fontdrop.cpp. { TheTopItem.FontName = *StrValue; TheTopItem.Type = Type; // Deselect any selected items if(Deselect) SetSelectedIndex(-1); return TRUE; }

---

Friends And Related Function Documentation

friend class DialogManager [friend]

Reimplemented from DropDown. Definition at line 172 of file fontdrop.h.

---

Member Data Documentation

void * FontDropDown::CurrentFontDropDown = 0 [static]

Definition at line 220 of file fontdrop.h.

List FontDropDown::Fonts

Definition at line 223 of file fontdrop.h.

BOOL FontDropDown::m_MissingItemAdded

Definition at line 225 of file fontdrop.h.

FontDropItem FontDropDown::TheTopItem

Definition at line 228 of file fontdrop.h.

---

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

• wxOil/fontdrop.h (r1785/r1164)
• wxOil/fontdrop.cpp (r1785/r1282)

---