summaryrefslogtreecommitdiff
path: root/source/text/sbasic/shared/enum.xhp
diff options
context:
space:
mode:
Diffstat (limited to 'source/text/sbasic/shared/enum.xhp')
-rw-r--r--source/text/sbasic/shared/enum.xhp50
1 files changed, 50 insertions, 0 deletions
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>