summaryrefslogtreecommitdiffstats
path: root/source
diff options
context:
space:
mode:
authorAlain Romedenne <pyoffice.romedenne@sfr.fr>2018-11-28 23:58:44 -0200
committerOlivier Hallot <olivier.hallot@libreoffice.org>2018-11-29 21:41:15 +0100
commit93b7b1c8c79744b8d172dc0f2bbdf8a80e05abd8 (patch)
treea0b77748efd856f610c1b3fef3eba72bd9f2d088 /source
parentOccurrence number as REGEX() 4th argument, tdf#113977 tdf#121084 (diff)
downloadhelp-93b7b1c8c79744b8d172dc0f2bbdf8a80e05abd8.tar.gz
help-93b7b1c8c79744b8d172dc0f2bbdf8a80e05abd8.zip
Help pages for VBA Enum statement
Change-Id: I4f382453334aa964115d30d7e11e7d202d63a230 Reviewed-on: https://gerrit.libreoffice.org/64202 Tested-by: Jenkins Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
Diffstat (limited to 'source')
-rw-r--r--source/auxiliary/sbasic.tree1
-rw-r--r--source/text/sbasic/shared/03120412.xhp2
-rw-r--r--source/text/sbasic/shared/enum.xhp50
-rw-r--r--source/text/sbasic/shared/special_vba_func.xhp9
4 files changed, 59 insertions, 3 deletions
diff --git a/source/auxiliary/sbasic.tree b/source/auxiliary/sbasic.tree
index 03818d0e7a..b71d4c21b9 100644
--- a/source/auxiliary/sbasic.tree
+++ b/source/auxiliary/sbasic.tree
@@ -122,6 +122,7 @@
<topic id="sbasic/text/sbasic/shared/03090201.xhp">Do...Loop Statement</topic>
<topic id="sbasic/text/sbasic/shared/03110100.xhp">Comparison Operators</topic>
<topic id="sbasic/text/sbasic/shared/03090404.xhp">End Statement</topic>
+ <topic id="sbasic/text/sbasic/shared/enum.xhp">Enum Statement [VBA]</topic>
<topic id="sbasic/text/sbasic/shared/03130800.xhp">Environ Function</topic>
<topic id="sbasic/text/sbasic/shared/03020301.xhp">Eof Function</topic>
<topic id="sbasic/text/sbasic/shared/03104600.xhp">EqualUnoObjects Function</topic>
diff --git a/source/text/sbasic/shared/03120412.xhp b/source/text/sbasic/shared/03120412.xhp
index ff0462f23e..0bf1202fb5 100644
--- a/source/text/sbasic/shared/03120412.xhp
+++ b/source/text/sbasic/shared/03120412.xhp
@@ -32,8 +32,6 @@
<bookmark xml-lang="en-US" branch="index" id="bm_id3155934">
<bookmark_value>StrReverse function</bookmark_value>
</bookmark>
-
-
<paragraph id="hd_id3155934" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03120412.xhp" name="StrReverse Function">StrReverse Function [VBA]</link></paragraph>
<paragraph id="par_id3153990" role="paragraph" xml-lang="en-US">Returns the string with the character order reversed.</paragraph>
</section>
diff --git a/source/text/sbasic/shared/enum.xhp b/source/text/sbasic/shared/enum.xhp
new file mode 100644
index 0000000000..f891c7cbfb
--- /dev/null
+++ b/source/text/sbasic/shared/enum.xhp
@@ -0,0 +1,50 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<helpdocument version="1.0">
+ <meta>
+ <topic id="org.LibreOffice.Help.Enum">
+ <title id="tit" xml-lang="en-US">Enum Statement</title>
+ <filename>/text/sbasic/shared/enum.xhp</filename>
+ </topic>
+ </meta>
+
+ <body>
+ <bookmark branch="index" xml-lang="en-US" id="N0001">
+ <bookmark_value>Enum statement</bookmark_value>
+ <bookmark_value>constants groups</bookmark_value>
+ <bookmark_value>enumerations</bookmark_value>
+ </bookmark>
+
+ <section id="enumheading">
+ <h1 id="hd_id221543446540070"><link href="text/sbasic/shared/enum.xhp" name="command_name">Enum Statement [VBA]</link></h1>
+ <paragraph role="paragraph" id="N0003">Define enumerations or non UNO constant groups. An enumeration is a value list that facilitates programming and eases code logic review.</paragraph>
+ </section>
+ <embed href="text/sbasic/shared/00000003.xhp#vbasupport"/>
+ <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
+ <paragraph role="bascode" id="par_id931543441922328" xml-lang="en-US" localize="false">Enum</paragraph>
+ <paragraph role="bascode" id="par_id771543441931669" xml-lang="en-US" localize="false"> Object Statement block</paragraph>
+ <paragraph role="bascode" id="par_id21543441938004" xml-lang="en-US" localize="false">End Enum</paragraph>
+ <h2 id="N0006">Parameters:</h2>
+ <paragraph role="paragraph" id="N0007">Within a given enumeration, fit together values that logically relate to one another.</paragraph>
+
+ <embed href="text/sbasic/shared/00000003.xhp#functexample"/>
+ <paragraph role="bascode" localize="false" id="N0008">Option VBASupport 1<br/></paragraph>
+ <paragraph role="bascode" localize="false" id="N0018">Private Enum _WindowManager</paragraph>
+ <paragraph role="bascode" localize="false" id="N0019"> W1ND0WS = 1 &apos; Windows</paragraph>
+ <paragraph role="bascode" localize="false" id="N0020"> OS2PM = 2 &apos; OS/2 Presentation Manager</paragraph>
+ <paragraph role="bascode" localize="false" id="N0021"> MACINTOSH = 3 &apos; Macintosh</paragraph>
+ <paragraph role="bascode" localize="false" id="N0022"> MOTIF = 4 &apos; Motif Window Manager / Unix-like</paragraph>
+ <paragraph role="bascode" localize="false" id="N0023"> OPENLOOK = 5 &apos; Open Look / Unix-like</paragraph>
+ <paragraph role="bascode" localize="false" id="N0024">End Enum</paragraph>
+
+ <note id="N0025">Enumerated values are rendered to <emph>Long</emph> datatype. Basic functions are public accessors to enumerations. Enumeration names and value names must be unique within a library and across modules.</note>
+
+ <section id="relatedtopics" >
+ <paragraph role="paragraph" id="N0051">
+ <link href="text/sbasic/shared/03100700.xhp" name ="const">Const</link> statement, <link href="text/sbasic/shared/01020100.xhp" name ="external">constants</link>
+ </paragraph>
+ <paragraph role="paragraph" id="N0053">
+ <link href="text/sbasic/shared/03103350.xhp" name ="external">Option VBASupport</link> statement
+ </paragraph>
+ </section>
+</body>
+</helpdocument>
diff --git a/source/text/sbasic/shared/special_vba_func.xhp b/source/text/sbasic/shared/special_vba_func.xhp
index 634891e7a8..54762cc8e2 100644
--- a/source/text/sbasic/shared/special_vba_func.xhp
+++ b/source/text/sbasic/shared/special_vba_func.xhp
@@ -34,11 +34,18 @@
</bookmark>
-<paragraph id="hd_id051820170313205718" role="heading" level="1" xml-lang="en-US"><variable id="exclusivevba"><link href="text/sbasic/shared/special_vba_func.xhp">Exclusive VBA functions</link></variable></paragraph>
+<paragraph id="hd_id051820170313205718" role="heading" level="1" xml-lang="en-US"><variable id="exclusivevba"><link href="text/sbasic/shared/special_vba_func.xhp">Exclusive VBA Functions and Statements</link></variable></paragraph>
<paragraph id="par_id051820170314436068" role="paragraph" xml-lang="en-US"><ahelp hid=".">%PRODUCTNAME Basic adds this set of functions when VBA support is enabled</ahelp></paragraph>
</section>
<paragraph id="hd_id051820170407499827" role="paragraph" xml-lang="en-US">These exclusive VBA functions are enabled when the statement <item type="literal">Option VBASupport 1</item> is placed before the first macro of a %PRODUCTNAME Basic module. </paragraph>
+<section id="vbastatements">
+ <bookmark xml-lang="en-US" branch="index" id="bm_id71543455697570">
+ <bookmark_value>VBA Statements</bookmark_value>
+ </bookmark>
+ <h2 id="hd_id31543446449360">VBA Statements</h2>
+ <embed href="text/sbasic/shared/enum.xhp#enumheading"/>
+</section>
<section id="VBAString">
<bookmark xml-lang="en-US" branch="index" id="bm_id05192017035621676">