wx: Generate docs

Use (and modify) wxWidgets doc input to generate documenation for erlang.

1 files changed, 159 insertions, 0 deletions

diff --git a/lib/wx/doc/src/wxNotebook.xml b/lib/wx/doc/src/wxNotebook.xml
new file mode 100644
index 0000000000..c26ae799e5
--- /dev/null
+++ b/lib/wx/doc/src/wxNotebook.xml
@@ -0,0 +1,159 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!DOCTYPE erlref SYSTEM "erlref.dtd">
+
+<!-- THIS FILE IS GENERATED DO NOT EDIT -->
+
+
+<erlref>
+<header>
+  <copyright>
+    <year>2020</year>
+    <holder>Ericsson AB. All Rights Reserved.</holder></copyright>
+  <legalnotice>
+      Licensed under the Apache License, Version 2.0 (the "License");
+      you may not use this file except in compliance with the License.
+      You may obtain a copy of the License at
+
+          http://www.apache.org/licenses/LICENSE-2.0
+
+      Unless required by applicable law or agreed to in writing, software
+      distributed under the License is distributed on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+      See the License for the specific language governing permissions and
+      limitations under the License.
+
+  </legalnotice>
+  <title>wxNotebook</title>
+</header>
+<module>wxNotebook</module>
+<modulesummary>Functions for wxNotebook class</modulesummary>
+<description><p>This class represents a notebook control, which manages multiple windows with associated tabs.
+      </p><p>To use the class, create a <seeerl marker="wxNotebook"><c>wxNotebook</c></seeerl> object and call <seemfa marker="wxBookCtrlBase#addPage/4"><c>wxBookCtrlBase:addPage/4</c></seemfa> or <seemfa marker="wxBookCtrlBase#insertPage/5"><c>wxBookCtrlBase:insertPage/5</c></seemfa>, passing a window to be used as the page. Do not explicitly delete the window for a page that is currently managed by <seeerl marker="wxNotebook"><c>wxNotebook</c></seeerl>.
+      </p><p><c>wxNotebookPage</c> is a typedef for <seeerl marker="wxWindow"><c>wxWindow</c></seeerl>.
+      </p><p>Styles</p><p>This class supports the following styles:
+      </p><p>Page backgrounds</p> <p>On Windows, the default theme paints a background on the notebook's pages. If you wish to suppress this theme, for aesthetic or performance reasons, there are three ways of doing it. You can use <c>wxNB_NOPAGETHEME</c> to disable themed drawing for a particular notebook, you can call <seemfa marker="wxSystemOptions#setOption/2"><c>wxSystemOptions:setOption/2</c></seemfa> to disable it for the whole application, or you can disable it for individual pages by using <seemfa marker="wxWindow#setBackgroundColour/2"><c>wxWindow:setBackgroundColour/2</c></seemfa>.
+      </p> <p>To disable themed pages globally: 
+      </p> <p>Set the value to 1 to enable it again. To give a single page a solid background that more or less fits in with the overall theme, use: 
+      </p> <p>On platforms other than Windows, or if the application is not using Windows themes, <seemfa marker="#getThemeBackgroundColour/1"><c>getThemeBackgroundColour/1</c></seemfa> will return an uninitialised colour object, and the above code will therefore work on all platforms.
+      </p> <p>See: ?wxBookCtrl, <seeerl marker="wxBookCtrlEvent"><c>wxBookCtrlEvent</c></seeerl>, <seeerl marker="wxImageList"><c>wxImageList</c></seeerl>, <url href="https://docs.wxwidgets.org/3.1/page_samples.html#page_samples_notebook">Examples</url>
+      </p>
+  <p>This class is derived (and can use functions) from: 
+    <seeerl marker="wxBookCtrlBase"><c>wxBookCtrlBase</c></seeerl> <seeerl marker="wxControl"><c>wxControl</c></seeerl> <seeerl marker="wxWindow"><c>wxWindow</c></seeerl> <seeerl marker="wxEvtHandler"><c>wxEvtHandler</c></seeerl></p>
+  
+  <p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_notebook.html">wxNotebook</url></p>
+  </description><section><title>Events</title><p>Event types emitted from this class: <seeerl marker="wxBookCtrlEvent"><c>command_notebook_page_changed</c></seeerl>, <seeerl marker="wxBookCtrlEvent"><c>command_notebook_page_changing</c></seeerl></p></section>
+<datatypes><datatype><name name="wxNotebook"/></datatype></datatypes>
+
+<funcs>
+  <func>
+    <name name="new" arity="0" clause_i="1" since=""/>
+    <fsummary>Constructs a notebook control. </fsummary>
+    <desc><p>Constructs a notebook control. 
+      </p></desc>
+  </func>
+  
+  <func>
+    <name name="new" arity="2" clause_i="1" since=""/>
+    <fsummary>See: <c>new/3</c></fsummary>
+  </func>
+  
+  <func>
+    <name name="new" arity="3" clause_i="1" since=""/>
+    <fsummary>Constructs a notebook control. </fsummary>
+    <desc><p>Constructs a notebook control. 
+      </p><p>Note that sometimes you can reduce flicker by passing the wxCLIP_CHILDREN window style.
+      </p></desc>
+  </func>
+  
+  <func>
+    <name name="destroy" arity="1" clause_i="1" since=""/>
+    <fsummary>Destroys the <c>wxNotebook</c> object. </fsummary>
+    <desc><p>Destroys the <seeerl marker="wxNotebook"><c>wxNotebook</c></seeerl> object. 
+      </p></desc>
+  </func>
+  
+  <func>
+    <name name="assignImageList" arity="2" clause_i="1" since=""/>
+    <fsummary>Sets the image list for the page control and takes ownership of the list. </fsummary>
+    <desc><p>Sets the image list for the page control and takes ownership of the list. 
+      </p><p>See: <seeerl marker="wxImageList"><c>wxImageList</c></seeerl>, <seemfa marker="#setImageList/2"><c>setImageList/2</c></seemfa>
+      </p></desc>
+  </func>
+  
+  <func>
+    <name name="create" arity="3" clause_i="1" since=""/>
+    <fsummary>See: <c>create/4</c></fsummary>
+  </func>
+  
+  <func>
+    <name name="create" arity="4" clause_i="1" since=""/>
+    <fsummary>Creates a notebook control. </fsummary>
+    <desc><p>Creates a notebook control. 
+      </p><p>See <seemfa marker="#new/3"><c>new/3</c></seemfa> for a description of the parameters. 
+      </p></desc>
+  </func>
+  
+  <func>
+    <name name="getImageList" arity="1" clause_i="1" since=""/>
+    <fsummary>Returns the associated image list, may be NULL. </fsummary>
+    <desc><p>Returns the associated image list, may be NULL. 
+      </p><p>See: <seeerl marker="wxImageList"><c>wxImageList</c></seeerl>, <seemfa marker="#setImageList/2"><c>setImageList/2</c></seemfa>
+      </p></desc>
+  </func>
+  
+  <func>
+    <name name="getPageImage" arity="2" clause_i="1" since=""/>
+    <fsummary>Returns the image index for the given page. </fsummary>
+    <desc><p>Returns the image index for the given page. 
+      </p></desc>
+  </func>
+  
+  <func>
+    <name name="getRowCount" arity="1" clause_i="1" since=""/>
+    <fsummary>Returns the number of rows in the notebook control. </fsummary>
+    <desc><p>Returns the number of rows in the notebook control. 
+      </p></desc>
+  </func>
+  
+  <func>
+    <name name="getThemeBackgroundColour" arity="1" clause_i="1" since=""/>
+    <fsummary>If running under Windows and themes are enabled for the application, this function returns a suitable colour for painting the background of a notebook page, and can be passed to <c>wxWindow:setBackgroundColour/2</c>. </fsummary>
+    <desc><p>If running under Windows and themes are enabled for the application, this function returns a suitable colour for painting the background of a notebook page, and can be passed to <seemfa marker="wxWindow#setBackgroundColour/2"><c>wxWindow:setBackgroundColour/2</c></seemfa>. 
+      </p><p>Otherwise, an uninitialised colour will be returned. 
+      </p></desc>
+  </func>
+  
+  <func>
+    <name name="setImageList" arity="2" clause_i="1" since=""/>
+    <fsummary>Sets the image list to use. </fsummary>
+    <desc><p>Sets the image list to use. 
+      </p><p>It does not take ownership of the image list, you must delete it yourself.
+      </p><p>See: <seeerl marker="wxImageList"><c>wxImageList</c></seeerl>, <seemfa marker="#assignImageList/2"><c>assignImageList/2</c></seemfa>
+      </p></desc>
+  </func>
+  
+  <func>
+    <name name="setPadding" arity="2" clause_i="1" since=""/>
+    <fsummary>Sets the amount of space around each page's icon and label, in pixels. </fsummary>
+    <desc><p>Sets the amount of space around each page's icon and label, in pixels. 
+      </p><p>Note: The vertical padding cannot be changed in wxGTK. 
+      </p></desc>
+  </func>
+  
+  <func>
+    <name name="setPageSize" arity="2" clause_i="1" since=""/>
+    <fsummary>Sets the width and height of the pages. </fsummary>
+    <desc><p>Sets the width and height of the pages. 
+      </p><p>Note: This method is currently not implemented for wxGTK. 
+      </p></desc>
+  </func>
+  
+  <func>
+    <name name="setPageImage" arity="3" clause_i="1" since=""/>
+    <fsummary>Sets the image index for the given page. </fsummary>
+    <desc><p>Sets the image index for the given page. 
+      </p><p><c>image</c> is an index into the image list which was set with <seemfa marker="#setImageList/2"><c>setImageList/2</c></seemfa>. 
+      </p></desc>
+  </func>
+  </funcs>
+</erlref>