* Bug 15239 fixed: Console .tag & .userdata not displayed nor documented 66/19366/3
Samuel GOUGEON [Thu, 10 Aug 2017 19:56:01 +0000 (21:56 +0200)]
  http://bugzilla.scilab.org/15239

Change-Id: I7f035c366fc50095722ef6273e0e9c3bc69d5b14

scilab/CHANGES.md
scilab/modules/graphics/macros/%h_p.sci
scilab/modules/graphics/tests/nonreg_tests/bug_15239.dia.ref [new file with mode: 0644]
scilab/modules/graphics/tests/nonreg_tests/bug_15239.tst [new file with mode: 0644]
scilab/modules/gui/help/en_US/console_properties.xml
scilab/modules/gui/help/ja_JP/console_properties.xml

index 8d8de6c..cdd3a17 100644 (file)
@@ -405,6 +405,7 @@ the [development mailing list](dev@lists.scilab.org) for a particular toolbox.
 * [#15199](http://bugzilla.scilab.org/show_bug.cgi?id=15199): Scilab crash when using fsolve for functions containing other functions.
 * [#15205](http://bugzilla.scilab.org/show_bug.cgi?id=15205): `get_scicos_version` returned the previous version.
 * [#15207](http://bugzilla.scilab.org/show_bug.cgi?id=15207): `xcos(scs_m)` did not work for sub-systems.
+* [#15239](http://bugzilla.scilab.org/show_bug.cgi?id=15239): The console's properties .tag and .userdata were not displayed nor documented.
 * [#15236](http://bugzilla.scilab.org/show_bug.cgi?id=15236): The `isglobal` help page was inaccurate. Examples were erroneous.
 * [#15260](http://bugzilla.scilab.org/show_bug.cgi?id=15260): `sci2exp` was broken for cells, structures, and all types of hypermatrix.
 * [#15266](http://bugzilla.scilab.org/show_bug.cgi?id=15266): Wrong default out_mode in `linear_interpn`.
index 296a04b..675b16d 100755 (executable)
@@ -1041,6 +1041,8 @@ function %h_p(h)
             "ShowHiddenHandles = "+sci2exp(h.showhiddenhandles)
             "ShowHiddenProperties = "+sci2exp(h.showhiddenproperties)
             "UseDeprecatedSkin = "+sci2exp(h.usedeprecatedskin)
+            "user_data = "+fmtuser_data(h.userdata)
+            "tag = "+sci2exp(h.tag)
             ]
             // Light
             // =====================================================================
diff --git a/scilab/modules/graphics/tests/nonreg_tests/bug_15239.dia.ref b/scilab/modules/graphics/tests/nonreg_tests/bug_15239.dia.ref
new file mode 100644 (file)
index 0000000..a0af84c
--- /dev/null
@@ -0,0 +1,28 @@
+// =============================================================================
+// Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+// Copyright (C) 2017 - Samuel GOUGEON
+//
+//  This file is distributed under the same license as the Scilab package.
+// =============================================================================
+// <-- ENGLISH IMPOSED -->
+//
+// <-- Non-regression test for bug 15239 -->
+//
+// <-- Bugzilla URL -->
+// http://bugzilla.scilab.org/15239
+//
+// <-- Short Description -->
+// The console's properties .tag and .userdata were not displayed
+c = get(0);
+c.userdata = [1 2 ; 3 4];
+c.tag = "myConsoleName";
+c
+ c  = 
+Handle of type "Console" with properties:
+=========================================
+Children: []
+ShowHiddenHandles = "off"
+ShowHiddenProperties = "off"
+UseDeprecatedSkin = "off"
+user_data = [1,2;3,4]
+tag = "myConsoleName"
diff --git a/scilab/modules/graphics/tests/nonreg_tests/bug_15239.tst b/scilab/modules/graphics/tests/nonreg_tests/bug_15239.tst
new file mode 100644 (file)
index 0000000..7784ff4
--- /dev/null
@@ -0,0 +1,21 @@
+// =============================================================================
+// Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+// Copyright (C) 2017 - Samuel GOUGEON
+//
+//  This file is distributed under the same license as the Scilab package.
+// =============================================================================
+
+// <-- ENGLISH IMPOSED -->
+//
+// <-- Non-regression test for bug 15239 -->
+//
+// <-- Bugzilla URL -->
+// http://bugzilla.scilab.org/15239
+//
+// <-- Short Description -->
+// The console's properties .tag and .userdata were not displayed
+
+c = get(0);
+c.userdata = [1 2 ; 3 4];
+c.tag = "myConsoleName";
+c
index 1dec8e9..9223508 100644 (file)
     <refsection>
         <title>Description</title>
         <para>
-            This object is returned when calling <literal>get(0)</literal> and allows to modify some parameters for handles and uicontrols.
+            This object is returned when calling <literal>get(0)</literal> and allows to modify
+            some parameters for handles and uicontrols. Consoles's properties are the following:
         </para>
         <variablelist>
             <varlistentry>
-                <term>Console properties</term>
+                <term>ShowHiddenHandles</term>
                 <listitem>
-                    <variablelist>
-                        <varlistentry>
-                            <term>ShowHiddenHandles:</term>
-                            <listitem>
-                                <para>A boolean or a string</para>
-                                <para>Manages the display of all children handles in figures including default menus ones.</para>
-                                <para>
-                                    Default value is <literal>"off"</literal>.
-                                </para>
-                            </listitem>
-                        </varlistentry>
-                        <varlistentry>
-                            <term>UseDeprecatedSkin:</term>
-                            <listitem>
-                                <para>A boolean or a string</para>
-                                <para>Manages the rendering of uicontrols.</para>
-                                <para>
-                                    Default value is <literal>"off"</literal> and uicontrols look and feel is managed by operating system.
-                                </para>
-                                <para>
-                                    Setting this value to <literal>"on"</literal> or <literal>%T</literal> will make the uicontrols have an old TK look and feel.
-                                </para>
-                            </listitem>
-                        </varlistentry>
-                        <varlistentry>
-                            <term>ShowHiddenProperties:</term>
-                            <listitem>
-                                <para>A boolean or a string</para>
-                                <para>Manages the display of uicontrols properties.</para>
-                                <para>
-                                    Default value is <literal>"off"</literal> and only the uicontrols properties used on the Java side are displayed.
-                                </para>
-                                <para>
-                                    Setting this value to <literal>"on"</literal> or <literal>%T</literal> will make all available properties displayed (for example a <literal>ListboxTop</literal> property will be displayed for <literal>pushbutton</literal> uicontrols.
-                                </para>
-                            </listitem>
-                        </varlistentry>
-                    </variablelist>
+                    <para>A boolean or a string</para>
+                    <para>Manages the display of all children handles in figures including default menus ones.</para>
+                    <para>
+                        Default value is <literal>"off"</literal>.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>UseDeprecatedSkin</term>
+                <listitem>
+                    <para>A boolean or a string</para>
+                    <para>Manages the rendering of uicontrols.</para>
+                    <para>
+                        Default value is <literal>"off"</literal> and uicontrols look and feel is managed by operating system.
+                    </para>
+                    <para>
+                        Setting this value to <literal>"on"</literal> or <literal>%T</literal> will make the uicontrols have an old TK look and feel.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>ShowHiddenProperties</term>
+                <listitem>
+                    <para>A boolean or a string</para>
+                    <para>Manages the display of uicontrols properties.</para>
+                    <para>
+                        Default value is <literal>"off"</literal> and only the uicontrols properties used on the Java side are displayed.
+                    </para>
+                    <para>
+                        Setting this value to <literal>"on"</literal> or <literal>%T</literal> will make all available properties displayed (for example a <literal>ListboxTop</literal> property will be displayed for <literal>pushbutton</literal> uicontrols.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>Userdata</term>
+                <listitem>
+                    <para>
+                        Any data of any type, that you want to ascribe to the console.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>Tag</term>
+                <listitem>
+                    <para>Single string, that can be used as a console custom text id.</para>
                 </listitem>
             </varlistentry>
         </variablelist>
@@ -90,6 +98,12 @@ h=uicontrol() // Full display of properties
         <title>See also</title>
         <simplelist type="inline">
             <member>
+                <link linkend="root_properties">root_properties</link>
+            </member>
+            <member>
+                <link linkend="get">get</link>
+            </member>
+            <member>
                 <link linkend="uicontrol">uicontrol</link>
             </member>
         </simplelist>
index 6ecc7d9..812ed74 100644 (file)
         <title>説明</title>
         <para>
             このオブジェクトは<literal>get(0)</literal>をコールする際に
-            返され,ハンドルおよびuicontrolのパラメータを修正できるようになります.
+            返され,ハンドルおよびuicontrolのパラメータを修正できるようになります.Consoleプロパティ:
         </para>
         <variablelist>
             <varlistentry>
-                <term>Consoleプロパティ</term>
+                <term>ShowHiddenHandles</term>
                 <listitem>
-                    <variablelist>
-                        <varlistentry>
-                            <term>ShowHiddenHandles:</term>
-                            <listitem>
-                                <para>論理値または文字列</para>
-                                <para>
-                                    デフォルトのメニューを含む図の全ての子ハンドル
-                                    の表示を管理.
-                                </para>
-                                <para>
-                                    デフォルト値は <literal>"off"</literal>です.
-                                </para>
-                            </listitem>
-                        </varlistentry>
-                        <varlistentry>
-                            <term>UseDeprecatedSkin:</term>
-                            <listitem>
-                                <para>論理値または文字列</para>
-                                <para>uicontrolのレンダリングを管理.</para>
-                                <para>
-                                    デフォルト値は<literal>"off"</literal>で,
-                                    uicontrolのルックアンドフィールは
-                                    オペレーティングシステムにより管理されます.
-                                </para>
-                                <para>
-                                    この値を<literal>"on"</literal>または
-                                    <literal>%T</literal>に設定すると,
-                                    uicontrolは,
-                                    古いTKのルックアンドフィールになります.
-                                </para>
-                            </listitem>
-                        </varlistentry>
-                        <varlistentry>
-                            <term>ShowHiddenProperties:</term>
-                            <listitem>
-                                <para>論理値または文字列</para>
-                                <para>uicontrolプロパティの表示を管理.</para>
-                                <para>
-                                    デフォルト値は<literal>"off"</literal>で,
-                                    Java側で使用されるuicontrolプロパティのみが
-                                    表示されます.
-                                </para>
-                                <para>
-                                    この値を<literal>"on"</literal>または
-                                    <literal>%T</literal>に設定すると,
-                                    全ての利用可能なプロパティが表示されます.
-                                    (例えば,<literal>ListboxTop</literal>
-                                    プロパティは
-                                    <literal>pushbutton</literal> uicontrolで
-                                    表示されます).
-                                </para>
-                            </listitem>
-                        </varlistentry>
-                    </variablelist>
+                    <para>論理値または文字列</para>
+                    <para>
+                        デフォルトのメニューを含む図の全ての子ハンドル
+                        の表示を管理.
+                    </para>
+                    <para>
+                        デフォルト値は <literal>"off"</literal>です.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>UseDeprecatedSkin</term>
+                <listitem>
+                    <para>論理値または文字列</para>
+                    <para>uicontrolのレンダリングを管理.</para>
+                    <para>
+                        デフォルト値は<literal>"off"</literal>で,
+                        uicontrolのルックアンドフィールは
+                        オペレーティングシステムにより管理されます.
+                    </para>
+                    <para>
+                        この値を<literal>"on"</literal>または
+                        <literal>%T</literal>に設定すると,
+                        uicontrolは,
+                        古いTKのルックアンドフィールになります.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>ShowHiddenProperties</term>
+                <listitem>
+                    <para>論理値または文字列</para>
+                    <para>uicontrolプロパティの表示を管理.</para>
+                    <para>
+                        デフォルト値は<literal>"off"</literal>で,
+                        Java側で使用されるuicontrolプロパティのみが
+                        表示されます.
+                    </para>
+                    <para>
+                        この値を<literal>"on"</literal>または
+                        <literal>%T</literal>に設定すると,
+                        全ての利用可能なプロパティが表示されます.
+                        (例えば,<literal>ListboxTop</literal>
+                        プロパティは
+                        <literal>pushbutton</literal> uicontrolで
+                        表示されます).
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>Userdata</term>
+                <listitem>
+                    <para>
+                        Any data of any type that you want to ascribe to the console.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>Tag</term>
+                <listitem>
+                    <para>Single string, that can be used as a console custom text id.</para>
                 </listitem>
             </varlistentry>
         </variablelist>
@@ -105,6 +112,12 @@ h=uicontrol() // Full display of properties
         <title>参照</title>
         <simplelist type="inline">
             <member>
+                <link linkend="root_properties">root_properties</link>
+            </member>
+            <member>
+                <link linkend="get">get</link>
+            </member>
+            <member>
                 <link linkend="uicontrol">uicontrol</link>
             </member>
         </simplelist>