ColourDropDown Class Reference

Colour drop down class - provides a dropdown list of named colours with colour patch and name, for use in the colour editor etc. More...

#include <coldrop.h>

Inheritance diagram for ColourDropDown:

List of all members.

Public Member Functions
	ColourDropDown (BOOL AutoUpdateOnColourListChange=TRUE)
	ColourDropDown constructor.
virtual	~ColourDropDown ()
	ColourDropDown destructor.
virtual BOOL	Init (CWindowID Window, CGadgetID Gadget)
	DropDown initialiser.
void	ClearAllSpecialEntries (void)
	Forgets about any special entries you may have added in the past.
BOOL	AddSpecialEntry (StringBase *Text, DocColour *Colour=NULL)
	Adds a "special entry" to the top of the colour list.
BOOL	UpdateSpecialEntry (StringBase *Text, DocColour *NewColour)
	Modifies a "special entry" to display a different colour. Cannot be used if the entry has no colour associated with it.
BOOL	FillInColourList (IndexedColour *Selected=NULL, INT32 SelectIndex=-1, IndexedColour *NotDescendantOf=NULL)
	"Fills in" the attached control with appropriate entries for the current ColourDropDown settings, and (if neccessary) a separated set of special entries at the top thereof.
BOOL	SetSelection (IndexedColour *Selected, INT32 SelectIndex=-1)
	To set the selected item in the list.
IndexedColour *	DecodeSelection (INT32 SelectionIndex)
	Decodes an index in the dropdown list back into either a special-item index or an IndexedColour pointer. (See AddSpecialEntry for details).
Static Public Member Functions
static void	UpdateForNewColourList (void)
	Called by the ColourDropMsgHandler whenever a colour list changes or we swap to a different document, etc. Will automatically clear the list and shade it if there are no documents around.
static void	RedrawColourDropDowns (void)
	Called by the ColourDropMsgHandler whenever the selected view's colour context is changed, so we redraw using the new correction/separation options.
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)
	Draws the text for an item.
Protected Attributes
List	SpecialEntries
BOOL	AutoUpdateOnChange
GBrush	GDrawBrush
Static Protected Attributes
static ColourDropMsgHandler *	MessageHandler = NULL
static INT32	MsgHandlerCount = 0
Friends
class	DialogManager

---

Detailed Description

Colour drop down class - provides a dropdown list of named colours with colour patch and name, for use in the colour editor etc.

Author:

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

Date:

?/10/95

Definition at line 125 of file coldrop.h.

---

Constructor & Destructor Documentation

ColourDropDown::ColourDropDown (  BOOL  AutoUpdateOnColourListChange = TRUE  )

ColourDropDown constructor. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 6/10/95 Inouts: AutoUpdateOnColourListChange - Cor! What a whopper! ;-) er... where was I? Oh, yeah. TRUE (default) if you want the colour list to automatically update when the current colour list (selected document) changes. This includes addition/removal/change of colours, as well as changing document, and auto-shadin/unshading of the list gadget when there are no documents or colours present. FALSE if you want to poke the list yourself. (This should only really be used by the Colour Editor, which already had lots of careful handling code built in- everyone else should just use the default setting) Definition at line 193 of file coldrop.cpp. { AutoUpdateOnChange = AutoUpdateOnColourListChange; }

ColourDropDown::~ColourDropDown (   )  [virtual]

ColourDropDown destructor. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 29/8/95 Definition at line 211 of file coldrop.cpp. { ClearAllSpecialEntries(); if (MessageHandler != NULL) { MsgHandlerCount--; if (MsgHandlerCount <= 0) { delete MessageHandler; // Get rid of msghandler when not needed MessageHandler = NULL; } } }

---

Member Function Documentation

BOOL ColourDropDown::AddSpecialEntry (  StringBase *  Text, DocColour *  Colour = NULL )

Adds a "special entry" to the top of the colour list. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 29/8/95 Parameters: Text  - The text to put in the entry (this will be copied) [INPUTS] Colour - NULL or a DocColour. If non-NULL, this describes the colour of the colour patch placed to the left of the text. If NULL, no colour patch will be drawn. Returns: TRUE if it added to the list successfully Notes: All special items MUST be added before calling FillInColourList The colour list can be augmented with a number of "special" entries. Each call to this method adds another entry to the bottom of the special entries list. If there are special entries, they are added to to top of the colour list, with a divider item between them and the colours. There can only be one divider. Special entries are indexed by their order of addition, with the first entry being number 0. When decoding a selection, DecodeSelection will return an IndexedColour pointer (if a colour was selected), or NULL, in which case, use the Index you passed in to determine which Special Entry was selected. Note that the divider will be treated as a special entry (e.g. with 2 special items, you can get an entry 2 selected - this corresponds to the divider, and should be ignored) See also: ColourDropDown::DecodeSelection; ColourDropDown::FillInColourList Definition at line 331 of file coldrop.cpp. { ERROR2IF(ParentDlg == NULL, FALSE, "ColourDropDown not properly initialised"); SpecialEntry *NewEntry = new SpecialEntry; if (NewEntry != NULL && NewEntry->Init(Text, Colour)) { SpecialEntries.AddTail(NewEntry); return(TRUE); } return(FALSE); }

void ColourDropDown::ClearAllSpecialEntries (  void   )

Forgets about any special entries you may have added in the past. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 29/8/95 See also: ColourDropDown::AddSpecialEntry Definition at line 288 of file coldrop.cpp. { SpecialEntries.DeleteAll(); }

IndexedColour * ColourDropDown::DecodeSelection (  INT32  SelectionIndex  )

Decodes an index in the dropdown list back into either a special-item index or an IndexedColour pointer. (See AddSpecialEntry for details). Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 29/8/95 Parameters: SelectionIndex  - The index of the item (which is usually the selected one) [INPUTS] in the combo box. Returns: NULL if the SelectionIndex should be treated as a "special item", else a pointer to the selected IndexedColour. (Note: If the list is empty, it will also return NULL) Notes: The colour list can be augmented with a number of "special" entries. Each call to this method adds another entry to the bottom of the special entries list. If there are special entries, they are added to to top of the colour list, with a divider item between them and the colours. There can only be one divider. Special entries are indexed by their order of addition, with the first entry being number 0. When decoding a selection, DecodeSelection will return an IndexedColour pointer (if a colour was selected), or NULL, in which case, use the Index you passed in to determine which Special Entry was selected. Note that the divider will be treated as a special entry (e.g. with 2 special items, you can get an entry 2 selected - this corresponds to the divider, and should be ignored) See also: ColourDropDown::FillInColourList; ColourDropDown::AddSpecialEntry Definition at line 612 of file coldrop.cpp. { // If it's at the top of the list, it could be a "special" (extra) entry if (!SpecialEntries.IsEmpty() && SelectionIndex <= (INT32)SpecialEntries.GetCount()) return(NULL); void * Data = GetItemData(SelectionIndex); // if (Data == -1) // If the list is empty, we will get a -1 back, so weed it out // return(NULL); // Otherwise, it must be a colour, so fetch the colour pointer... return( (IndexedColour *) Data); }

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

Draws the icon for an item. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 13/9/95 Parameters: ItemData  - Your item data [INPUTS] dc - 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 Reimplemented from DropDown. Definition at line 756 of file coldrop.cpp. { GDrawBrush.Init(&dc); GDrawBrush.Start(); wxBrush OldBrush=dc.GetBrush(); wxPen OldPen=dc.GetPen(); COLORREF rgb; BOOL IsSpotColour = FALSE; if (Disabled) { // The item is disabled, so just put a light grey splodge in the place of the colour rgb = RGB(192, 192, 192); dc.SetPen(*wxTRANSPARENT_PEN); } else { ColourContextRGBT *CCrgbt = (ColourContextRGBT *) ColourManager::GetColourContext(COLOURMODEL_RGBT, DocView::GetSelected()); ERROR3IF(CCrgbt == NULL, "No available RGB colour context?!"); CCObject *Item = (CCObject *)ItemData; if (Item->IsKindOf(CC_RUNTIME_CLASS(IndexedColour))) { DocColour Bob; Bob.MakeRefToIndexedColour((IndexedColour *)ItemData); rgb = ConvertColourToScreenWord(CCrgbt, &Bob); if ( ((IndexedColour *) ItemData)->IsSpotOrTintOfSpot() ) IsSpotColour = TRUE; } else rgb = ConvertColourToScreenWord(CCrgbt, &(((SpecialEntry *)ItemData)->ItemColour)); dc.SetPen(*wxBLACK_PEN); } wxBrush brush; if (GDrawBrush.Available()) GDrawBrush.GetLogBrush(rgb, &brush); else brush=wxBrush(rgb); dc.SetBrush(brush); if (IsSpotColour) dc.DrawEllipse(IconRect.GetLeft(), IconRect.GetTop(), IconRect.GetWidth(), IconRect.GetHeight()); else dc.DrawRectangle(IconRect.GetLeft(), IconRect.GetTop(), IconRect.GetWidth(), IconRect.GetHeight()); // Finish with GBrush GDrawBrush.Stop(); dc.SetBrush(OldBrush); dc.SetPen(OldPen); return(TRUE); }

BOOL ColourDropDown::FillInColourList (  IndexedColour *  Selected = NULL, INT32  SelectIndex = -1, IndexedColour *  NotDescendantOf = NULL )

"Fills in" the attached control with appropriate entries for the current ColourDropDown settings, and (if neccessary) a separated set of special entries at the top thereof. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 29/8/95 Parameters: Selected  - NULL or a pointer to the selected colour [INPUTS] (Only one of Selected, SelectedIndex should indicate the selection) SelectIndex - -1 or the 0-based index of the special item to select (Only one of Selected, SelectedIndex should indicate the selection. SelectIndex will actually override Selected if it is valid) NotDescendantOf - NULL, or a pointer to an IndexedColour. If this is non-null then this does not include "NotADescendantOf" or any of its children in the list (this allows a list of all available parent colours for a colour to be compiled by passing that colour in this field) Returns: TRUE if it filled in the list successfully Notes: Only special entries added before this call is made will appear in the list, so add them first. Call this after initialising the control, and after any subsequent calls to change the contents of the list. See also: ColourDropDown::DecodeSelection; ColourDropDown::AddSpecialEntry Definition at line 430 of file coldrop.cpp. { ERROR2IF(ParentDlg == NULL, FALSE, "ColourDropDown not properly initialised"); BOOL Result = FALSE; // Assume we've failed until we add an item! Progress Hourglass; // Start an hourglass running ColourList *ParentList = ColourManager::GetCurrentColourList(); SetListRedraw(FALSE); // Disable redraw while updating ClearList(); // Delete combobox contents INT32 SelectedIndex = 0; if (!SpecialEntries.IsEmpty()) { // Add an entry for each special entry ListItem *Ptr = SpecialEntries.GetHead(); while (Ptr != NULL) { AddItem((void *) Ptr); Ptr = SpecialEntries.GetNext(Ptr); } AddItem(NULL); // And add a separator Result = TRUE; // There are items in the list, so we can return "OK" now } // If we have a "NotDescendantOf" colour, then we can only add parent colours to the list // if the "NotDescendantOf" colour is tint/shade/linked - normal/spot colours cannot have parents // Of course, we have to rely on the caller to be sensible here, because they might be about // to change the type of the colour (e.g. New Colour dialogue shows potential parents and // converts the colour to a shade if a parent is chosen. Thus, we don't want to present a blank // list of parent colours!) if (ParentList != NULL) { // Determine (precalculate) if NotADescendant (if any) is a tint colour BOOL NotATint = TRUE; if (NotDescendantOf != NULL && NotDescendantOf->GetType() == COLOURTYPE_TINT && !NotDescendantOf->TintIsShade()) { NotATint = FALSE; } // Now scan the colour list, adding any legal parent colours to the list IndexedColour *Ptr = (IndexedColour *) ParentList->GetHead(); INT32 Index = (SpecialEntries.IsEmpty()) ? 0 : (SpecialEntries.GetCount() + 1); while (Ptr != NULL) { Hourglass.Update(); // Update the houglass // Is the colour a named, live colour and not descended from NotADescendant? (Note: we // can safely pass NULL into IsADescendantOf()) if (!Ptr->IsDeleted() && Ptr->IsNamed() && !Ptr->IsADescendantOf(NotDescendantOf)) { AddItem((void *) Ptr); Result = TRUE; // We've succeeded in adding at least 1 item if (Ptr == Selected) SelectedIndex = Index; Index++; } Ptr = (IndexedColour *) ParentList->GetNext(Ptr); } } SetListRedraw(TRUE); // Re-enable redraw // Override any selection index we have with the caller-provided selection index, if // it indicates a valid "special item" if (SelectIndex >= 0 && SelectIndex < (INT32)SpecialEntries.GetCount()) SelectedIndex = SelectIndex; if (Result) SetSelectedIndex(SelectedIndex); // And set the appropriate selected item // Finally, enable the gadget, and trim its length down if necessary to fit the // number of displayed items. // DialogManager::SetComboListLength(ParentDlg, ParentGadget); -- causes nasty redraw of document behind! DialogManager::EnableGadget(ParentDlg, ParentGadget, TRUE); return(Result); }

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

Draws the text for an item. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 13/9/95 Parameters: ItemData  - Your item data [INPUTS] Item - the number of the item Returns: The text for the item 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 ColourDropDown list items. The base class draws nothing. Note that on entry, the text FG/BG colours have been set up appropriately for the state of the item (shaded, selected, etc) Basically, all you have to do is find the text and do a DrawText call. See also: ColourDropDown::DrawIcon; ColourDropDown::DrawText Reimplemented from DropDown. Definition at line 849 of file coldrop.cpp. { ERROR3IF(ItemData == NULL, "NULL Itemdata in ColourDropDown::DrawText"); // Determine if it's a colour or a special item, and find the text to draw TCHAR * TextToDraw = NULL; CCObject *pItem = (CCObject *) ItemData; if (pItem->IsKindOf(CC_RUNTIME_CLASS(IndexedColour))) TextToDraw = ( (TCHAR *) (*((IndexedColour *)ItemData)->GetName()) ); else TextToDraw = ( (TCHAR *) ((SpecialEntry *)ItemData)->ItemText ); if (TextToDraw) return wxString(TextToDraw); else return wxEmptyString; }

BOOL ColourDropDown::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 ColourDropDown list items. The base class returns FALSE If you return TRUE, you must also provide the DrawIcon method See also: ColourDropDown::DrawIcon; ColourDropDown::DrawText Reimplemented from DropDown. Definition at line 728 of file coldrop.cpp. { // All our items have a colour splodge return(TRUE); }

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

DropDown initialiser. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 29/8/95 Parameters: Window  - The Window in which your dropdown list gadget resides [INPUTS] Gadget - The GadgetID of the deropdown list gadget Returns: TRUE if it succeeded in connecting itself to your gadget FALSE if it failed Reimplemented from DropDown. Definition at line 245 of file coldrop.cpp. { BOOL AlreadyInitialised = Initialised; // Remember if this is the first time we've been init'd if (DropDown::Init(Window, Gadget)) // Call the base class { if (AlreadyInitialised) // Only increment handler count on first initialisation return(TRUE); if (MessageHandler == NULL) // And ensure we have a message handler { MessageHandler = new ColourDropMsgHandler; MsgHandlerCount = 0; } if (MessageHandler != NULL) // And increment its usage count { MsgHandlerCount++; return(TRUE); } } return(FALSE); }

void ColourDropDown::RedrawColourDropDowns (  void   )  [static]

Called by the ColourDropMsgHandler whenever the selected view's colour context is changed, so we redraw using the new correction/separation options. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 23/5/96 Scope: sorta private Definition at line 686 of file coldrop.cpp. { DropDown *Ptr = (DropDown *) CurrentDropDowns.GetHead(); while (Ptr != NULL) { if (Ptr->IsKindOf(CC_RUNTIME_CLASS(ColourDropDown))) { ColourDropDown *CPtr = (ColourDropDown *)Ptr; DialogManager::InvalidateGadget(CPtr->ParentDlg, CPtr->ParentGadget); } Ptr = (DropDown *) CurrentDropDowns.GetNext(Ptr); } }

BOOL ColourDropDown::SetSelection (  IndexedColour *  Selected, INT32  SelectIndex = -1 )

To set the selected item in the list. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 1/9/95 Parameters: Selected  - NULL or a pointer to the selected colour [INPUTS] (Only one of Selected, SelectedIndex should indicate the selection) SelectIndex - -1 or the 0-based index of the special item to select (Only one of Selected, SelectedIndex should indicate the selection. SelectIndex will actually override Selected if it is valid) Returns: TRUE if it set the selection OK See also: ColourDropDown::DecodeSelection; ColourDropDown::FillInColourList Definition at line 546 of file coldrop.cpp. { ERROR2IF(ParentDlg == NULL, FALSE, "ColourDropDown not properly initialised"); INT32 SelectedIndex = 0; if (SelectIndex >= 0 && SelectIndex < (INT32)SpecialEntries.GetCount()) // Use special item SelectedIndex = SelectIndex; else if (Selected != NULL) // Use colour ptr { INT32 Index = (SpecialEntries.IsEmpty()) ? 0 : (SpecialEntries.GetCount() + 1); INT32 MaxIndex = GetNumberOfItems(); while (Index < MaxIndex) { if (Selected == (IndexedColour *) GetItemData(Index)) { SelectedIndex = Index; break; } Index++; } } SetSelectedIndex(SelectedIndex); // And set the appropriate selected item return(TRUE); }

void ColourDropDown::UpdateForNewColourList (  void   )  [static]

Called by the ColourDropMsgHandler whenever a colour list changes or we swap to a different document, etc. Will automatically clear the list and shade it if there are no documents around. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 6/10/95 Basically just calls FillInColourList for all active ColourDropDowns Scope: sorta private Definition at line 645 of file coldrop.cpp. { Document *SelDoc = Document::GetSelected(); if (SelDoc != NULL) // No need to shade, so return now return; DropDown *Ptr = (DropDown *) CurrentDropDowns.GetHead(); while (Ptr != NULL) { if (Ptr->IsKindOf(CC_RUNTIME_CLASS(ColourDropDown))) { ColourDropDown *CPtr = (ColourDropDown *)Ptr; if (CPtr->AutoUpdateOnChange) { CPtr->ClearList(); DialogManager::EnableGadget(CPtr->ParentDlg, CPtr->ParentGadget, FALSE); // Shade } } Ptr = (DropDown *) CurrentDropDowns.GetNext(Ptr); } }

BOOL ColourDropDown::UpdateSpecialEntry (  StringBase *  Text, DocColour *  NewColour )

Modifies a "special entry" to display a different colour. Cannot be used if the entry has no colour associated with it. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 20/10/95 Parameters: Text  - The text in the existing entry [INPUTS] NewColour - The colour to chnage the display to Returns: TRUE for success, FALSE if the entry was not found Notes: Also causes a redraw of the dropdown control to update the screen display. See also: ColourDropDown::DecodeSelection; ColourDropDown::FillInColourList Definition at line 367 of file coldrop.cpp. { ERROR3IF(Text == NULL || NewColour == NULL, "Illegal NULL params"); SpecialEntry *Ptr = (SpecialEntry *) SpecialEntries.GetHead(); while (Ptr != NULL) { if (Ptr->ItemHasColour && Ptr->ItemText == *Text) { // Set the new colour Ptr->ItemColour = *NewColour; // And cause the combobox to redraw DialogManager::InvalidateGadget(ParentDlg, ParentGadget); return(TRUE); } Ptr = (SpecialEntry *) SpecialEntries.GetNext(Ptr); } return(FALSE); }

---

Friends And Related Function Documentation

friend class DialogManager [friend]

Reimplemented from DropDown. Definition at line 127 of file coldrop.h.

---

Member Data Documentation

BOOL ColourDropDown::AutoUpdateOnChange [protected]

Definition at line 173 of file coldrop.h.

GBrush ColourDropDown::GDrawBrush [protected]

Definition at line 194 of file coldrop.h.

ColourDropMsgHandler * ColourDropDown::MessageHandler = NULL [static, protected]

Definition at line 177 of file coldrop.h.

INT32 ColourDropDown::MsgHandlerCount = 0 [static, protected]

Definition at line 178 of file coldrop.h.

List ColourDropDown::SpecialEntries [protected]

Definition at line 171 of file coldrop.h.

---

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

• wxOil/coldrop.h (r1785/r1282)
• wxOil/coldrop.cpp (r1785/r1777)

---