WebAddressDlg Class Reference

The new Web Address dialog. More...

#include <hlinkdlg.h>

Inheritance diagram for WebAddressDlg:

List of all members.

Public Member Functions
	WebAddressDlg ()
	Constructor.
	~WebAddressDlg ()
	Destructor.
void	Do (OpDescriptor *)
	Opens the dialog if it is closed. Closes it if it is open.
void	DoWithParam (OpDescriptor *pOp, OpParam *pParam)
	Performs the WebAddressDlg operation.
virtual MsgResult	Message (Msg *Message)
	This is the message handler for the WebAddressDlg. It simply takes the message and redirects it to one of our Message Handler functions.
Static Public Member Functions
static BOOL	Init ()
	Creates an OpDescriptor for a HotLink Dialog and declares some preferences.
static OpState	GetState (String_256 *, OpDescriptor *)
	Returns the OpState of the dialogue operation.
Static Public Attributes
static const UINT32	IDD = _R(IDD_WEBADDRESSDLG)
static const CDlgMode	Mode = MODELESS
static BOOL	ms_fCorrect = TRUE
Protected Member Functions
BOOL	Create ()
	Creates a Web Address dialogue box. Fails if DialogOp::Create fails to create the box.
void	OnCreate ()
	Handles a message that the dialog has just been created.
void	OnAddButtonClicked ()
	Handles a message that the Add button has been clicked.
void	OnRemoveButtonClicked ()
	Handles a message that the Remove button has been clicked.
void	OnAutoCorrectClicked ()
	Handles a message that the Auto Correct radio button has been clicked.
void	OnDialogChange ()
	Handles a message that something in the dialog has changed.
void	OnSelectionChange ()
	Handles a message that there's been a selection change.
void	SetDialogInitialState ()
	Sets up the dialog in its initial state.
void	SetDialogChangedState ()
	Sets up the dialog once it has been changed.
void	SetDialogInitialControls ()
	Sets up the dialog according to what attributes are applied to the selection. The cases are:.
void	ApplyWebAddress ()
	Applies the values in the dialog box to the selection.
void	RemoveWebAddress ()
	Removes any Web Address which is on the selection (i.e. applies the default Web Address to the selection).
void	ShowURL (TCHAR *pcURL=NULL)
	Shows the URL in the dialog box.
void	ShowURL (UINT32 uiURL)
	Shows the URL in the dialog box.
String_256	GetURL ()
	Finds the value that the URL field contains.
void	ShowCorrect (BOOL fValue=TRUE)
	Shows the AutoCorrect state in the dialog.
BOOL	GetCorrect ()
	Finds the state of the AutoCorrect switch.
void	ShowFrame (TCHAR *pcFrame=NULL)
	Shows the Frame in the dialog box.
void	ShowFrame (UINT32 uiFrame)
	Shows the Frame in the dialog box.
String_256	GetFrame ()
	Finds the value that the Frame combo box contains.
void	ShowClickableArea (UINT32 uiArea)
	Shows the clickable area in the dialog box as follows:.
UINT32	GetClickableArea ()
	Gets the clickable area shown in the dialog box.
void	EnableAdd (BOOL fValue=TRUE)
	Switches the Add button on or off.
void	EnableRemove (BOOL fValue=TRUE)
	Switches the Remove button on or off.
void	ShowWebAddressOnSelection (BOOL fValue=TRUE)
	Changes the text on the Add/Change button to Change if there is a Web Address or Add if there isn't.
WebCommonAttributeResult	FindCommonWebAttribute (WebAddressAttribute *pwaaReturn=NULL)
	Finds if the selection has a common Web Address attribute.
BOOL	SelectionConsistsOfText ()
	To find if the selection is entirely text.
Protected Attributes
BOOL	fDialogIsInInitialState
Static Protected Attributes
static WebAddressDlg *	TheDialog = NULL
static BOOL	DontHandleNextTextMessage = FALSE
Private Member Functions
	CC_DECLARE_DYNCREATE (WebAddressDlg)

---

Detailed Description

The new Web Address dialog.

Author:

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

Date:

15/8/96 - rewritten by Graham 21/3/97

Note that the WebAddressDlg class does not use the WebAddress class in any way! (I did that to confuse you).

Definition at line 156 of file hlinkdlg.h.

---

Constructor & Destructor Documentation

WebAddressDlg::WebAddressDlg (   )

Constructor. Author: Graham_Walmsley (Xara Group Ltd) <camelotdev@xara.com> from Alex Date: 25/3/97 Definition at line 159 of file hlinkdlg.cpp. : DialogOp(WebAddressDlg::IDD, WebAddressDlg::Mode) { //Set our member variable pointer so it points at ourself if (TheDialog == NULL) TheDialog = this; }

WebAddressDlg::~WebAddressDlg (   )

Destructor. Author: Graham_Walmsley (Xara Group Ltd) <camelotdev@xara.com> from Alex Date: 25/3/97 Definition at line 178 of file hlinkdlg.cpp. { //Set our member variable pointer to NULL if (TheDialog == this) TheDialog = NULL; }

---

Member Function Documentation

void WebAddressDlg::ApplyWebAddress (   )  [protected]

Applies the values in the dialog box to the selection. void WebAddressDlg::ApplyWebAddress() Author: Graham_Walmsley (Xara Group Ltd) <camelotdev@xara.com> Date: 21/3/97 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 848 of file hlinkdlg.cpp. { //First get the values out of the dialog box //Note that the function GetFrameComboBoxValue() will compare //the string in the Frame combo box with the list items. //If the string is a list item (such as "New window (_blank)") //the string returned to us will be a short version ("_blank") String_256 strURL=GetURL(); String_256 strFrame=GetFrame(); BOOL fBounding=(GetClickableArea()==1); //Now, create a set of flags which tell us how the Web Address should be corrected WebCorrectFlags wcfToApply; //Since these flags have been created using the default constructor, they //indicate that the URL should not be corrected at all //Now, should we be correcting the URL? if (ms_fCorrect) { //Yes. So set the correction flags to the defaults for this dialog wcfToApply.SetForWebAddressDialog(); } //Now create a Web Address object, which will correct the URL WebAddress urlToApply(strURL, wcfToApply); //And make a new Web Address attribute AttrWebAddress* pNodeToApply=new AttrWebAddress(urlToApply, fBounding, strFrame); //And apply it to the selection AttributeManager::AttributeSelected((NodeAttribute *) pNodeToApply); }

WebAddressDlg::CC_DECLARE_DYNCREATE (  WebAddressDlg   )  [private]

BOOL WebAddressDlg::Create (  void   )  [protected, virtual]

Creates a Web Address dialogue box. Fails if DialogOp::Create fails to create the box. Author: Graham_Walmsley (Xara Group Ltd) <camelotdev@xara.com> after Jason Date: 25/3/97 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: FALSE if it fails Errors: - See also: - Reimplemented from DialogOp. Definition at line 384 of file hlinkdlg.cpp. { if (TheDialog != this) // Allow only one instance of this dialogue open at once return(FALSE); if (DialogOp::Create()) { return(TRUE); } return(FALSE); }

void WebAddressDlg::Do (  OpDescriptor *   )  [virtual]

Opens the dialog if it is closed. Closes it if it is open. Author: Graham_Walmsley (Xara Group Ltd) <camelotdev@xara.com> after Jason Date: 25/3/97 Reimplemented from Operation. Definition at line 350 of file hlinkdlg.cpp. { if (TheDialog==NULL || TheDialog==this) { if (Create()) Open(); else End(); } else { TheDialog->Close(); TheDialog->End(); // Kill existing editor End(); // Kill ourself } }

void WebAddressDlg::DoWithParam (  OpDescriptor *  pOp, OpParam *  pParam )  [virtual]

Performs the WebAddressDlg operation. Author: Graham_Walmsley (Xara Group Ltd) <camelotdev@xara.com> after Alex Date: 25/3/97 Parameters: OpDescriptor  (unused) [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Reimplemented from Operation. Definition at line 413 of file hlinkdlg.cpp. { Do(pOp); }

void WebAddressDlg::EnableAdd (  BOOL  fValue = TRUE  )  [protected]

Switches the Add button on or off. void WebAddressDlg::EnableAdd(BOOL fValue=TRUE) Author: Graham_Walmsley (Xara Group Ltd) <camelotdev@xara.com> Date: 21/3/97 Parameters: TRUE  to allow the user to add the web address [INPUTS] FALSE to prevent the user from adding the Web Address -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 1347 of file hlinkdlg.cpp. { EnableGadget(IDOK, fValue); }

void WebAddressDlg::EnableRemove (  BOOL  fValue = TRUE  )  [protected]

Switches the Remove button on or off. void WebAddressDlg::EnableRemove(BOOL fValue=TRUE) Author: Graham_Walmsley (Xara Group Ltd) <camelotdev@xara.com> Date: 21/3/97 Parameters: TRUE  to allow the user to remove the Web Address [INPUTS] FALSE to prevent the user from removing the Web Address -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 1372 of file hlinkdlg.cpp. { EnableGadget(_R(IDC_WEBADDRESS_REMOVE), fValue); }

WebCommonAttributeResult WebAddressDlg::FindCommonWebAttribute (  WebAddressAttribute *  pwaaReturn = NULL  )  [protected]

Finds if the selection has a common Web Address attribute. WebCommonAttributeResult WebAddressDlg::FindCommonWebAttribute(WebAddressAttribute* pwaaReturn) Author: Graham_Walmsley (Xara Group Ltd) <camelotdev@xara.com> Date: 21/3/97 Parameters: -  [INPUTS] pwaaReturn  The caller should set this to point at a WebAddressAttribute [OUTPUTS] if they want a copy of the applied attribute returned. Returns: WCA_DEFAULT The default WebAddressAttribute is applied to the entire selection WCA_SINGLE The same or identical WebAddressAttributes are applied to the whole selection WCA_MANY Different WebAddressAttributes are applied to the selection WCA_NOSELECTION Nothing is selected It does this by calling Range::FindCommonAttribute, then if there's a single attribute applied, doing a quick check to see if that attribute is the default attribute of its type. Returns: Errors: - See also: - Definition at line 1447 of file hlinkdlg.cpp. { //First we need to get the current selection SelRange* pSelRange=GetApplication()->FindSelection(); //If pSelRange doesn't exist, return No Selection if (!pSelRange) return WCA_NOSELECTION; //Find the common Web Attribute on the selection Range::CommonAttribResult carResult; NodeAttribute* pnaApplied; carResult=pSelRange->FindCommonAttribute(CC_RUNTIME_CLASS(AttrWebAddress), &pnaApplied); //If this function has returned ATTR_NONE or ATTR_MANY, return our //analogous value if (carResult==SelRange::ATTR_NONE) return WCA_NOSELECTION; if (carResult==SelRange::ATTR_MANY) return WCA_MANY; //Otherwise, we know we have one Web Address attribute on the selection. //We must find out whether it is the default attribute //First extract the attribute value from the node we have found WebAddressAttribute* pWebAddressAttribute= (WebAddressAttribute*) pnaApplied->GetAttributeValue(); WebAddressAttribute waaApplied=*pWebAddressAttribute; //And if the user wants this value returned, make a copy of it now if (pwaaReturn) *pwaaReturn=waaApplied; //And get the default Web Address attribute WebAddressAttribute waaDefault; if (AttributeManager::GetDefaultAttribute(ATTR_WEBADDRESS, &waaDefault)) { //If they are the same, return WCA_DEFAULT. //If they are different, return WCA_SINGLE if (!waaApplied.IsDifferent(&waaDefault)) return WCA_DEFAULT; } return WCA_SINGLE; }

UINT32 WebAddressDlg::GetClickableArea (   )  [protected]

Gets the clickable area shown in the dialog box. UINT32 WebAddressDlg::GetClickableArea() Author: Graham_Walmsley (Xara Group Ltd) <camelotdev@xara.com> Date: 21/3/97 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: uiArea A number describing the clickable area: 0 Object shape 1 Rectangle 2 Indeterminate Errors: - See also: - Definition at line 1313 of file hlinkdlg.cpp. { BOOL fObjectShape=GetLongGadgetValue(_R(IDC_WEBADDRESS_OBJECTSHAPE), 0, 0); BOOL fRectangle=GetLongGadgetValue(_R(IDC_WEBADDRESS_RECTANGLE), 0, 0); if (fObjectShape && !fRectangle) return 0; if (!fObjectShape && fRectangle) return 1; return 2; }

BOOL WebAddressDlg::GetCorrect (   )  [protected]

Finds the state of the AutoCorrect switch. BOOL WebAddressDlg::GetCorrect() Author: Graham_Walmsley (Xara Group Ltd) <camelotdev@xara.com> Date: 21/3/97 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: The state of the AutoCorrect switch Errors: - See also: - Definition at line 1094 of file hlinkdlg.cpp. { return GetLongGadgetValue(_R(IDC_WEBADDRESS_CORRECT), FALSE, TRUE, 0); }

String_256 WebAddressDlg::GetFrame (   )  [protected]

Finds the value that the Frame combo box contains. String_256 WebAddressDlg::GetFrame() Author: Graham_Walmsley (Xara Group Ltd) <camelotdev@xara.com> Date: 21/3/97 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: The string in the Frame combo box or, if the string in the combo box is one of our preset strings (such as "New window (_blank)"), then we return a shorter version of that string ("_blank"). Errors: - See also: - Technical details: We could use "GetSelectedValueIndex()" to find if one of our preset strings had been selected. But consider the case where the user selected one of our present strings, then accidentally clicked in the Frame edit field without changing anythin. In this case, the selected value (-1) would tell us that the combo box held a value that the user had typed in the edit field...not one of the preset strings. So, instead, to find if one of our preset strings is in the combo box, we do a direct string comparison. Definition at line 1232 of file hlinkdlg.cpp. { //Get the string from the combo box String_256 strCombo=GetStringGadgetValue(_R(IDC_WEBADDRESS_FRAME)); //Check the string to see if it's one we want to stop if (strCombo==String_256(_R(IDS_WEBADDRESS_COMBO_SELF))) return String_256(_R(IDS_WEBADDRESS_SHORT_SELF)); if (strCombo==String_256(_R(IDS_WEBADDRESS_COMBO_PARENT))) return String_256(_R(IDS_WEBADDRESS_SHORT_PARENT)); if (strCombo==String_256(_R(IDS_WEBADDRESS_COMBO_TOP))) return String_256(_R(IDS_WEBADDRESS_SHORT_TOP)); if (strCombo==String_256(_R(IDS_WEBADDRESS_COMBO_BLANK))) return String_256(_R(IDS_WEBADDRESS_SHORT_BLANK)); if (strCombo==String_256(_R(IDS_WEBADDRESS_COMBO_DEFAULT))) return String_256(_R(IDS_WEBADDRESS_SHORT_DEFAULT)); //Otherwise, simply return the string return strCombo; }

OpState WebAddressDlg::GetState (  String_256 *  , OpDescriptor *  )  [static]

Returns the OpState of the dialogue operation. Author: Graham_Walmsley (Xara Group Ltd) <camelotdev@xara.com> after Alex Date: 25/3/97 Definition at line 287 of file hlinkdlg.cpp. { OpState OpSt; // Tick the menu while the editor is open if (TheDialog != NULL) OpSt.Ticked = TRUE; return(OpSt); }

String_256 WebAddressDlg::GetURL (   )  [protected]

Finds the value that the URL field contains. String_256 WebAddressDlg::GetURL() Author: Graham_Walmsley (Xara Group Ltd) <camelotdev@xara.com> Date: 21/3/97 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: The string in the URL field Errors: - See also: - Definition at line 1042 of file hlinkdlg.cpp. { return GetStringGadgetValue(_R(IDC_WEBADDRESS_URL)); }

BOOL WebAddressDlg::Init (  void   )  [static]

Creates an OpDescriptor for a HotLink Dialog and declares some preferences. Author: Graham_Walmsley (Xara Group Ltd) <camelotdev@xara.com> after Alex Date: 25/3/97 Returns: FALSE if it fails (due to lack of memory) Reimplemented from SimpleCCObject. Definition at line 311 of file hlinkdlg.cpp. { if (Camelot.DeclareSection(TEXT("WebAddressDlg"), 2)) Camelot.DeclarePref(TEXT("WebAddressDlg"), TEXT("Correct"), &ms_fCorrect); return (RegisterOpDescriptor(0, // Tool ID _R(IDS_WEBADDRESS_DLG), // String resouirce ID CC_RUNTIME_CLASS(WebAddressDlg), // Runtime class OPTOKEN_WEBADDRESSDLG, // Token string WebAddressDlg::GetState, // GetState function 0, // Help ID _R(IDBBL_WEBADDRESS), // Bubble ID _R(IDD_BARCONTROLSTORE), // Resource ID _R(IDC_BTN_WEBADDRESSDLG), // Control ID SYSTEMBAR_UTILITIES, // Bar ID TRUE, // Recieve system messages FALSE, // Smart duplicate operation TRUE, // Clean operation 0, // No vertical counterpart NULL, (DONT_GREY_WHEN_SELECT_INSIDE | GREY_WHEN_NO_CURRENT_DOC) )); }

MsgResult WebAddressDlg::Message (  Msg *  Message  )  [virtual]

This is the message handler for the WebAddressDlg. It simply takes the message and redirects it to one of our Message Handler functions. Author: Graham_Walmsley (Xara Group Ltd) <camelotdev@xara.com> Date: 25/3/97 Parameters: Message,:  The incoming message [INPUTS] Returns: DialogOp::Message (Message) Reimplemented from DialogOp. Definition at line 199 of file hlinkdlg.cpp. { BOOL fEndDialog=FALSE; //If the message is a dialog message if (IS_OUR_DIALOG_MSG(Message)) { //Then work out what it says DialogMsg* pDialogMsg = ((DialogMsg*) Message); switch (pDialogMsg->DlgMsg) { case DIM_CREATE: OnCreate(); break; case DIM_COMMIT: OnAddButtonClicked(); break; case DIM_CANCEL: fEndDialog = TRUE; break; case DIM_TEXT_CHANGED: //This ensures that, when this code changes some text //in an edit field, we don't handle the "text changed" message if (WebAddressDlg::DontHandleNextTextMessage) { WebAddressDlg::DontHandleNextTextMessage=FALSE; } else OnDialogChange(); break; case DIM_LFT_BN_CLICKED: switch(pDialogMsg->GadgetID) { case _R(IDC_WEBADDRESS_REMOVE): OnRemoveButtonClicked(); break; case _R(IDC_WEBADDRESS_OBJECTSHAPE): case _R(IDC_WEBADDRESS_RECTANGLE): OnDialogChange(); break; case _R(IDC_WEBADDRESS_CORRECT): OnAutoCorrectClicked(); break; } break; //NB: This means someone has altered the combo box. It doesn't mean //the selection has changed! case DIM_SELECTION_CHANGED: OnDialogChange(); break; } } else if (MESSAGE_IS_A(Message, SelChangingMsg)) { if ( ((SelChangingMsg*)Message)->State == SelChangingMsg::SELECTIONCHANGED ) OnSelectionChange(); } if (fEndDialog) { Close(); End(); } return DialogOp::Message(Message); }

void WebAddressDlg::OnAddButtonClicked (   )  [protected]

Handles a message that the Add button has been clicked. void WebAddressDlg::OnAddButtonClicked() Author: Graham_Walmsley (Xara Group Ltd) <camelotdev@xara.com> Date: 21/3/97 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: WebAddressDlg::Message() Definition at line 475 of file hlinkdlg.cpp. { //Apply the current Web Address to the selection ApplyWebAddress(); //Set up the dialog in its initial state SetDialogInitialState(); //And throw away the keyboard focus DialogManager::DefaultKeyboardFocus(); }

void WebAddressDlg::OnAutoCorrectClicked (   )  [protected]

Handles a message that the Auto Correct radio button has been clicked. void WebAddressDlg::OnAutoCorrectClicked() Author: Graham_Walmsley (Xara Group Ltd) <camelotdev@xara.com> Date: 21/3/97 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: WebAddressDlg::Message() Definition at line 533 of file hlinkdlg.cpp. { //Update our member variable ms_fCorrect=GetCorrect(); }

void WebAddressDlg::OnCreate (   )  [protected]

Handles a message that the dialog has just been created. void WebAddressDlg::OnCreate() Author: Graham_Walmsley (Xara Group Ltd) <camelotdev@xara.com> Date: 21/3/97 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: WebAddressDlg::Message() Definition at line 448 of file hlinkdlg.cpp. { //Set up the dialog in its initial state SetDialogInitialState(); //And put the keyboard focus in the URL edit field SetKeyboardFocus(_R(IDC_WEBADDRESS_URL)); HighlightText(_R(IDC_WEBADDRESS_URL)); }

void WebAddressDlg::OnDialogChange (   )  [protected]

Handles a message that something in the dialog has changed. void WebAddressDlg::OnDialogChange() Author: Graham_Walmsley (Xara Group Ltd) <camelotdev@xara.com> Date: 21/3/97 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Note that the AutoCorrect switch is independent of the rest of the dialog and so changing that doesn't count as changing the dialog. Returns: Errors: - See also: WebAddressDlg::Message() Definition at line 560 of file hlinkdlg.cpp. { //Set the dialog into its changed state SetDialogChangedState(); }

void WebAddressDlg::OnRemoveButtonClicked (   )  [protected]

Handles a message that the Remove button has been clicked. void WebAddressDlg::OnRemoveButtonClicked() Author: Graham_Walmsley (Xara Group Ltd) <camelotdev@xara.com> Date: 21/3/97 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: WebAddressDlg::Message() Definition at line 504 of file hlinkdlg.cpp. { //Remove the Web Address from the current selection RemoveWebAddress(); //Set up the dialog in its initial state SetDialogInitialState(); //And throw away the keyboard focus DialogManager::DefaultKeyboardFocus(); }

void WebAddressDlg::OnSelectionChange (   )  [protected]

Handles a message that there's been a selection change. void WebAddressDlg::OnSelectionChange() Author: Graham_Walmsley (Xara Group Ltd) <camelotdev@xara.com> Date: 21/3/97 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: WebAddressDlg::Message() Definition at line 584 of file hlinkdlg.cpp. { //Put the dialog into its initial state SetDialogInitialState(); }

void WebAddressDlg::RemoveWebAddress (   )  [protected]

Removes any Web Address which is on the selection (i.e. applies the default Web Address to the selection). void WebAddressDlg::RemoveWebAddress() Author: Graham_Walmsley (Xara Group Ltd) <camelotdev@xara.com> Date: 21/3/97 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 903 of file hlinkdlg.cpp. { //Simply get the default Web Address WebAddressAttribute waaDefault; if (AttributeManager::GetDefaultAttribute(ATTR_WEBADDRESS, &waaDefault)) { //Make it into an AttrWebAddress AttrWebAddress* pNodeToApply=new AttrWebAddress(); if (pNodeToApply) { pNodeToApply->Value=waaDefault; //And apply it to the selection AttributeManager::AttributeSelected((NodeAttribute *) pNodeToApply); } } }

BOOL WebAddressDlg::SelectionConsistsOfText (   )  [protected]

To find if the selection is entirely text. BOOL WebAddressDlg::SelectionConsistsOfText() Author: Graham_Walmsley (Xara Group Ltd) <camelotdev@xara.com> Date: 24/3/97 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: TRUE if the selection consists entirely of text objects FALSE otherwise Errors: If there is no selection See also: Range::ConsistsOf Definition at line 1520 of file hlinkdlg.cpp. { //First get the current selection SelRange* pSelection=GetApplication()->FindSelection(); //And use the Range::ConsistsOf function to find whether the selection //is entirely text. if (pSelection) return pSelection->ConsistsOf(CC_RUNTIME_CLASS(BaseTextClass)); else return FALSE; }

void WebAddressDlg::SetDialogChangedState (   )  [protected]

Sets up the dialog once it has been changed. void WebAddressDlg::SetDialogChangedState() Author: Graham_Walmsley (Xara Group Ltd) <camelotdev@xara.com> Date: 21/3/97 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - This means: If there is a selection, the ADD/CHANGE button is ungreyed If there is a Web Address on the Selection, the ADD/CHANGE button will read "Change", otherwise it will read "Add" Returns: Errors: - See also: WebAddressDlg::OnSelectionChange(), WebAddressDlg::OnCreate(), WebAddressDlg::OnAddButtonClicked() Definition at line 661 of file hlinkdlg.cpp. { //If the dialog is still in its initial state... if (fDialogIsInInitialState) { //Then we need to change some things //First, let's find the state of the Web Address attributes applied to the //selection WebCommonAttributeResult aasApplied=FindCommonWebAttribute(); //If anything at all is selected if (aasApplied!=WCA_NOSELECTION) { //Then we need to ungrey the Add/Change button EnableAdd(TRUE); //We also need to clear any intermediate values from the dialog //If the URL field says <MANY>, clear that field if (GetURL()==String_256(_R(IDS_WEBADDRESSDLG_MANY))) ShowURL(); //If the Frame field says <MANY>, put "self" into that field if (GetFrame()==String_256(_R(IDS_WEBADDRESSDLG_MANY))) ShowFrame(String_256(_R(IDS_WEBADDRESS_COMBO_SELF))); //If the clickable area is indeterminate, show the //recommended value for the selection in the radio buttons if (GetClickableArea()==2) ShowClickableArea(SelectionConsistsOfText()); } //If there is no Web Address on the selection, tell the user //so if (aasApplied==WCA_DEFAULT) ShowWebAddressOnSelection(FALSE); //If there is any sort of Web Address on the selection, tell the //user if (aasApplied==WCA_SINGLE || aasApplied==WCA_MANY) ShowWebAddressOnSelection(TRUE); } //The dialog is no longer in its initial state fDialogIsInInitialState=FALSE; }

void WebAddressDlg::SetDialogInitialControls (   )  [protected]

Sets up the dialog according to what attributes are applied to the selection. The cases are:. void WebAddressDlg::SetDialogInitialControls() Author: Graham_Walmsley (Xara Group Ltd) <camelotdev@xara.com> Date: 21/3/97 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - If a single attribute is applied, that attribute will be put into the dialog box. The Add button button will be greyed and the Remove button will be active. If many attributes are applied, the dialog box edit fields will be set to read "<Many>" and both radio buttons will be switched off. The Remove button will be active and the Add button will be inactive. If nothing is selected, the dialog box edit fields will be cleared and both radio buttons will be switched off. The Add and Remove buttons will both be inactive. If the default attribute is applied, the dialog box edit fields will be cleared and: if the selection consists only of text, the "rectangle surrounding object" radio button will be selected otherwise, the "object shape" radio button will be selected. Returns: Errors: - See also: WebAddressDlg::OnSelectionChange(), WebAddressDlg::OnCreate(), WebAddressDlg::OnAddButtonClicked() Definition at line 754 of file hlinkdlg.cpp. { //First, we want to know what the WebAddressAttribute applied to the selection //is. //This variable will hold that attribute WebAddressAttribute waaApplied; //Then call this function to find the state of the WebAddressAttribute(s) //applied to the selection WebCommonAttributeResult aasApplied=FindCommonWebAttribute(&waaApplied); //Edit field and combo box //First set up the combo box list DeleteAllValues(_R(IDC_WEBADDRESS_FRAME)); SetStringGadgetValue(_R(IDC_WEBADDRESS_FRAME), _R(IDS_WEBADDRESS_COMBO_SELF), FALSE, 0); SetStringGadgetValue(_R(IDC_WEBADDRESS_FRAME), _R(IDS_WEBADDRESS_COMBO_PARENT), FALSE, 1); SetStringGadgetValue(_R(IDC_WEBADDRESS_FRAME), _R(IDS_WEBADDRESS_COMBO_TOP), FALSE, 2); SetStringGadgetValue(_R(IDC_WEBADDRESS_FRAME), _R(IDS_WEBADDRESS_COMBO_BLANK), FALSE, 3); SetStringGadgetValue(_R(IDC_WEBADDRESS_FRAME), _R(IDS_WEBADDRESS_COMBO_DEFAULT), FALSE, 4); SetComboListLength(_R(IDC_WEBADDRESS_FRAME)); // If a single attribute is applied or the default attribute // is applied, set it into the edit fields if (aasApplied==WCA_SINGLE || aasApplied==WCA_DEFAULT) { ShowURL(waaApplied.m_url.GetWebAddress()); ShowFrame(waaApplied.m_pcFrame); } //If many attributes are applied, put <Many> into the edit fields if (aasApplied==WCA_MANY) { ShowURL(String_256(_R(IDS_WEBADDRESSDLG_MANY))); ShowFrame(String_256(_R(IDS_WEBADDRESSDLG_MANY))); } //If nothing is selected, clear the edit fields if (aasApplied==WCA_NOSELECTION) { ShowURL(); ShowFrame(); } //Radio buttons //If a single attribute is applied, set the radio buttons accordingly if (aasApplied==WCA_SINGLE) ShowClickableArea(waaApplied.m_fBounding); //If many attributes are applied, or if nothing is selected, //give the radio buttons an indeterminate value if (aasApplied==WCA_MANY || aasApplied==WCA_NOSELECTION) ShowClickableArea(2); //If the default attribute is applied to the selection... if (aasApplied==WCA_DEFAULT) //Then if the selection consists only of text, set the "Rectangle" radio button. //Otherwise, set the "Object shape" radio button ShowClickableArea(SelectionConsistsOfText()); //AutoCorrect switch ShowCorrect(ms_fCorrect); //Buttons //Grey the Add/Change button EnableAdd(FALSE); //If one or many attributes are applied to the selection, enable the Remove button. //Otherwise, grey the Remove button EnableRemove((aasApplied==WCA_SINGLE || aasApplied==WCA_MANY)); }

void WebAddressDlg::SetDialogInitialState (   )  [protected]

Sets up the dialog in its initial state. void WebAddressDlg::SetDialogInitialState() Author: Graham_Walmsley (Xara Group Ltd) <camelotdev@xara.com> Date: 21/3/97 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - This means: a. Calling another member function to set up the controls so they reflect the Web Address attribute on the selection b. Setting a flag to say that the dialog is in its initial state Returns: Errors: - See also: WebAddressDlg::OnSelectionChange(), WebAddressDlg::OnCreate(), WebAddressDlg::OnAddButtonClicked() Definition at line 627 of file hlinkdlg.cpp. { //Set the controls up in their correct initial state SetDialogInitialControls(); //And set a flag to say the dialog is in its initial state fDialogIsInInitialState=TRUE; }

void WebAddressDlg::ShowClickableArea (  UINT32  uiArea  )  [protected]

Shows the clickable area in the dialog box as follows:. void WebAddressDlg::ShowClickableArea(UINT32 uiArea) Author: Graham_Walmsley (Xara Group Ltd) <camelotdev@xara.com> Date: 21/3/97 Parameters: uiArea  A number describing the clickable area to show: [INPUTS] 0 Object shape 1 Rectangle 2 Indeterminate -  [OUTPUTS] Returns: - 0 Object shape radio button is on, rectangle radio button is off 1 Rectangle radio button is on, object radio button is off 2 Both radio buttons are off Returns: Errors: - See also: - Definition at line 1285 of file hlinkdlg.cpp. { SetLongGadgetValue(_R(IDC_WEBADDRESS_OBJECTSHAPE), (uiArea==0)); SetLongGadgetValue(_R(IDC_WEBADDRESS_RECTANGLE), (uiArea==1)); }

void WebAddressDlg::ShowCorrect (  BOOL  fValue = TRUE  )  [protected]

Shows the AutoCorrect state in the dialog. void WebAddressDlg::ShowCorrect(BOOL fValue) Author: Graham_Walmsley (Xara Group Ltd) <camelotdev@xara.com> Date: 21/3/97 Parameters: fValue  - whether to show the correction features as on or off [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 1068 of file hlinkdlg.cpp. { //Set the switch SetLongGadgetValue(_R(IDC_WEBADDRESS_CORRECT), fValue); }

void WebAddressDlg::ShowFrame (  UINT32  uiFrame  )  [protected]

Shows the Frame in the dialog box. void WebAddressDlg::ShowFrame(UINT32 uiFrame) Author: Graham_Walmsley (Xara Group Ltd) <camelotdev@xara.com> Date: 21/3/97 Parameters: uiFrame  - resource number of the URL to show [INPUTS] -  [OUTPUTS] Returns: TRUE if no problems Errors: - See also: - Definition at line 1184 of file hlinkdlg.cpp. { //First set a flag to ensure we don't handle the "Text changed" message //that will occur when we change the edit field. WebAddressDlg::DontHandleNextTextMessage=TRUE; //Simply set the string SetStringGadgetValue(_R(IDC_WEBADDRESS_FRAME), uiFrame, FALSE, -1); }

void WebAddressDlg::ShowFrame (  TCHAR *  pcFrame = NULL  )  [protected]

Shows the Frame in the dialog box. void WebAddressDlg::ShowFrame(TCHAR* pcFrame) Author: Graham_Walmsley (Xara Group Ltd) <camelotdev@xara.com> Date: 21/3/97 Parameters: pcFrame  - the frame string to show in the field [INPUTS] -  [OUTPUTS] Returns: TRUE if no problems Before showing the string, we check to see if is one of the four short strings (_self, _top, _parent and _blank) that correspond to values in the combo box. If it is, we select the appropriate list item in the combo box instead. Returns: Errors: - See also: - Definition at line 1123 of file hlinkdlg.cpp. { //Is pcFrame NULL? if (pcFrame==NULL) //Yes. So set a blank string in the frame field SetStringGadgetValue(_R(IDC_WEBADDRESS_FRAME), &String_256(""), FALSE, -1); else { //No. //First put the string into one of Camelot's string classes String_256 strFrame=pcFrame; //And check to see if the string is one of our short strings //This if/else statement is basically a large switch statement if (strFrame==String_256(_R(IDS_WEBADDRESS_SHORT_SELF))) SetSelectedValueIndex(_R(IDC_WEBADDRESS_FRAME), 0); else if (strFrame==String_256(_R(IDS_WEBADDRESS_SHORT_PARENT))) SetSelectedValueIndex(_R(IDC_WEBADDRESS_FRAME), 1); else if (strFrame==String_256(_R(IDS_WEBADDRESS_SHORT_TOP))) SetSelectedValueIndex(_R(IDC_WEBADDRESS_FRAME), 2); else if (strFrame==String_256(_R(IDS_WEBADDRESS_SHORT_BLANK))) SetSelectedValueIndex(_R(IDC_WEBADDRESS_FRAME), 3); else if (strFrame==String_256(_R(IDS_WEBADDRESS_SHORT_DEFAULT))) SetSelectedValueIndex(_R(IDC_WEBADDRESS_FRAME), 4); else //Otherwise, set the string in the edit field SetStringGadgetValue(_R(IDC_WEBADDRESS_FRAME), &strFrame, FALSE, -1); } }

void WebAddressDlg::ShowURL (  UINT32  uiURL  )  [protected]

Shows the URL in the dialog box. void WebAddressDlg::ShowURL(UINT32 uiURL) Author: Graham_Walmsley (Xara Group Ltd) <camelotdev@xara.com> Date: 21/3/97 Parameters: uiURL  - resource number of the URL to show [INPUTS] -  [OUTPUTS] Returns: TRUE if no problems Errors: - See also: - Technical details: Whenever we set text into an edit field, a "Text changed" message will be sent round, as if someone had typed into that field. We must ignore this, so we set a flag to do so. This doesn't occur when you set text into a combo box. It's a bug in the Dialog Manager and it should really be fixed. Definition at line 1012 of file hlinkdlg.cpp. { //First set a flag to ensure we don't handle the "Text changed" message //that will occur when we change the edit field. WebAddressDlg::DontHandleNextTextMessage=TRUE; //Simply set the string SetStringGadgetValue(_R(IDC_WEBADDRESS_URL), uiURL, FALSE, -1); }

void WebAddressDlg::ShowURL (  TCHAR *  pcURL = NULL  )  [protected]

Shows the URL in the dialog box. void WebAddressDlg::ShowURL(TCHAR* pcURL) Author: Graham_Walmsley (Xara Group Ltd) <camelotdev@xara.com> Date: 21/3/97 Parameters: pcURL  - the URL string to show in the field [INPUTS] -  [OUTPUTS] Returns: TRUE if no problems Errors: - See also: - Technical details: Whenever we set text into an edit field, a "Text changed" message will be sent round, as if someone had typed into that field. We must ignore this, so we set a flag to do so. This doesn't occur when you set text into a combo box. It's a bug in the Dialog Manager and it should really be fixed. Definition at line 963 of file hlinkdlg.cpp. { //First set a flag to ensure we don't handle the "Text changed" message //that will occur when we change the edit field. WebAddressDlg::DontHandleNextTextMessage=TRUE; //Is pcURL NULL? if (pcURL==NULL) //Yes. So set a blank string in the edit field SetStringGadgetValue(_R(IDC_WEBADDRESS_URL), &String_256(""), FALSE, -1); else { //No. So set the string we have been given in the edit field String_256 strToSet=pcURL; SetStringGadgetValue(_R(IDC_WEBADDRESS_URL), &strToSet, FALSE, -1); } }

void WebAddressDlg::ShowWebAddressOnSelection (  BOOL  fValue = TRUE  )  [protected]

Changes the text on the Add/Change button to Change if there is a Web Address or Add if there isn't. void WebAddressDlg::ShowWebAddressOnSelection(BOOL fValue=TRUE) Author: Graham_Walmsley (Xara Group Ltd) <camelotdev@xara.com> Date: 21/3/97 Parameters: TRUE  to tell the user there is a Web Address on the selection [INPUTS] FALSE to tell the user there is no Web Address on the selection -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 1398 of file hlinkdlg.cpp. { if (fValue) SetStringGadgetValue(IDOK, _R(IDS_ADDBUTTON_CHANGE)); else SetStringGadgetValue(IDOK, _R(IDS_ADDBUTTON_ADD)); }

---

Member Data Documentation

BOOL WebAddressDlg::DontHandleNextTextMessage = FALSE [static, protected]

Definition at line 230 of file hlinkdlg.h.

BOOL WebAddressDlg::fDialogIsInInitialState [protected]

Definition at line 231 of file hlinkdlg.h.

const UINT32 WebAddressDlg::IDD = _R(IDD_WEBADDRESSDLG) [static]

Definition at line 234 of file hlinkdlg.h.

const CDlgMode WebAddressDlg::Mode = MODELESS [static]

Definition at line 235 of file hlinkdlg.h.

BOOL WebAddressDlg::ms_fCorrect = TRUE [static]

Definition at line 239 of file hlinkdlg.h.

WebAddressDlg * WebAddressDlg::TheDialog = NULL [static, protected]

Definition at line 229 of file hlinkdlg.h.

---

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

• Kernel/hlinkdlg.h (r1785/r1282)
• Kernel/hlinkdlg.cpp (r1785/r1282)

---