diff options
| author | Alain Romedenne <OpenOfficiant@sfr.fr> | 2018-12-20 13:58:42 +0100 |
|---|---|---|
| committer | Olivier Hallot <olivier.hallot@libreoffice.org> | 2019-01-04 18:59:02 +0100 |
| commit | 2237ca9306b5478d7c5df61246d32b60e4991783 (patch) | |
| tree | e7402601415692cba5c789b1da51a51d12395fc2 | |
| parent | 4df68585db8f4c74a1d74c6d7bc97bfb0c18f36f (diff) | |
Enum help page preciser content
Change-Id: Ic1f8926050f6b1b4a45f2da6dae784261ecd9a9e
Reviewed-on: https://gerrit.libreoffice.org/65493
Tested-by: Jenkins
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
| -rw-r--r-- | source/text/sbasic/shared/enum.xhp | 55 |
1 files changed, 36 insertions, 19 deletions
diff --git a/source/text/sbasic/shared/enum.xhp b/source/text/sbasic/shared/enum.xhp index 8c89169761..a49932afe2 100644 --- a/source/text/sbasic/shared/enum.xhp +++ b/source/text/sbasic/shared/enum.xhp @@ -1,5 +1,13 @@ <?xml version="1.0" encoding="UTF-8"?> <helpdocument version="1.0"> + <!-- + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + --> <meta> <topic id="org.LibreOffice.Help.Enum"> <title id="tit" xml-lang="en-US">Enum Statement</title> @@ -10,7 +18,7 @@ <body> <bookmark branch="index" xml-lang="en-US" id="N0001"> <bookmark_value>Enum statement</bookmark_value> - <bookmark_value>constants groups</bookmark_value> + <bookmark_value>constant groups</bookmark_value> <bookmark_value>enumerations</bookmark_value> </bookmark> @@ -20,32 +28,41 @@ </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> + <paragraph role="bascode" id="par_id931543441922328" localize="false">Enum</paragraph> + <paragraph role="bascode" id="par_id771543441931669" localize="false"> Object Statement block</paragraph> + <paragraph role="bascode" id="par_id21543441938004" 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"/> <bascode> - <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 ' Windows</paragraph> - <paragraph role="bascode" localize="false" id="N0020"> OS2PM = 2 ' OS/2 Presentation Manager</paragraph> - <paragraph role="bascode" localize="false" id="N0021"> MACINTOSH = 3 ' Macintosh</paragraph> - <paragraph role="bascode" localize="false" id="N0022"> MOTIF = 4 ' Motif Window Manager / Unix-like</paragraph> - <paragraph role="bascode" localize="false" id="N0023"> OPENLOOK = 5 ' Open Look / Unix-like</paragraph> - <paragraph role="bascode" localize="false" id="N0024">End Enum</paragraph> + <paragraph role="bascode" id="N0008" localize="false">Option VBASupport 1<br/></paragraph> + <paragraph role="bascode" id="N0018" localize="false">Private Enum _WindowManager</paragraph> + <paragraph role="bascode" id="N0019" localize="false"> W1ND0WS = 1 ' Windows</paragraph> + <paragraph role="bascode" id="N0020" localize="false"> OS2PM = 2 ' OS/2 Presentation Manager</paragraph> + <paragraph role="bascode" id="N0021" localize="false"> MACINTOSH = 3 ' Macintosh</paragraph> + <paragraph role="bascode" id="N0022" localize="false"> MOTIF = 4 ' Motif Window Manager / Unix-like</paragraph> + <paragraph role="bascode" id="N0023" localize="false"> OPENLOOK = 5 ' Open Look / Unix-like</paragraph> + <paragraph role="bascode" id="N0024" localize="false">End Enum</paragraph> + <paragraph role="bascode" id="N0027" localize="false">Public Function WindowManager() As Object</paragraph> + <paragraph role="bascode" id="N0028" localize="false"> WindowManager = _WindowManager</paragraph> + <paragraph role="bascode" id="N0029" localize="false">End Function ' <library>.<module>.WindowManager.XXX</paragraph> + </bascode> + <note id="N0030">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> + + <h2 id="N0036">usage:</h2> + <paragraph role="paragraph" xml-lang="en" id="N0037">Display WindowManager grouped constant values:</paragraph> + <bascode> + <paragraph role="bascode" id="N0038" localize="false">Dim winMgr As Object : winMgr = <library>.<module>.WindowManager</paragraph> + <paragraph role="bascode" id="N0039" localize="false">With winMgr</paragraph> + <paragraph role="bascode" id="N0040" localize="false"> Print .MACINTOSH, .MOTIF, .OPENLOOK, .OS2PM, .W1ND0WS</paragraph> + <paragraph role="bascode" id="N0041" localize="false">End With</paragraph> </bascode> - <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> + <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> + <paragraph role="paragraph" id="N0061"><link href="text/sbasic/shared/03090411.xhp" name ="external">With</link> statement</paragraph> </section> </body> </helpdocument> |