ColourPicker Class Reference

Encapsulates OS-specific colour picker dialogue system, giving a kernel interface for using whatever colour picker(s) are available. More...

#include <colpick.h>

Inheritance diagram for ColourPicker:

List of all members.

Public Member Functions
	ColourPicker ()
	Creates a colourpicker object Scope: private.
	~ColourPicker ()
	Destructor for a Colour Picker Scope: private.
void	EditColour (ColourList *ParentList, IndexedColour *SourceAndResult, BOOL PreferLineColour=FALSE)
	Converts a ColourValue (0.0 to 1.0) into a byte (0..255) with clipping to handle out-of-gamut values.The main colour picker function. Given an IndexedColour, sets up a colour picker showing that colour, allows the user to edit it, and returns the new colour in said IndexedColour. If the colour is changed, an appropriate ColourChangingMsg will be broadcast.
Static Public Member Functions
static BOOL	GetStatusLineText (String_256 *Result)
static void	UpdateBubbleHelpAndPointer (void)
	Called on Idle (or MouseMove) events to provide bubble help and update the mouse pointer while it is over the colour editor dialogue.
static void	SetBubbleHelp (CGadgetID *GadgetList)
	Set all the bubble help up for the colour picker.
Static Protected Member Functions
static BOOL	GetStatusLineText (ColourEditDlg *Editor, UINT32 GadgetID, String_256 *Result)
	Bodge to get around the fact that DialogOps don't plug into the status line help system. Returns help for the colour editor. Must go via the winoil, as we have to read the mouse position and find the window it's in.
static TCHAR *	HelpCallbackHandler (CWindowID Window, UINT32 Item, void *UserData)
	Help callback handler to provide bubble help for the colour editor.
static BOOL	GetComponentHelp (ColourContext *const pSourceContext, const UINT32 ComponentIndex, StringBase &HelpString)
	Subprocedure for HelpCallbackHandler providing help for each of the colour components.
static BOOL	GetComponentAsString (IndexedColour *Source, ColourContext *DestContext, INT32 ComponentIndex, String_8 *Result)
	Retrieves the colour definition of the given colour, converts it to the given colour model, and returns the desired component of the definition in that model as a decimal string appropriate for placing into a colour editor dialogue gadget.
static BOOL	GetComponentsAsHexString (IndexedColour *Source, ColourContext *DestContext, INT32 ComponentIndex, String_16 *Result)
	Retrieves the colour definition of the given colour, converts it to the given colour model, and returns the combined value of all components of the definition in that model as a hexadecimal string appropriate for placing into a colour editor dialogue gadget.
static BOOL	SetComponentFromString (IndexedColour *Dest, ColourContext *SourceContext, INT32 ComponentIndex, String_8 *NewValue)
	Converts AND COERCES the colour into the destination context. Assumes that the string will be 0..100 (or 0..360 for HSV) Clips the string value into a 0.0 to 1.0 in-gamut range, and then sets the given component of the converted colour to that value. This thus changes the colour model in which the colour is defined as well as the component value.
static BOOL	SetComponentsFromHexString (IndexedColour *Dest, ColourContext *SourceContext, String_16 *NewValue)
	Converts AND COERCES the colour into the destination context. Assumes that the string will in hex format (i.e rrggbb or 0xrrggbb) Clips the string value into 0.0 to 1.0 in-gamut ranges, and then sets the components of the converted colour to those values. This thus changes the colour model in which the colour is defined as well as the component value.
static BOOL	IsValidHexString (String_16 Hex)
	Internal helper function for ColourPicker::SetComponentsFromHexString () UNLESS YOU KNOW WHAT YOUR DOING - DON'T CALL THIS AS IT ONLY EXISTS TO HELP THE FORE-MENTIONED FUNCTION - AND I CANNOT SEE WHY YOUR CALLING THIS FROM ELSEWHERE ANYWAY !!!!
static BOOL	SetComponentFromDouble (IndexedColour *Dest, ColourContext *SourceContext, INT32 ComponentIndex, double NewValue)
	Converts AND COERCES the colour into the destination context. Clips the new value into a 0.0 to 1.0 in-gamut range, and then sets the given component of the converted colour to that value.
static void	ForceColourModel (IndexedColour *Dest, ColourContext *SourceContext)
	COERCES the colour into the destination context. This ensures that the colour is defined in the given context's colour model, converting its definition if necessary.
static BOOL	GetTintAsString (IndexedColour *Source, StringBase *Result)
	Retrieves the tint of the given colour as a decimal string appropriate for placing into a colour editor dialogue gadget.
static BOOL	SetTintFromString (IndexedColour *Dest, StringBase *NewValue)
	Assumes that the string will be 0..100 Clips the string value into a 0.0 to 1.0 in-gamut range, and then sets the tint component of the converted colour to that value.
static BOOL	GetShadeValueAsString (IndexedColour *Source, INT32 ValueIndex, StringBase *Result)
	Retrieves the shade of the given colour as a decimal string appropriate for placing into a colour editor dialogue gadget.
static BOOL	SetShadeFromStrings (IndexedColour *Dest, StringBase *NewValueX, StringBase *NewValueY)
	Assumes that the string will be -100..100 Clips the string value into a -1.0 to 1.0 in-gamut range, and then sets the shade components of the converted colour to those values.
static void	SetWindowExtent (CWindowID WindowID, CGadgetID XGadgetID, CGadgetID YGadgetID)
	Private function used by the kernel ColourEditDlg editor. Given a WindowID and GadgetID (cf DialogOp->DialogMgr interface), this sets the window extent of the window to a short distance outside the right/ bottom edges of the X/Y named gadgets respectively.
static void	SetGadgetPositions (CWindowID WindowID, CGadgetID *Gadgets, CGadgetID MoveUnder)
	Private function used by the kernel ColourEditDlg editor. Given a WindowID and GadgetIDs (cf DialogOp->DialogMgr interface), this moves all the gadgets such that (a) All the gadgets in the group remain in the same relative positions, and (b) the Gadgets[0] gadget is moved to lie just underneath the MoveUnder gadget.
static void	SetComponentGadgets (CWindowID WindowID, CGadgetID *Gadgets, CGadgetID PickerGadget, ColourModel ModelToDisplay)
	Private function used by the kernel ColourEditDlg editor.
static void	SetFixedComponentGadgets (CWindowID WindowID, CGadgetID *Gadgets, CGadgetID PickerGadget, ColourModel ModelToDisplay, INT32 TextWidth[], INT32 EditWidth[])
	Private function used by the kernel ColourEditDlg editor.
static void	RelayoutDialog (CWindowID WindowID)
	Ensure the dialog is a sensible size Scope: Protected.
static void	OnSize (CWindowID WindowID)
	Respond to size events Scope: Protected.
static void	RecursiveBestSize (wxWindow *pwxWindow)
	Initialize platform dependent resources.
static BOOL	OnIdleEvent (CWindowID WindowID)
	Respond idle events Scope: Protected.
static void	OnCreate (CWindowID WindowID)
	Respond to size events Scope: Protected.
static void	ArtificialSizeEvents (CWindowID WindowID)
	Produce artificial size events recursively Scope: Protected.
Static Private Attributes
static wxSize	s_LastSize = wxDefaultSize
static wxSize	s_UserSize = wxSize(245,245)
static wxSize	s_MinSize = wxSize(180,100)
static BOOL	s_InColourDialogLayout = FALSE
static BOOL	s_JustCreated = FALSE
static INT32	s_IdleCounter = 0
Friends
class	ColourEditDlg
class	ColourLinkDlg
class	NewColourDlg

---

Detailed Description

Encapsulates OS-specific colour picker dialogue system, giving a kernel interface for using whatever colour picker(s) are available.

Author:

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

Date:

13/5/95

Given a (named or unnamed) IndexedColour, a Colour Picker somehow provides a user interface to change it, and returns the colour, cleaner and brighter than you ever thought possible, and for only about the same price as you'd expect to pay for an inferior colour picker. 1 out of 10 home economists prefer our colour picker to all others.

This class also provides secrel-squirrel interfaces for doing rather horrendous direct-pokey Coloue Editor things to IndexedColours. These are only available to our friend editor dialogue classes.

Friends: ColourEditDlg; ColourLinkDlg

See also:

IndexedColour; ColourEditDlg; ColourLinkDlg

Definition at line 138 of file colpick.h.

---

Constructor & Destructor Documentation

ColourPicker::ColourPicker (   )

Creates a colourpicker object Scope: private. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 13/5/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 166 of file colpick.cpp. { }

ColourPicker::~ColourPicker (   )

Destructor for a Colour Picker Scope: private. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 13/5/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 188 of file colpick.cpp. { }

---

Member Function Documentation

void ColourPicker::ArtificialSizeEvents (  CWindowID  WindowID  )  [static, protected]

Produce artificial size events recursively Scope: Protected. Author: Alex Bligh Date: 30/5/2005 Parameters: -  [INPUTS] On GTK at least, sizing does not occur synchronously. Some of it happens on size events from a gtk_window_size_callback. For various reasons (like the necessity for a wxyield) this is not great). So we produce them ourselves. Definition at line 3006 of file colpick.cpp. { if (!WindowID->IsShown()) return; // size children first wxWindowList::Node * pNode = WindowID->GetChildren().GetFirst(); while (pNode) { ArtificialSizeEvents(pNode->GetData()); pNode = pNode->GetNext(); } wxSizeEvent event( WindowID->GetSize(), WindowID->GetId() ); event.SetEventObject( WindowID ); WindowID->GetEventHandler()->ProcessEvent( event ); }

void ColourPicker::EditColour (  ColourList *  ParentList, IndexedColour *  SourceAndResult, BOOL  PreferLineColour = FALSE )

Converts a ColourValue (0.0 to 1.0) into a byte (0..255) with clipping to handle out-of-gamut values.The main colour picker function. Given an IndexedColour, sets up a colour picker showing that colour, allows the user to edit it, and returns the new colour in said IndexedColour. If the colour is changed, an appropriate ColourChangingMsg will be broadcast. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 13/5/94 Parameters: ParentList  - The list in which the colour resides [INPUTS] May be NULL if you want to just show the picker for whatever local colour is appropriate. SourceAndResult must also be NULL in this case SourceAndResult - The colour to be edited. If the user changes the colour, this will be set to the new definition. May be NULL if you want to just show the picker for whatever local colour is appropriate. ParentList must also be NULL in this case PreferLineColour - TRUE if you'd like to edit line colours rather than fill colours in local mode, FALSE to edit fill colours. This flag is ignored unless ParentList == SourceAndResult == NULL. (Implementation note: This calls ColourEditDlg::ForceLineOrFillMode) Parameters: -  [OUTPUTS] Returns: - Notes: The IndexedColour is actually copied into another for editing. The change, if OK'd is then applied using the ColourManager::ChangeColour function, which provides an undo record of the event. Scope: private Returns: Errors: - See also: ColourEditDlg::InvokeDialog Definition at line 275 of file colpick.cpp. { #if FALSE /* // **** DEBUG - use Windows Picker if SHIFT NOT held down on entry, // else use the Camelot Picker if (ForceNativePicker) UseOSPicker = TRUE; else UseOSPicker = (::GetAsyncKeyState(CAMKEY(SHIFT)) & 0x8000) ? TRUE : FALSE; // **** if (UseOSPicker) { IndexedColour *UndoBuffer = new IndexedColour(*SourceAndResult); if (UndoBuffer == NULL) // Fail gracefully. Well... Don't crash, anyway return; ColourGeneric *TheColour = UndoBuffer->SourceColourPtr(); Document *ScopeDoc = Document::GetSelected(); if (ScopeDoc == NULL) return; ColourContext *ccRGB = ScopeDoc->GetDefaultColourContexts()->Context[COLOURMODEL_RGBT]; ENSURE(ccRGB != NULL, "Default RGBT context can't be found!"); ColourContext *ccSource = ScopeDoc->GetDefaultColourContexts()->Context[UndoBuffer->GetColourModel()]; if (ccSource == NULL) { ENSURE(FALSE, "Unsupported source colour context - I can't edit that colour"); return; } // Convert the given colour into RGB, using 'pure' contexts (logical rather than physica // conversion, i.e. no colour correction en-route) ColourRGBT TheColourRGB; ccRGB->ConvertColour(ccSource, TheColour, (ColourGeneric *) &TheColourRGB); // Now set up, and call the Windows colour picker to edit the colour... CHOOSECOLOR cc; // Set initial colour for the colour picker to use cc.rgbResult = RGB( ColourValueToByte(TheColourRGB.Red), ColourValueToByte(TheColourRGB.Green), ColourValueToByte(TheColourRGB.Blue) ); // Set the default set of available colours (a greyscale for the time being) // (it is static so that if the user changes any of the colours they will get // the changed palette back next time around) static COLORREF acrCustClr[16] = { RGB(255, 255, 255), RGB(239, 239, 239), RGB(223, 223, 223), RGB(207, 207, 207), RGB(191, 191, 191), RGB(175, 175, 175), RGB(159, 159, 159), RGB(143, 143, 143), RGB(127, 127, 127), RGB(111, 111, 111), RGB(95, 95, 95), RGB(79, 79, 79), RGB(63, 63, 63), RGB(47, 47, 47), RGB(31, 31, 31), RGB(15, 15, 15) }; cc.lStructSize = sizeof(CHOOSECOLOR); cc.hwndOwner = AfxGetApp()->m_pMainWnd->m_hWnd; // 'owner' window cc.lpCustColors = (LPDWORD) acrCustClr; // List of default colours cc.Flags = CC_RGBINIT | CC_FULLOPEN; // Use cc.rgbResult to init picker... // and picker appears fully opened - Geez that // 'define wossnames' button is a pain in the butt!!! if (ChooseColor(&cc)) // Invoke Windows colour picker (if it qualifies as a colour picker!) { // User chose a colour and hit OK - read out the return value (always RGB) UndoBuffer->SetSourceColourModel(COLOURMODEL_RGBT); ((ColourRGBT *)TheColour)->Red = ((double) GetRValue(cc.rgbResult)) / 256.0; ((ColourRGBT *)TheColour)->Green = ((double) GetGValue(cc.rgbResult)) / 256.0; ((ColourRGBT *)TheColour)->Blue = ((double) GetBValue(cc.rgbResult)) / 256.0; ((ColourRGBT *)TheColour)->Transparent = 0; Document::GetSelected()->SetCurrent(); // Make this document the current one // This swallows UndoBuffer into the undo system - we must NOT delete it ColourManager::ChangeColour(ParentList, UndoBuffer, SourceAndResult); } else delete UndoBuffer; // UndoBuffer not used - delete it } else */ #endif { #ifndef STANDALONE // If we are asking to edit an appropriate local colour, state our preference // for either fill or line colour. if (SourceAndResult == NULL) ColourEditDlg::ForceLineOrFillMode(PreferLineColour); ColourEditDlg::InvokeDialog(ParentList, SourceAndResult); #endif } }

void ColourPicker::ForceColourModel (  IndexedColour *  Dest, ColourContext *  SourceContext )  [static, protected]

COERCES the colour into the destination context. This ensures that the colour is defined in the given context's colour model, converting its definition if necessary. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 11/11/94 Parameters: Dest  - the colour to be set [INPUTS] SourceContext - the context in which the new colour value should be defined Dest  is updated appropriately [OUTPUTS] Returns: - Notes: This method always flushes the colour's output cache. Scope: private Definition at line 1926 of file colpick.cpp. { ERROR3IF(Dest == NULL || SourceContext == NULL, "ColourPicker::ForceColourModel - NULL Parameters are illegal"); // Invalidate the colour's output cache (even if it hasn't really changed - in this // case we're only causing one weeny little colour conversion, so it's no big deal) // This is also needed because the above functions expect this call to flush the cache. Dest->InvalidateCache(); if (Dest->GetColourModel() != SourceContext->GetColourModel()) { ColourContext *OldContext = ColourContext::GetGlobalDefault(Dest->GetColourModel()); if (OldContext == NULL) { ERROR2RAW("Unable to get colour context for ForceColourModel"); return; } // The colour must be coerced into the new model using secret squirrel private // methods which we can access only because we are a friend of IndexedColour ColourGeneric NewDefn; Dest->GetSourceColour(&NewDefn); // Copy into temp space & convert back into the colour SourceContext->ConvertColour(OldContext, &NewDefn, Dest->SourceColourPtr()); Dest->SetSourceColourModel(SourceContext->GetColourModel()); // and once again, flush the cache to make sure the change in model has been noticed Dest->InvalidateCache(); } }

BOOL ColourPicker::GetComponentAsString (  IndexedColour *  Source, ColourContext *  DestContext, INT32  ComponentIndex, String_8 *  Result )  [static, protected]

Retrieves the colour definition of the given colour, converts it to the given colour model, and returns the desired component of the definition in that model as a decimal string appropriate for placing into a colour editor dialogue gadget. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 11/11/94 Parameters: Source  - The colour from which you wish to extract the component [INPUTS] DestContext - The colour context in which you want the resulting component ComponentIndex - The component you wish to extract (1..4) Result  - returns containing a decimal (0.0 .. 100.0) string representing [OUTPUTS] the value of the given component of the colour as it is defined in the given colour model (Note: HSV Hue is done as 0..360). Returns: TRUE if the value converted was out of gamut. Notes: At present, this function clips the value to lie within the legal 0.0 to 1.0 gamut range. Scope: private See also: ColourPicker::SetComponentFromDouble; ColourPicker::SetComponentFromString Definition at line 1238 of file colpick.cpp. { ERROR2IF(Source == NULL || DestContext == NULL || Result == NULL, FALSE, "NULL parameters are illegal"); ERROR2IF(ComponentIndex < 1 || (UINT32)ComponentIndex > DestContext->GetComponentCount(), FALSE, "ComponentIndex not in range"); BOOL OutOfGamut = FALSE; ColourGeneric Defn; DestContext->ConvertColour(Source, &Defn); // Sneakily get the component from the ColourGeneric by treating it as an array // of 4 ColourValue components. ColourValue *CompPtr = (ColourValue *) &Defn; double CompValue = CompPtr[ComponentIndex-1].MakeDouble(); if (CompValue < 0.0) { CompValue = 0.0; // **** Clip out-of-gamut values. OutOfGamut = TRUE; // Remember that this was out of gamut } if (CompValue > 1.0) { CompValue = 1.0; // **** Clip out-of-gamut values. OutOfGamut = TRUE; // Remember that this was out of gamut } // Generate a 0..100 value, except for Hue, in which case it's 0..360 UnitGroup* pPossibleUnits = DestContext->GetComponentUnitGroup(ComponentIndex); if (pPossibleUnits == NULL) { ERROR3("ColourPicker::GetComponentAsString - pPossibleUnits NULL"); return FALSE; } ERROR3IF(!pPossibleUnits->IS_KIND_OF(UnitGroup), "pPossibleUnits aren't"); ScaleUnit* pUnit = pPossibleUnits->GetDefaultUnit(); if (pUnit == NULL) { ERROR3("ColourPicker::GetComponentAsString - Default units NULL"); return FALSE; } ERROR3IF(!pUnit->IS_KIND_OF(ScaleUnit), "pUnits isn't"); pUnit->StringFromScale(CompValue, Result, 6); // Convert to a 1 d.p. string using the global conversion function /* String_32 TempString; Convert::DoubleToString(CompValue, (StringBase *) &TempString, pUnit->GetDPtoShow()); TempString.Left(Result, 6); const Qualifier* pQualifier = pUnit->GetQualifier(); if (pQualifier == NULL || !pQualifier->IS_KIND_OF(Qualifier)) { ERROR3("ColourPicker::GetComponentAsString - not a Qualifier!"); return FALSE; } if (pQualifier->IsShown()) *Result += pQualifier->GetToken(); */ return(OutOfGamut); }

BOOL ColourPicker::GetComponentHelp (  ColourContext *const   pSourceContext, const UINT32  ComponentIndex, StringBase &  HelpString )  [static, protected]

Subprocedure for HelpCallbackHandler providing help for each of the colour components. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 31/05/96 Parameters: pSourceContext  - the ColourContext in which the component is [INPUTS] ComponentIndex - the index of the component in the colour context (1..GetComponentCount()) HelpString  - a string to be displayed as help for the given component [OUTPUTS] Returns: TRUE : If help string constructed correctly FALSE : otherwise Errors: ERROR2IF's if invalid paramters given ERROR3IF's for corrupt data structures See also: ColourPicker::HelpCallbackHandler Definition at line 979 of file colpick.cpp. { ERROR2IF(pSourceContext == NULL, FALSE, "NULL parameters not allowed"); ERROR3IF(!pSourceContext->IS_KIND_OF(ColourContext), "ColourPicker::GetComponentHelp() - pSourceContext isn't"); ERROR2IF((ComponentIndex < 1) || (ComponentIndex > pSourceContext->GetComponentCount()), FALSE, "Component index out of bounds"); // Create a string of the form "Red (0..100%)" using the colour component's name and the limits defined for // the component's unit UnitGroup* pUnitGroup = pSourceContext->GetComponentUnitGroup(ComponentIndex); if (pUnitGroup == NULL) { ERROR3("ColourPicker::GetComponentHelp - Model has no units"); return FALSE; } ERROR3IF(!pUnitGroup->IS_KIND_OF(UnitGroup), "ColourPicker::GetComponentHelp() - pUnitGroup isn't"); ScaleUnit* pUnit = pUnitGroup->GetDefaultUnit(); if (pUnit == NULL) { ERROR3("ColourPicker::GetComponentHelp - No default units"); return FALSE; } ERROR3IF(!pUnit->IS_KIND_OF(ScaleUnit), "ColourPicker::GetComponentHelp() - pUnit isn't"); String_64 CompName; pSourceContext->GetComponentName(ComponentIndex, &CompName, TRUE); String_32 LowerLimit; Convert::DoubleToString(pUnit->GetMin(), (StringBase*)&LowerLimit, pUnit->GetDPtoShow()); String_32 UpperLimit; Convert::DoubleToString(pUnit->GetMax(), (StringBase*)&UpperLimit, pUnit->GetDPtoShow()); String_32 QualifierToken; const Qualifier* pQualifier = pUnit->GetQualifier(); if (pQualifier == NULL) { ERROR3("ColourPicker::GetComponentHelp - No qualifier"); return FALSE; } ERROR3IF(!pQualifier->IS_KIND_OF(Qualifier), "ColourPicker::GetComponentHelp - Qualifier isn't"); if (pQualifier->IsShown()) { QualifierToken = pQualifier->GetToken(); } HelpString.MakeMsg(_R(IDS_EDITBH_COMP234), (TCHAR *)CompName, (TCHAR *)LowerLimit, (TCHAR *)UpperLimit, (TCHAR *)QualifierToken); return TRUE; }

BOOL ColourPicker::GetComponentsAsHexString (  IndexedColour *  Source, ColourContext *  DestContext, INT32  ComponentIndex, String_16 *  Result )  [static, protected]

Retrieves the colour definition of the given colour, converts it to the given colour model, and returns the combined value of all components of the definition in that model as a hexadecimal string appropriate for placing into a colour editor dialogue gadget. Author: Chris_Snook (Xara Group Ltd) <camelotdev@xara.com> Date: 11/11/99 Parameters: Source  - The colour from which you wish to extract the component [INPUTS] DestContext - The colour context in which you want the resulting component ComponentIndex - This should be set to -1 at present (cause we are getting all components; and not one in the range 1-4) Result  - returns containing a hexadecimal string representation (rrggbb) [OUTPUTS] Returns: TRUE if the value converted was out of gamut. Notes: At present, this function clips the value to lie within the legal 0.0 to 1.0 gamut range. Scope: private See also: ColourPicker::GetComponentsAsString; ColourPicker::SetComponentsFromHexString Definition at line 1338 of file colpick.cpp. { ERROR2IF(Source == NULL || DestContext == NULL || Result == NULL, FALSE, "NULL parameters are illegal"); // ERROR2IF(!DestContext->IS_KIND_OF(ColourContextWebRGBT), FALSE, // "SourceContext parameter is not of type ColourContextWebRGBT"); if (ComponentIndex == -1) { BOOL OutOfGamut = FALSE; ColourGeneric Defn; DestContext->ConvertColour(Source, &Defn); // Sneakily get the component from the ColourGeneric by treating it as an array // of 4 ColourValue components .... ColourValue *CompPtr = (ColourValue *) &Defn; String_8 ResultR, ResultG, ResultB; for (INT32 i = 1; i < 4; i++) { double CompValue = CompPtr[i-1].MakeDouble(); if (CompValue < 0.0) { CompValue = 0.0; // **** Clip out-of-gamut values. OutOfGamut = TRUE; // Remember that this was out of gamut } if (CompValue > 1.0) { CompValue = 1.0; // **** Clip out-of-gamut values. OutOfGamut = TRUE; // Remember that this was out of gamut } // Generate a 0..100 value, except for Hue, in which case it's 0..360 UnitGroup* pPossibleUnits = DestContext->GetComponentUnitGroup(i); if (pPossibleUnits == NULL) { ERROR3("ColourPicker::GetComponentAsString - pPossibleUnits NULL"); return FALSE; } ERROR3IF(!pPossibleUnits->IS_KIND_OF(UnitGroup), "pPossibleUnits aren't"); ScaleUnit* pUnit = pPossibleUnits->FindUnitFromIndex (1);//GetDefaultUnit(); if (pUnit == NULL) { ERROR3("ColourPicker::GetComponentAsString - Default units NULL"); return FALSE; } ERROR3IF(!pUnit->IS_KIND_OF(ScaleUnit), "pUnits isn't"); switch (i) { case 1: pUnit->StringFromScale(CompValue, &ResultR, 6); break; case 2: pUnit->StringFromScale(CompValue, &ResultG, 6); break; case 3: pUnit->StringFromScale(CompValue, &ResultB, 6); break; } } // convert strings into integers .... INT32 rVal = camAtoi ((const TCHAR*) ResultR); INT32 gVal = camAtoi ((const TCHAR*) ResultG); INT32 bVal = camAtoi ((const TCHAR*) ResultB); // convert integers to base 16 .... camSprintf((TCHAR*)ResultR, _T("%X"), rVal); camSprintf((TCHAR*)ResultG, _T("%X"), gVal); camSprintf((TCHAR*)ResultB, _T("%X"), bVal); String_8 Builder;//FinalResultR, FinalResultG, FinalResultB; // I don't want an _itoa one length rr's, gg's or bb's thankyou very much! // AND glue the results together (== rrggbb) at the same time if (ResultR.Length () == 1) { Builder += (String_8 (TEXT ("0"))) += ResultR; } else { Builder += ResultR; } if (ResultG.Length () == 1) { Builder += (String_8 (TEXT ("0"))) += ResultG; } else { Builder += ResultG; } if (ResultB.Length () == 1) { Builder += (String_8 (TEXT ("0"))) += ResultB; } else { Builder += ResultB; } *Result = Builder; // take that edit box - a correctly built hex string! //if ((ResultR.Length () == 1) || (ResultG.Length () == 1) || (ResultB.Length () == 1)) //{ // *Result += /*(String_8 (TEXT ("0x"))) +=*/ FinalResultR += FinalResultG += FinalResultB; //} //else //{ // *Result += /*(String_8 (TEXT ("0x"))) +=*/ ResultR += ResultG += ResultB; //} return(OutOfGamut); } return (FALSE); // stop that annoying warning about not all paths return a value! }

BOOL ColourPicker::GetShadeValueAsString (  IndexedColour *  Source, INT32  ValueIndex, StringBase *  Result )  [static, protected]

Retrieves the shade of the given colour as a decimal string appropriate for placing into a colour editor dialogue gadget. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 24/10/95 Parameters: Source  - The colour from which you wish to extract the shade value [INPUTS] ValueIndex - 1 to extract the X component 2 to extract the Y component Result  - returns containing a decimal (-100.0 .. 100.0) string representing [OUTPUTS] the value of the given shade component of the colour Returns: TRUE if the value converted was out of gamut. Notes: At present, this function clips the value to lie within the legal -1.0 to 1.0 gamut range. If the colour is not a shade, will ENSURE and return "0%" Scope: private See also: ColourPicker::SetShadeFromStrings Definition at line 2144 of file colpick.cpp. { ERROR3IF(Source == NULL || Result == NULL, "ColourPicker::GetShadeValueAsString - NULL parameters are illegal"); ERROR3IF(ValueIndex != 1 && ValueIndex != 2, "ColourPicker::GetShadeValueAsString - Illegal ValueIndex parameter"); if (Source->GetType() != COLOURTYPE_TINT) { ERROR3("ColourPicker::GetShadeValueAsString - Source colour isn't a tint"); *Result = String_8(_R(IDS_CONVERT_ZERO_CHAR)); // TEXT("0"); return(FALSE); } BOOL OutOfGamut = FALSE; double CompValue; if (ValueIndex == 1) CompValue = -Source->GetShadeValueX().MakeDouble(); else CompValue = Source->GetShadeValueY().MakeDouble(); if (CompValue < -1.0) { CompValue = -1.0; // **** Clip out-of-gamut values. OutOfGamut = TRUE; // Remember that this was out of gamut } if (CompValue > 1.0) { CompValue = 1.0; // **** Clip out-of-gamut values. OutOfGamut = TRUE; // Remember that this was out of gamut } CompValue *= 100.0; String_32 TempString; Convert::DoubleToString(CompValue, (StringBase *) &TempString, 1); TempString.Left(Result, 7); return(OutOfGamut); }

BOOL ColourPicker::GetStatusLineText (  ColourEditDlg *  Editor, UINT32  GadgetID, String_256 *  Result )  [static, protected]

Bodge to get around the fact that DialogOps don't plug into the status line help system. Returns help for the colour editor. Must go via the winoil, as we have to read the mouse position and find the window it's in. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 25/5/95 Parameters: Editor  - points to the current editor [INPUTS] GadgetID - indicates the gadget for which you desire help If  return value is TRUE, Result is updated with an appropriate help string [OUTPUTS] Returns: TRUE if it changed Result, FALSE if it can offer no help See also: ColourEditDlg::GetStatusLineText Definition at line 403 of file colpick.cpp. { #ifndef STANDALONE IndexedColour *Bob = Editor->EditingColour; if (Bob == NULL) { *Result = String_256(_R(IDS_EDITST_NOCOLOUR)); return(TRUE); } ColourContext *cc = ColourContext::GetGlobalDefault(ColourEditDlg::DisplayModel); // Set the default help *Result = String_256(_R(IDS_EDITST_DEFAULT)); if (FALSE) {} // else if (GadgetID == _R(IDCANCEL)) // { // *Result = String_256(_R(IDS_EDITST_CANCEL)); // } else if (GadgetID == _R(IDC_EDIT_DROPMENU)) { *Result = String_256(_R(IDS_EDITST_MENU)); } else if (GadgetID == _R(IDC_EDIT_COMPONENT1)) { if (ColourEditDlg::DisplayModel == COLOURMODEL_HSVT) { *Result = String_256(_R(IDS_EDITST_COMP1)); } else { if (cc != NULL) { String_64 CompName; cc->GetComponentName(1, &CompName, TRUE); Result->MakeMsg(_R(IDS_EDITST_COMP234), (TCHAR *)CompName); } } } else if (GadgetID == _R(IDC_EDIT_COMPONENT2)) { if (cc != NULL) { String_64 CompName; cc->GetComponentName(2, &CompName, TRUE); Result->MakeMsg(_R(IDS_EDITST_COMP234), (TCHAR *)CompName); } } else if (GadgetID == _R(IDC_EDIT_COMPONENT3)) { if (cc != NULL) { String_64 CompName; cc->GetComponentName(3, &CompName, TRUE); Result->MakeMsg(_R(IDS_EDITST_COMP234), (TCHAR *)CompName); } } // WEBSTER - markn 14/12/96 #ifndef WEBSTER else if (GadgetID == _R(IDC_EDIT_COMPONENT4)) { if (cc != NULL) { String_64 CompName; cc->GetComponentName(4, &CompName, TRUE); Result->MakeMsg(_R(IDS_EDITST_COMP234), (TCHAR *)CompName); } } else if (GadgetID == _R(IDC_EDIT_COLMODEL)) { *Result = String_256(_R(IDS_EDITST_COLMODEL)); } else if (GadgetID == _R(IDC_EDIT_NAMEMENU)) { *Result = String_256(_R(IDS_EDITST_NAME)); } else if (GadgetID == _R(IDC_EDIT_COLTYPE)) { *Result = String_256(_R(IDS_EDITST_COLTYPE)); } else if ((GadgetID == _R(IDC_EDIT_INHERIT1)) || (GadgetID == _R(IDC_EDIT_INHERIT2)) || (GadgetID == _R(IDC_EDIT_INHERIT3)) || (GadgetID == _R(IDC_EDIT_INHERIT4))) { *Result = String_256(_R(IDS_EDITST_INHERIT)); } // else if ((GadgetID == _R(IDC_EDIT_PATCH)) || // (GadgetID == _R(IDC_EDIT_PARENTPATCH))) // { // *Result = String_256(_R(IDS_EDITST_PARENTPATCH)); // } else if ((GadgetID == _R(IDC_EDIT_PARENTCOL)) || (GadgetID == _R(IDC_EDIT_PARENTNAME))) { *Result = String_256(_R(IDS_EDITST_PARENTCOL)); } else if ((GadgetID == _R(IDC_EDIT_TINT)) || (GadgetID == _R(IDC_EDIT_TINTSLIDER))) { if (Bob->GetType() == COLOURTYPE_TINT && !Bob->TintIsShade()) *Result = String_256(_R(IDS_EDITST_TINT1)); // It's a tint else *Result = String_256(_R(IDS_EDITST_TINT2)); // It's a shade } else if (GadgetID == _R(IDC_EDIT_SHADE)) { *Result = String_256(_R(IDS_EDITST_TINT2)); // It's a shade } else if (GadgetID == _R(IDC_EDIT_ADVANCED)) { if (Editor->Folded) *Result = String_256(_R(IDS_EDITST_ADVANCED1)); else *Result = String_256(_R(IDS_EDITST_ADVANCED2)); } else if (GadgetID == _R(IDC_EDIT_3D)) { *Result = String_256(_R(IDS_EDITST_3D)); } else if (GadgetID == _R(IDC_EDIT_MAKESTYLE)) { *Result = String_256(_R(IDS_EDITST_MAKESTYLE)); } #endif // WEBSTER else if (GadgetID == _R(IDC_EDIT_PICKER)) { if (!StatusHelpBuffer.IsEmpty()) *Result = StatusHelpBuffer; else { switch(Bob->GetType()) { // WEBSTER - markn 14/12/96 #ifndef WEBSTER case COLOURTYPE_TINT: if (Editor->Folded) *Result = String_256(_R(IDS_EDITST_PICKER1)); else *Result = String_256(_R(IDS_EDITST_PICKER2)); break; case COLOURTYPE_LINKED: *Result = String_256(_R(IDS_EDITST_PICKER3)); break; #endif // WEBSTER case COLOURTYPE_NORMAL: case COLOURTYPE_SPOT: default: *Result = String_256(_R(IDS_EDITST_PICKER4)); break; } } } else if (GadgetID == _R(IDC_EDIT_216ONLY)) { *Result = String_256(_R(IDS_EDITST_216ONLY)); } else if (GadgetID == _R(IDC_COLOURPICKER)) { *Result = String_256(_R(IDS_STATICCOLOURPICKERTOOLHELP)); } else if (GadgetID == _R(IDC_MAKE_LOCAL)) { *Result = String_256(_R(IDS_EDITST_MAKE_LOCAL)); } else if (GadgetID == _R(IDC_EDIT_NOCOLOUR)) { *Result = String_256(_R(IDS_EDITST_SETNOCOLOUR)); } else if (GadgetID == _R(IDC_EDIT_RENAME)) { *Result = String_256(_R(IDS_EDITST_RENAME)); } else if (GadgetID == _R(IDC_EDIT_LINEFILL)) { *Result = String_256(_R(IDS_EDITST_LINEFILL)); } #endif return(TRUE); }

BOOL ColourPicker::GetStatusLineText (  String_256 *  Result  )  [static]

Definition at line 655 of file colpick.cpp. { #ifndef STANDALONE ERROR3IF(Result == NULL, "Illegal NULL param"); ColourEditDlg *Editor = ColourEditDlg::TheEditor; if (Editor == NULL) return(FALSE); // Find the main editor window CWindowID TheWindow = (CWindowID)Editor->WindowID; if (TheWindow == NULL) return(FALSE); wxPoint mousepos = ::wxGetMousePosition(); wxWindow * window=::wxChildWindowFromPoint(TheWindow, mousepos, FALSE, -1); if ((!window) || (window!=::wxChildWindowFromPoint(mousepos, FALSE, -1))) // second check to ensure it is not obscured return FALSE; return GetStatusLineText(Editor, window->GetId(), Result); #else return(TRUE); #endif }

BOOL ColourPicker::GetTintAsString (  IndexedColour *  Source, StringBase *  Result )  [static, protected]

Retrieves the tint of the given colour as a decimal string appropriate for placing into a colour editor dialogue gadget. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 23/8/95 Parameters: Source  - The colour from which you wish to extract the tint [INPUTS] Result  - returns containing a decimal (0.0 .. 100.0) string representing [OUTPUTS] the value of the tint component of the colour Returns: TRUE if the value converted was out of gamut. Notes: At present, this function clips the value to lie within the legal 0.0 to 1.0 gamut range. If the colour is not a tint, will ENSURE and return "0%" Scope: private See also: ColourPicker::SetTintFromString Definition at line 1989 of file colpick.cpp. { ERROR3IF(Source == NULL || Result == NULL, "ColourPicker::GetComponentAsString - NULL parameters are illegal"); if (Source->GetType() != COLOURTYPE_TINT) { ERROR3("ColourPicker::GetTintAsString: Source colour isn't a tint"); *Result = String_8(_R(IDS_CONVERT_ZERO_CHAR)); //TEXT("0"); return(FALSE); } BOOL OutOfGamut = FALSE; double CompValue; if (Source->TintIsShade()) CompValue = Source->GetShadeValueY().MakeDouble(); else CompValue = Source->GetTintValue().MakeDouble(); if (CompValue < 0.0) { CompValue = 0.0; // **** Clip out-of-gamut values. OutOfGamut = TRUE; // Remember that this was out of gamut } if (CompValue > 1.0) { CompValue = 1.0; // **** Clip out-of-gamut values. OutOfGamut = TRUE; // Remember that this was out of gamut } CompValue *= 100.0; String_32 TempString; Convert::DoubleToString(CompValue, (StringBase *) &TempString, 1); TempString.Left(Result, 7); return(OutOfGamut); }

TCHAR * ColourPicker::HelpCallbackHandler (  CWindowID  Window, UINT32  Item, void *  UserData )  [static, protected]

Help callback handler to provide bubble help for the colour editor. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 27/9/95 Parameters: Window  - identifies the window to get help for [INPUTS] Item - identifies the control to get help for UserData - User-supplied data (not used) Returns: The bubble help string to use, or NULL if no help is available See also: ColourPicker::UpdateBubbleHelpAndPointer Definition at line 702 of file colpick.cpp. { #ifndef STANDALONE static String_256 HelpStringStore; BOOL ReturnVal = FALSE; ColourEditDlg *Editor = ColourEditDlg::TheEditor; if (Editor == NULL) return(NULL); IndexedColour *Bob = Editor->EditingColour; ColourContext *cc = NULL; if (Bob != NULL) cc = ColourContext::GetGlobalDefault(