BarControl Class Reference

This defines a control and its associated OpDescriptor within a bar. It holds separate horz and vert versions of the control in case the appearence and/or functionality changes with the orientation of the bar. More...

#include <bars.h>

Inheritance diagram for BarControl:

List of all members.

Public Member Functions
	BarControl ()
	BarControl (BarControl &other)
BarControl &	operator= (BarControl &other)
void	SetHorzOpDesc (OpDescriptor *pHorzOpDesc)
	Sets the info regarding the horizontal version of this control.
void	SetVertOpDesc (OpDescriptor *pVertOpDesc)
	Sets the info regarding the vertical version of this control.
const SimpleBarControl *	GetHorzControl ()
const SimpleBarControl *	GetVertControl ()
BarControlInfo	GetBarControlInfo (BOOL Horz)
	Allows you to get hold of all the info you need about the required control.
OpDescriptor *	GetOpDescriptor (BOOL Horz)
	For finding the BarControl's opDescriptor.
UINT32	GetBubbleID (BOOL Horz)
	For finding the BarControl's BubbleID.
UINT32	GetStatusID (BOOL Horz)
	For finding the BarControl's StatusID.
BOOL	Read (CCLexFile &file)
	Reads a tokenized form of the control from the given file.
BOOL	Write (CCLexFile &file)
	Writes a tokenized form of the control to the given file.
virtual BOOL	Read (String_256 *)
	Reads the control from the given string This will be in the form of:- Control H "BreakShapes" 0 126 220 V "BreakShapes" 0 126 220.
virtual BOOL	Write (String_256 *)
UINT32	GetUniqueGadgetID ()
void	SetUniqueGadgetID (UINT32 UniqueGadget)
BOOL	IsEnabled ()
BOOL	IsVisible ()
void	SetEnabledState (BOOL enabled)
void	SetVisibleState (BOOL visible)
Private Member Functions
BOOL	ReadSimpleBarControl (String_256 *pString, SimpleBarControl *pSBC)
	Reads a tokenized form of the simple bar control from the given string.
BOOL	ReadSimpleBarControl (CCLexFile &file, SimpleBarControl *pSBC)
	Reads a tokenized form of the simple bar control from the given file.
void	SetOpDesc (SimpleBarControl *pSimpleBC, OpDescriptor *pOpDesc)
	Sets the info for this control using the given op desc It's intended that this be called when a bar control is added to a bar via the toolbar dialogue interface.
Private Attributes
SimpleBarControl	Horizontal
SimpleBarControl	Vertical
UINT32	UniqueGadgetID
BOOL	Enabled
BOOL	Visible

---

Detailed Description

This defines a control and its associated OpDescriptor within a bar. It holds separate horz and vert versions of the control in case the appearence and/or functionality changes with the orientation of the bar.

Author:

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

Date:

5/4/94

Definition at line 235 of file bars.h.

---

Constructor & Destructor Documentation

BarControl::BarControl (   )  [inline]

Definition at line 240 of file bars.h. { Visible = TRUE; }

BarControl::BarControl (  BarControl &  other  )  [inline]

Definition at line 245 of file bars.h. { SetEnabledState(other.IsEnabled()); SetVisibleState(other.IsVisible()); Horizontal = other.Horizontal; Vertical = other.Vertical; }

---

Member Function Documentation

BarControlInfo BarControl::GetBarControlInfo (  BOOL  horz  )

Allows you to get hold of all the info you need about the required control. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 28/3/94 Parameters: horz  - if TRUE = the info on the horz version of this control is returned [INPUTS] if FALSE = the info on the vert version of this control is returned -  [OUTPUTS] Returns: A BarControlInfo class describing the horz/vert control completely Errors: - See also: - Definition at line 3698 of file bars.cpp. { if (horz) return Horizontal.BarCtrlInfo; else return Vertical.BarCtrlInfo; }

UINT32 BarControl::GetBubbleID (  BOOL  horz  )  [virtual]

For finding the BarControl's BubbleID. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 10/5/94 Parameters: horz  - if TRUE = the BubbleID on the horz version of this control is returned [INPUTS] if FALSE = the BubbleID on the vert version of this control is returned -  [OUTPUTS] Returns: BarControl's BubbleID Errors: - See also: - Reimplemented from BarControlBase. Definition at line 3748 of file bars.cpp. { if (horz) return Horizontal.BubbleID; else return Vertical.BubbleID; }

const SimpleBarControl* BarControl::GetHorzControl (   )  [inline]

Definition at line 263 of file bars.h. { return (&Horizontal); }

OpDescriptor * BarControl::GetOpDescriptor (  BOOL  horz  )

For finding the BarControl's opDescriptor. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 28/3/94 Parameters: horz  - if TRUE = the OpDescriptor on the horz version of this control is returned [INPUTS] if FALSE = the OpDescriptor on the vert version of this control is returned -  [OUTPUTS] Returns: BarControl's OpDescriptor Errors: - See also: - Definition at line 3723 of file bars.cpp. { if (horz) return Horizontal.pOpDesc; else return Vertical.pOpDesc; }

UINT32 BarControl::GetStatusID (  BOOL  horz  )  [virtual]

For finding the BarControl's StatusID. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 10/5/94 Parameters: horz  - if TRUE = the StatusID on the horz version of this control is returned [INPUTS] if FALSE = the StatusID on the vert version of this control is returned -  [OUTPUTS] Returns: BarControl's StatusID Errors: - See also: - Reimplemented from BarControlBase. Definition at line 3773 of file bars.cpp. { if (horz) return Horizontal.StatusID; else return Vertical.StatusID; }

UINT32 BarControl::GetUniqueGadgetID (   )  [inline]

Definition at line 279 of file bars.h. { return UniqueGadgetID; }

const SimpleBarControl* BarControl::GetVertControl (   )  [inline]

Definition at line 264 of file bars.h. { return (&Vertical); }

BOOL BarControl::IsEnabled (   )  [inline]

Definition at line 282 of file bars.h. { return Enabled; }

BOOL BarControl::IsVisible (   )  [inline]

Definition at line 283 of file bars.h. { return Visible; }

BarControl& BarControl::operator= (  BarControl &  other  )  [inline]

Definition at line 253 of file bars.h. { SetEnabledState(other.IsEnabled()); SetVisibleState(other.IsVisible()); Horizontal = other.Horizontal; Vertical = other.Vertical; return *this; }

BOOL BarControl::Read (  String_256 *  pString  )  [virtual]

Reads the control from the given string This will be in the form of:- Control H "BreakShapes" 0 126 220 V "BreakShapes" 0 126 220. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 20/2/97 Parameters: pString  = string to read the data for this control out of [INPUTS] Returns: TRUE if successful, FALSE otherwise Code ideas taken from PrintMarksCache::DecodeMarkFormat. Thanks Mike! Returns: Errors: - See also: PrintMarksCache::DecodeMarkFormat; Implements BarItem. Definition at line 3879 of file bars.cpp. { ERROR2IF(pString == NULL,FALSE,"BarControl::Read given null parameters!"); // We will enter here having read in the Control section of the string so we just // need to decode the following sections. // This can consist of an H section and/or a V section. // This text must not be internationalised //const TCHAR SPACE = TEXT(' '); const TCHAR H = TEXT('H'); const TCHAR V = TEXT('V'); const TCHAR B = TEXT('B'); INT32 pos = 0; // Everything is hunky dory at the moment! ER NOT! BOOL AllIsWell = FALSE; // Turn on the exceptions function in the string reading class StringBase::EnableExceptionHandler(); String_256 Name(*pString); try { // See if we have an H or B as the descriptor of the control // B defines both controls at the same time if (Name[pos] == H) { // See if there is an H command and then toast it and the supposed trailing space // if that is successful pos = Name.FindNextChar(H); Name.Remove(0, pos+2); AllIsWell = ReadSimpleBarControl(&Name, &Horizontal); if (AllIsWell) { // See if there is an V command and then toast it and the supposed trailing space // if that is successful pos = Name.FindNextChar(V); Name.Remove(0, pos+2); AllIsWell = ReadSimpleBarControl(&Name, &Vertical); } } else { // Read in both controls as one pos = Name.FindNextChar(B); Name.Remove(0, pos+2); AllIsWell = ReadSimpleBarControl(&Name, &Horizontal); // if horz and vert defs are the same, make vert = horz version. Vertical = Horizontal; } } catch( ... ) { // An exception has been thrown which means // we failed to parse this string, so simply report failure AllIsWell = FALSE; } // Switch off the exception state finally, (and of course pop it)! StringBase::DisableExceptionHandler(); return AllIsWell; }

BOOL BarControl::Read (  CCLexFile &  file  )  [virtual]

Reads a tokenized form of the control from the given file. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 7/4/94 Parameters: file  = a file object [INPUTS] -  [OUTPUTS] Returns: TRUE if successful, FALSE otherwise Errors: - See also: - Implements BarItem. Definition at line 4094 of file bars.cpp. { TokenIndex Token = TOKEN_NONE; const TCHAR* TokenBuf = file.GetTokenBuf(); BOOL ok; ok = file.GetSimpleToken(); // Read the first token if (ok) { Token = FindToken(TokenBuf); // Check that next token defines either the horz or both versions of the control ok = ((Token == TOKEN_BAR_CONTROL_HORZ) || (Token == TOKEN_BAR_CONTROL_BOTH)); if (!ok) TRACE( _T("Expected a '%s' or a '%s', but found '%s'."),TokenTable[TOKEN_BAR_CONTROL_HORZ].Token,TokenTable[TOKEN_BAR_CONTROL_BOTH].Token,TokenBuf); if (ok) ok = ReadSimpleBarControl(file,&Horizontal); } if (ok && Token == TOKEN_BAR_CONTROL_BOTH) // if horz and vert defs are the same, make vert = horz version. Vertical = Horizontal; else if (ok) { // otherwise, read the vert definition ok = file.GetSimpleToken(); if (ok) { Token = FindToken(TokenBuf); ok = (Token == TOKEN_BAR_CONTROL_VERT); if (!ok) TRACE( _T("Expected a '%s', but found '%s'."),TokenTable[TOKEN_BAR_CONTROL_VERT].Token,TokenBuf); if (ok) ok = ReadSimpleBarControl(file,&Vertical); } } if (!ok) { // If something when wrong, tell the debug dudes and give as much info as possible //ENSURE(FALSE,"Error reading a bar control. See TRACE output for details"); TRACE( _T("\n\nError reading a bar control:\n")); TRACE( _T(" Token buffer = %s\n"),TokenBuf); TRACE( _T(" Line buffer = %s\n"),file.GetLineBuf()); } return (ok); }

BOOL BarControl::ReadSimpleBarControl (  CCLexFile &  file, SimpleBarControl *  pSBC )  [private]

Reads a tokenized form of the simple bar control from the given file. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 7/4/94 Parameters: file  = a file object [INPUTS] pSBC = ptr to a SimpleBarControl to fill using tokens from 'file' -  [OUTPUTS] Returns: TRUE if successful, FALSE otherwise Errors: - See also: - Definition at line 4156 of file bars.cpp. { const TCHAR* TokenBuf = file.GetTokenBuf(); BOOL ok; ok = file.GetSimpleToken(); if (ok) { // The first token is either a string describing the op descriptor or // the ID for the bubble help message LexTokenType TokenType = file.GetTokenType(); switch (TokenType) { case TOKEN_STRING : pSBC->pOpDesc = OpDescriptor::FindOpDescriptor( const_cast<TCHAR*>(TokenBuf) ); pSBC->BubbleID = _R(IDBBL_NOOP); pSBC->StatusID = 0; if ((TokenBuf[0] != 0) && (pSBC->pOpDesc == NULL)) { // If there is an op desc token string, but no op desc was found, fail TRACE( _T("Can't find op descriptor! OpToken of missing op = %s\n"),TokenBuf); ok = FALSE; } break; case TOKEN_NORMAL : pSBC->pOpDesc = NULL; // No op descriptor associated with this control // Read the bubble and status bar text IDs ok = (camSscanf(TokenBuf, _T("%li"),&pSBC->BubbleID) == 1); if (!ok) TRACE( _T("Expected a bubble ID, but got '%s'\n"),TokenBuf); if (ok) ok = file.GetSimpleToken(); if (ok) { ok = (camSscanf(TokenBuf,_T("%li"),&pSBC->StatusID) == 1); if (!ok) TRACE( _T("Expected a status ID, but got '%s'\n"),TokenBuf); } break; default : ok = FALSE; // What kind of token is this? Get out of here! TRACE( _T("Don't recognise this token '%s'. Wrong type\n"),TokenBuf); break; } // The next three tokens are the tool ID, resource ID, and the control ID if (ok) ok = file.GetSimpleToken(); if (ok) { // Interpret the next token as an INT32 (dec,hex, or oct) ok = (camSscanf(TokenBuf, _T("%li"),&pSBC->BarCtrlInfo.ToolID) == 1); if (!ok) TRACE( _T("Expected a tool ID, but got '%s'\n"),TokenBuf); if (ok) ok = file.GetSimpleToken(); if (ok) { // Interpret the next token as an INT32 (dec,hex, or oct) ok = (camSscanf(TokenBuf, _T("%li"),&pSBC->BarCtrlInfo.ResourceID) == 1); if (!ok) TRACE( _T("Expected a resource ID, but got '%s'\n"),TokenBuf); if (ok) ok = file.GetSimpleToken(); if (ok) { // Interpret the next token as an INT32 (dec,hex, or oct) ok = (camSscanf(TokenBuf,_T("%li"),&pSBC->BarCtrlInfo.ControlID) == 1); if (!ok) TRACE( _T("Expected a control ID, but got '%s'\n"),TokenBuf); } } } } return ok; }

BOOL BarControl::ReadSimpleBarControl (  String_256 *  pString, SimpleBarControl *  pSBC )  [private]

Reads a tokenized form of the simple bar control from the given string. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 20/2/97 Parameters: pString  = string to read the data for this control out of [INPUTS] pSBC = ptr to a SimpleBarControl to fill using tokens from 'file' -  [OUTPUTS] Returns: TRUE if successful, FALSE otherwise Errors: - See also: - Definition at line 3967 of file bars.cpp. { ERROR2IF(pString == NULL || pSBC == NULL,FALSE,"ReadSimpleBarControl given null parameters!"); String_256 OpName; INT32 pos = 0; // This text must not be internationalised const TCHAR QUOTES = TEXT('"'); // See if a string follows or if a bubble and status ids follow if ((*pString)[pos] == QUOTES) { // Go to the first quote of the first string pos = pString->FindNextChar(QUOTES, pos); pString->Remove(0, pos+1); // Now find the last quote of the first string pos = pString->FindNextChar(QUOTES); // Read the operation name into OpName pString->Left(&OpName, pos); pString->Remove(0, pos+1); pos = 0; // Try and find the OpDescriptor that should be in the system pSBC->pOpDesc = OpDescriptor::FindOpDescriptor(OpName); pSBC->BubbleID = _R(IDBBL_NOOP); pSBC->StatusID = 0; if ((OpName.Length() > 0) && (pSBC->pOpDesc == NULL)) { // If there is an op desc token string, but no op desc was found, fail TRACE( _T("Can't find op descriptor! OpToken of missing op = %s\n"),(TCHAR*)OpName); return FALSE; } } else { // Its as simple control // No op descriptor associated with this control pSBC->pOpDesc = NULL; // Read the bubble and status bar text IDs pSBC->BubbleID = pString->ConvertToInteger(pos); pSBC->StatusID = pString->ConvertToInteger(pos); pString->Remove(0,pos); pos = 0; } // The next three tokens are the tool ID, resource ID, and the control ID pSBC->BarCtrlInfo.ToolID = pString->ConvertToInteger(pos); pSBC->BarCtrlInfo.ResourceID = pString->ConvertToInteger(pos); pSBC->BarCtrlInfo.ControlID = pString->ConvertToInteger(pos); pString->Remove(0,pos); pos = 0; return TRUE; }

void BarControl::SetEnabledState (  BOOL  enabled  )  [inline]

Definition at line 284 of file bars.h. {Enabled = enabled;}

void BarControl::SetHorzOpDesc (  OpDescriptor *  pOpDesc  )

Sets the info regarding the horizontal version of this control. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 19/4/94 Parameters: pOpDesc  = ptr to op desc to use for horizontal control [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 3622 of file bars.cpp. { SetOpDesc(&Horizontal,pOpDesc); }

void BarControl::SetOpDesc (  SimpleBarControl *  pSimpleBC, OpDescriptor *  pOpDesc )  [private]

Sets the info for this control using the given op desc It's intended that this be called when a bar control is added to a bar via the toolbar dialogue interface. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 19/4/94 Parameters: pSimpleBC  = the simple bar control that should be updated [INPUTS] pOpDesc = ptr to op desc to use for given control -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 3666 of file bars.cpp. { // Get ptr to default control info const BarControlInfo* pBarCtrlInfo = pOpDesc->GetBarControlInfo(); // Copy the default info stored in the OpDesc bar ctrl info into // this bar control. pSimpleBC->BarCtrlInfo.ResourceID = pBarCtrlInfo->ResourceID; pSimpleBC->BarCtrlInfo.ControlID = pBarCtrlInfo->ControlID; pSimpleBC->BarCtrlInfo.ToolID = pBarCtrlInfo->ToolID; // Copy ptr to the OpDesc. pSimpleBC->pOpDesc = pOpDesc; }

void BarControl::SetUniqueGadgetID (  UINT32  UniqueGadget  )  [inline]

Definition at line 280 of file bars.h. {UniqueGadgetID = UniqueGadget;}

void BarControl::SetVertOpDesc (  OpDescriptor *  pOpDesc  )

Sets the info regarding the vertical version of this control. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 19/4/94 Parameters: pOpDesc  = ptr to op desc to use for vertical control [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 3642 of file bars.cpp. { SetOpDesc(&Vertical,pOpDesc); }

void BarControl::SetVisibleState (  BOOL  visible  )  [inline]

Definition at line 285 of file bars.h. {Visible = visible;}

BOOL BarControl::Write (  String_256 *   )  [virtual]

Implements BarItem. Definition at line 3801 of file bars.cpp. { ERROR2IF(pString == NULL,FALSE,"Write given null string"); BOOL ok = TRUE; TCHAR buf[10]; // Add that its a bar control *pString += TokenTable[TOKEN_BAR_CONTROL].Token; *pString += _T(" "); // save out the horizontal state starting with the horizontal token *pString += TokenTable[TOKEN_BAR_CONTROL_HORZ].Token; *pString += _T(" "); if (Horizontal.pOpDesc) { *pString += wxT(QUOTE); *pString += Horizontal.pOpDesc->Token; *pString += wxT(QUOTE) wxT(" "); } else { camSnprintf(buf, 9, TEXT("%d "), Horizontal.BubbleID); *pString += buf; camSnprintf(buf, 9, TEXT("%d "), Horizontal.StatusID); *pString += buf; } camSnprintf(buf, 9, TEXT("%d "), Horizontal.BarCtrlInfo.ToolID); *pString += buf; camSnprintf(buf, 9, TEXT("%d "), Horizontal.BarCtrlInfo.ResourceID); *pString += buf; camSnprintf(buf, 9, TEXT("%d "), Horizontal.BarCtrlInfo.ControlID); *pString += buf; *pString += TokenTable[TOKEN_BAR_CONTROL_VERT].Token; *pString += _T(" "); if(Vertical.pOpDesc) { *pString += wxT(QUOTE); *pString += Vertical.pOpDesc->Token; *pString += wxT(QUOTE) wxT(" "); } else { camSnprintf(buf, 9, TEXT("%d "), Vertical.BubbleID); *pString += buf; camSnprintf(buf, 9, TEXT("%d "), Vertical.StatusID); *pString += buf; } camSnprintf(buf, 9, TEXT("%d "), Vertical.BarCtrlInfo.ToolID); *pString += buf; camSnprintf(buf, 9, TEXT("%d "), Vertical.BarCtrlInfo.ResourceID); *pString += buf; camSnprintf(buf, 9, TEXT("%d "), Vertical.BarCtrlInfo.ControlID); *pString += buf; return ok; }

BOOL BarControl::Write (  CCLexFile &  file  )  [virtual]

Writes a tokenized form of the control to the given file. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 28/3/94 Parameters: file  = a file object [INPUTS] -  [OUTPUTS] Returns: TRUE if successful, FALSE otherwise Errors: - See also: - Implements BarItem. Definition at line 4039 of file bars.cpp. { BOOL ok = TRUE; if (ok) ok = file.PutToken(TokenTable[TOKEN_BAR_CONTROL].Token); if (ok) ok = file.PutToken(TokenTable[TOKEN_BAR_CONTROL_HORZ].Token); if(Horizontal.pOpDesc) { if (ok) ok = file.PutString(Horizontal.pOpDesc->Token); } else { if (ok) ok = file.PutToken(Horizontal.BubbleID); if (ok) ok = file.PutToken(Horizontal.StatusID); } if (ok) ok = file.PutToken(Horizontal.BarCtrlInfo.ToolID); if (ok) ok = file.PutToken(Horizontal.BarCtrlInfo.ResourceID); if (ok) ok = file.PutToken(Horizontal.BarCtrlInfo.ControlID); if (ok) ok = file.PutToken(TokenTable[TOKEN_BAR_CONTROL_VERT].Token); if(Vertical.pOpDesc) { if (ok) ok = file.PutString(Vertical.pOpDesc->Token); } else { if (ok) ok = file.PutToken(Vertical.BubbleID); if (ok) ok = file.PutToken(Vertical.StatusID); } if (ok) ok = file.PutToken(Vertical.BarCtrlInfo.ToolID); if (ok) ok = file.PutToken(Vertical.BarCtrlInfo.ResourceID); if (ok) ok = file.PutToken(Vertical.BarCtrlInfo.ControlID); return (ok); }

---

Member Data Documentation

BOOL BarControl::Enabled [private]

Definition at line 304 of file bars.h.

SimpleBarControl BarControl::Horizontal [private]

Definition at line 294 of file bars.h.

UINT32 BarControl::UniqueGadgetID [private]

Definition at line 297 of file bars.h.

SimpleBarControl BarControl::Vertical [private]

Definition at line 295 of file bars.h.

BOOL BarControl::Visible [private]

Definition at line 308 of file bars.h.

---

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

• Kernel/bars.h (r1785/r1386)
• Kernel/bars.cpp (r1785/r1386)

---