diff options
Diffstat (limited to 'source/text/sbasic/shared/03/sf_dialogcontrol.xhp')
| -rw-r--r-- | source/text/sbasic/shared/03/sf_dialogcontrol.xhp | 38 |
1 files changed, 19 insertions, 19 deletions
diff --git a/source/text/sbasic/shared/03/sf_dialogcontrol.xhp b/source/text/sbasic/shared/03/sf_dialogcontrol.xhp index 59bb03085d..c29d82c65f 100644 --- a/source/text/sbasic/shared/03/sf_dialogcontrol.xhp +++ b/source/text/sbasic/shared/03/sf_dialogcontrol.xhp @@ -19,8 +19,8 @@ <bookmark localize="false" branch="index" id="bm_id41582391760252"> <bookmark_value>DialogControl service</bookmark_value> </bookmark> - <h1 id="bm_id781582391760253" xml-lang="en-US"><variable id="ctrls_h1"><link href="text/sbasic/shared/03/sf_dialogcontrol.xhp" name="SFDialogs.DialogControl service"><literal>SFDialogs</literal>.<literal>DialogControl</literal> service</link></variable></h1> - <paragraph role="paragraph" id="par_id931583589764919" xml-lang="en-US">The <literal>DialogControl</literal> service manages the controls belonging to a dialog defined with the Basic <link href="text/sbasic/guide/create_dialog.xhp" name="Dialog Editor">Dialog Editor</link>. Each instance of the current service represents a single control within a dialog box.</paragraph> + <h1 id="bm_id781582391760253" xml-lang="en-US"><variable id="ctrls_h1"><link href="text/sbasic/shared/03/sf_dialogcontrol.xhp"><literal>SFDialogs</literal>.<literal>DialogControl</literal> service</link></variable></h1> + <paragraph role="paragraph" id="par_id931583589764919" xml-lang="en-US">The <literal>DialogControl</literal> service manages the controls belonging to a dialog defined with the Basic <link href="text/sbasic/guide/create_dialog.xhp">Dialog Editor</link>. Each instance of the current service represents a single control within a dialog box.</paragraph> <bookmark xml-lang="en-US" branch="index" id="bm_id331612167249331" localize="false"> <bookmark_value>API;awt.XControl</bookmark_value> <bookmark_value>API;awt.XControlModel</bookmark_value> @@ -29,7 +29,7 @@ <paragraph role="paragraph" id="par_id981598191184526" xml-lang="en-US">Note that the unique <literal>DialogControl.Value</literal> property content varies according to the control type.</paragraph> <paragraph role="paragraph" id="par_id991612698027551" xml-lang="en-US">A special attention is given to controls of type tree control. It is easy to populate a tree, either branch by branch, or with a set of branches at once. Populating a tree control can be performed statically or dynamically.</paragraph> </section> - <tip id="par_id891598188164936" xml-lang="en-US">The <literal>SFDialogs.DialogControl</literal> service is closely related to the <link href="text/sbasic/shared/03/sf_dialog.xhp" name="Dialog service"><literal>SFDialogs.Dialog</literal></link> service.</tip> + <tip id="par_id891598188164936" xml-lang="en-US">The <literal>SFDialogs.DialogControl</literal> service is closely related to the <link href="text/sbasic/shared/03/sf_dialog.xhp"><literal>SFDialogs.Dialog</literal></link> service.</tip> <h2 id="hd_id581582885621841" xml-lang="en-US">Service invocation</h2> <paragraph role="paragraph" id="par_id141609955500101">Before using the <literal>DialogControl</literal> service the <literal>ScriptForge</literal> library needs to be loaded or imported:</paragraph> <embed href="text/sbasic/shared/03/lib_ScriptForge.xhp#importLibs"/> @@ -218,7 +218,7 @@ <paragraph id="par_id51612705482172" role="tablecontent" localize="false">TreeControl</paragraph> </tablecell> <tablecell> - <paragraph id="par_id1001612705482919" role="tablecontent" xml-lang="en-US">The currently upmost node selected in the tree control. Refer to <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1awt_1_1tree_1_1XMutableTreeNode.html" name="awt.tree.XMutableTreeNode">XmutableTreeNode</link> in Application Programming Interface (API) documentation for detailed information.</paragraph> + <paragraph id="par_id1001612705482919" role="tablecontent" xml-lang="en-US">The currently upmost node selected in the tree control. Refer to <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1awt_1_1tree_1_1XMutableTreeNode.html">XmutableTreeNode</link> in Application Programming Interface (API) documentation for detailed information.</paragraph> </tablecell> </tablerow> <tablerow> @@ -426,7 +426,7 @@ <paragraph id="par_id581612700624717" role="tablecontent" localize="false">TreeControl</paragraph> </tablecell> <tablecell> - <paragraph id="par_id11612700624514" role="tablecontent" xml-lang="en-US">An object representing the lowest root node (usually there is only one such root node). Refer to <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1awt_1_1tree_1_1XMutableTreeNode.html" name="awt.tree.XMutableTreeNode">XmutableTreeNode</link> in Application Programming Interface (API) documentation for detailed information.</paragraph> + <paragraph id="par_id11612700624514" role="tablecontent" xml-lang="en-US">An object representing the lowest root node (usually there is only one such root node). Refer to <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1awt_1_1tree_1_1XMutableTreeNode.html">XmutableTreeNode</link> in Application Programming Interface (API) documentation for detailed information.</paragraph> </tablecell> </tablerow> <tablerow> @@ -509,7 +509,7 @@ </tablecell> <tablecell></tablecell> <tablecell> - <paragraph id="par_id1001598540024225" role="tablecontent" xml-lang="en-US">Refer to <link href="text/sbasic/shared/03/sf_dialogcontrol.xhp#hd_id81598540704978" name="Value property">Value property</link></paragraph> + <paragraph id="par_id1001598540024225" role="tablecontent" xml-lang="en-US">Refer to <link href="text/sbasic/shared/03/sf_dialogcontrol.xhp#hd_id81598540704978">Value property</link></paragraph> </tablecell> </tablerow> <tablerow> @@ -543,7 +543,7 @@ <paragraph id="par_id311598540066789" role="tablecontent" xml-lang="en-US">All</paragraph> </tablecell> <tablecell> - <paragraph id="par_id191598177924897" role="tablecontent" xml-lang="en-US">The UNO object representing the control model. Refer to <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1awt_1_1XControlModel.html" name="awt.XControlModel">XControlModel</link> and <link href="https://api.libreoffice.org/docs/idl/ref/servicecom_1_1sun_1_1star_1_1awt_1_1UnoControlDialogModel.html)" name="awt.XControlDialogModel">UnoControlDialogModel</link> in Application Programming Interface (API) documentation for detailed information.</paragraph> + <paragraph id="par_id191598177924897" role="tablecontent" xml-lang="en-US">The UNO object representing the control model. Refer to <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1awt_1_1XControlModel.html">XControlModel</link> and <link href="https://api.libreoffice.org/docs/idl/ref/servicecom_1_1sun_1_1star_1_1awt_1_1UnoControlDialogModel.html)">UnoControlDialogModel</link> in Application Programming Interface (API) documentation for detailed information.</paragraph> </tablecell> </tablerow> <tablerow> @@ -560,7 +560,7 @@ <paragraph id="par_id551598540079329" role="tablecontent" xml-lang="en-US">All</paragraph> </tablecell> <tablecell> - <paragraph id="par_id731598178083442" role="tablecontent" xml-lang="en-US">The UNO object representing the control view. Refer to <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1awt_1_1XControl.html" name="awt.XControl">XControl</link> and <link href="https://api.libreoffice.org/docs/idl/ref/servicecom_1_1sun_1_1star_1_1awt_1_1UnoControlDialog.html)" name="awt.UnoControlDialog">UnoControlDialog</link> in Application Programming Interface (API) documentation for detailed information.</paragraph> + <paragraph id="par_id731598178083442" role="tablecontent" xml-lang="en-US">The UNO object representing the control view. Refer to <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1awt_1_1XControl.html">XControl</link> and <link href="https://api.libreoffice.org/docs/idl/ref/servicecom_1_1sun_1_1star_1_1awt_1_1UnoControlDialog.html)">UnoControlDialog</link> in Application Programming Interface (API) documentation for detailed information.</paragraph> </tablecell> </tablerow> <tablerow> @@ -577,7 +577,7 @@ <paragraph id="par_id25161269944611" role="tablecontent" localize="false">TreeControl</paragraph> </tablecell> <tablecell> - <paragraph id="par_id691612699446892" role="tablecontent" xml-lang="en-US">The UNO object representing the tree control data model. Refer to <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1awt_1_1tree_1_1XMutableTreeDataModel.html" name="awt.tree.XMutableTreeDataModel">XMutableTreeDataModel</link> in Application Programming Interface (API) documentation for detailed information.</paragraph> + <paragraph id="par_id691612699446892" role="tablecontent" xml-lang="en-US">The UNO object representing the tree control data model. Refer to <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1awt_1_1tree_1_1XMutableTreeDataModel.html">XMutableTreeDataModel</link> in Application Programming Interface (API) documentation for detailed information.</paragraph> </tablecell> </tablerow> </table> @@ -767,7 +767,7 @@ </tablerow> </table> <h2 id="hd_id421612628828054" xml-lang="en-US">Event properties</h2> - <paragraph role="paragraph" id="par_id41612629140856" xml-lang="en-US">Returns a URI string with the reference to the script triggered by the event. Read its specification in the <link href="https://wiki.documentfoundation.org/Documentation/DevGuide/Scripting_Framework#Scripting_Framework_URI_Specification" name="URI specification">scripting framework URI specification</link>.</paragraph> + <paragraph role="paragraph" id="par_id41612629140856" xml-lang="en-US">Returns a URI string with the reference to the script triggered by the event. Read its specification in the <link href="https://wiki.documentfoundation.org/Documentation/DevGuide/Scripting_Framework#Scripting_Framework_URI_Specification">scripting framework URI specification</link>.</paragraph> <table id="tab_id951612628879819"> <tablerow> <tablecell> @@ -966,17 +966,17 @@ </tablerow> <tablerow> <tablecell><paragraph id="par_id751612709117248" role="tablecontent" localize="false"> - <link href="text/sbasic/shared/03/sf_dialogcontrol.xhp#AddSubNode" name="AddSubNode method">AddSubNode</link><br/> - <link href="text/sbasic/shared/03/sf_dialogcontrol.xhp#AddSubTree" name="AddSubTree method">AddSubTree</link><br/> - <link href="text/sbasic/shared/03/sf_dialogcontrol.xhp#CreateRoot" name="CreateRoot method">CreateRoot</link><br/> + <link href="text/sbasic/shared/03/sf_dialogcontrol.xhp#AddSubNode">AddSubNode</link><br/> + <link href="text/sbasic/shared/03/sf_dialogcontrol.xhp#AddSubTree">AddSubTree</link><br/> + <link href="text/sbasic/shared/03/sf_dialogcontrol.xhp#CreateRoot">CreateRoot</link><br/> </paragraph></tablecell> <tablecell><paragraph id="par_id63161270911712" role="tablecontent" localize="false"> - <link href="text/sbasic/shared/03/sf_dialogcontrol.xhp#FindNode" name="FindNode method">FindNode</link><br/> - <link href="text/sbasic/shared/03/sf_dialogcontrol.xhp#SetFocus" name="SetFocus method">SetFocus</link><br/><br/> + <link href="text/sbasic/shared/03/sf_dialogcontrol.xhp#FindNode">FindNode</link><br/> + <link href="text/sbasic/shared/03/sf_dialogcontrol.xhp#SetFocus">SetFocus</link><br/><br/> </paragraph></tablecell> <tablecell><paragraph id="par_id651612709117457" role="tablecontent" localize="false"> - <link href="text/sbasic/shared/03/sf_dialogcontrol.xhp#SetTableData" name="SetTableData method">SetTableData</link><br/> - <link href="text/sbasic/shared/03/sf_dialogcontrol.xhp#WriteLine" name="WriteLine method">WriteLine</link><br/><br/> + <link href="text/sbasic/shared/03/sf_dialogcontrol.xhp#SetTableData">SetTableData</link><br/> + <link href="text/sbasic/shared/03/sf_dialogcontrol.xhp#WriteLine">WriteLine</link><br/><br/> </paragraph></tablecell> </tablerow> </table> @@ -987,7 +987,7 @@ <bookmark_value>DialogControl service;AddSubNode</bookmark_value> </bookmark> <h2 id="hd_id791612711823914" localize="false">AddSubNode</h2> - <paragraph role="paragraph" id="par_id831612711823126">Create and return a new node of the tree control as a UNO object subordinate to a parent node. <variable id="XMutableTreeNode">Refer to <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1awt_1_1tree_1_1XMutableTreeNode.html" name="awt.tree.XMutableTreeNode">XMutableTreeNode</link> in Application Programming Interface (API) documentation for detailed information.</variable></paragraph> + <paragraph role="paragraph" id="par_id831612711823126">Create and return a new node of the tree control as a UNO object subordinate to a parent node. <variable id="XMutableTreeNode">Refer to <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1awt_1_1tree_1_1XMutableTreeNode.html">XMutableTreeNode</link> in Application Programming Interface (API) documentation for detailed information.</variable></paragraph> <section id="OnNodeExpanded"> <paragraph role="paragraph" id="par_id741612711823706" xml-lang="en-US">This method may be called before displaying the dialog box to build the initial tree. It may also be called from a dialog or control event - using the <literal>OnNodeExpanded</literal> event - to complete the tree dynamically.</paragraph> </section> @@ -1121,7 +1121,7 @@ </paragraph> <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> <paragraph role="paragraph" id="par_id541613670199211">One argument out of <literal>displayvalue</literal> or <literal>datavalue</literal> must be specified. If both present, one match is sufficient to select the node.</paragraph> - <paragraph role="paragraph" id="par_id591612781589560"><emph>displayvalue</emph>: The pattern to be matched. Refer to <link href="text/sbasic/shared/03/sf_string.xhp#IsLike" name="String service IsLike() method"><literal>SF_String.IsLike()</literal></link> method for the list of possible wildcards. When equal to the zero-length string (default), this display value is not searched for.</paragraph> + <paragraph role="paragraph" id="par_id591612781589560"><emph>displayvalue</emph>: The pattern to be matched. Refer to <link href="text/sbasic/shared/03/sf_string.xhp#IsLike"><literal>SF_String.IsLike()</literal></link> method for the list of possible wildcards. When equal to the zero-length string (default), this display value is not searched for.</paragraph> <embed href="text/sbasic/shared/03/sf_dialogcontrol.xhp#datavalue"/> <paragraph role="paragraph" id="par_id141582384726168"><emph>casesensitive</emph>: Default value is <literal>False</literal></paragraph> <embed href="text/sbasic/shared/00000003.xhp#functexample"/> |