Changes between Version 2 and Version 3 of documentation/LuaManual/APIReference

Author:

gambini (IP: 96.38.104.126)

Timestamp:

05/28/12 13:56:21 (5 years ago)

Comment:

halfway through converting types to monospace

documentation/LuaManual/APIReference

@@ -15 +15 @@
-== rocket Table ==
-
-''Context''` `'''CreateContext'''(''string name'', ''Vector2i 
+`Context `'''CreateContext'''(`string` ''name'', `Vector2i` ''
-   Creates and returns a new context called ''name'', with initial dimensions of ''dimensions''. The name of the context must be unique; if it is not, ''nil'' will be returned
-
-''bool''` `'''LoadFontFace'''(''string 
+`bool `'''LoadFontFace'''(`string` ''
-   Loads the font face at ''font_path''. The function will return true if the font face was loaded, false if not.
-
-''void''` `'''RegisterTag'''(''string tag_name'', ''ElementInstancer 
+`void `'''RegisterTag'''(`string` ''tag_name'', `ElementInstancer` ''
-   Registers a [wiki:documentation/LuaManual/ElementInstancer ElementInstancer] to instance when a specific XML tag is encountered in an RML file.
-
-{{{{} }}}'''contexts'''
+'''contexts'''`   `(`{}`)
-   A table of the active libRocket contexts. It can be indexed by string (in which case the context with the matching name is returned), or number (in which case the nth context is returned).
-
-== Log ==
-
-''void''` `'''Message'''(''logtype type'', ''string 
+`void `'''Message'''(`logtype` ''type'', `string` ''
-   Sends a log message to libRocket (and the attached debugger if present). This is not called from an instance of a Log object, just ''Log.Message''.[[br]]
-   type should be one of:
-Abstract DataSource Interface. Create one by calling ''DataSource.new'', and set the ''GetNumRows'' and ''GetRow'' functions to a Lua function that fits the specification.
-
-''DataSource''` `'''new'''(''string 
+`DataSource `'''new'''(`string` ''
-   Create a new DataSource object for use in Lua.
-
-''void''` `'''NotifyRowAdd'''(''string table_name'', ''int first_row_added'', ''int 
+`void `'''NotifyRowAdd'''(`string` ''table_name'', `int` ''first_row_added'', `int` ''
-   Notify listeners that rows have been added to the data source.
-
-''void''` `'''NotifyRowRemove'''(''string table_name'', ''int first_row_removed'', ''int 
+`void `'''NotifyRowRemove'''(`string` ''table_name'', `int` ''first_row_removed'', `int` ''
-   Notify listeners that rows have been removed from the data source.
-
-''void''` `'''NotifyRowChange'''(''string table_name'', ''int first_row_changed'', ''int 
+`void `'''NotifyRowChange'''(`string` ''table_name'', `int` ''first_row_changed'', `int` ''
-   Notify listeners that rows have been changed on the data source.
-
-''void''` `'''NotifyRowChange'''(''string 
+`void `'''NotifyRowChange'''(`string` ''
-   Notify listeners that all rows on the data source have changed.
-
-''int''` `'''GetNumRows''' = function(''string 
+`int `'''GetNumRows''' = function(`string` ''
-   To be set in Lua; return the number of rows in the given table.
-
-`''string''`} `'''GetRow''' = function(''string table_name'', ''int index'', `{`string`
+string} `'''GetRow''' = function(`string` ''table_name'', `int` ''index'', `{string
-   To be set in Lua; return a table of the values of the columns in string form.
-
-The ''Element'' class has no constructor; it must be instantiated through a ''[wiki:documentation/LuaManual/APIReference#Document Document]'' object instead. It has the following methods and properties:
-
-''void''` `'''AddEventListener'''(''string event'', ''string'' OR ''function listener''[, ''bool 
+`void `'''AddEventListener'''(`string` ''event'', `string` OR `function` ''listener''[, `bool` ''
-   Attaches ''listener'' to this element, listening for occurrences of ''event'' in either the bubble or capture phase. If not specified, ''in_capture_phase'' will default to false. [wiki:documentation/LuaManual/AttachingToEvents See also][[br]]''NOTE: Events added from Lua cannot be removed.''
-
-''void''` `'''AppendChild'''(''Element 
+`void `'''AppendChild'''(`Element` ''
-   Appends ''element'' as a child to this element.
-
-''void''`
+`void
-   Removes input focus from this element.
-
-''void''`
+`void
-   Fakes a click on this element.
-
-''void''` `'''DispatchEvent'''(''string event'', `{}` ''parameters'', ''bool 
+`void `'''DispatchEvent'''(`string` ''event'', `{}` ''parameters'', `bool` ''
-   Dispatches an event to this element. The event is of type ''event''. Parameters to the event are given in the table ''parameters''; the table must only contain string keys and floating-point, integer, boolean, Lua userdata, or string values. ''interruptible'' determines if the event can be forced to stop propagation early.
-
-''void''`
+`void
-   Gives input focus to this element.
-
-''string 
+`string` ''
-   Returns the value of the attribute named ''name''. If no such attribute exists, the empty string will be returned.
-
-''Element''` `'''GetElementById'''(''string 
+`Element `'''GetElementById'''(`string` ''
-   Returns the descendant element with an id of ''id''.
-
-''Element''`}` '''GetElementsByTagName'''(''string 
+Element} `'''GetElementsByTagName'''(`string` ''
-   Returns a list of all descendant elements with the tag of ''tag_name''.
-
-''bool''` `'''HasAttribute'''(''string 
+`bool `'''HasAttribute'''(`string` ''
-   Returns True if the element has a value for the attribute named ''name'', False if not.
-
-''bool''`
+`bool
-   Returns True if the element has at least one child node, false if not.
-
-''void''` `'''InsertBefore'''(''Element element'', ''Element 
+`void `'''InsertBefore'''(`Element` ''element'', `Element` ''
-   Inserts the element ''element'' as a child of this element, directly before ''adjacent_element'' in the list of children.
-
-
- '''scroll_left'''`   `(''float'')::
-
+ Read & write.
-
- '''scroll_top'''`   `(''float'')::
-
+ Read & write.
-
- '''scroll_width'''`   `(''float'')::
-== ElementText ==
-
-
-
-
-
-
+
+
+
-   The raw text content of the text element in UTF-8 encoding.
-
-== Document ==
-
-'''class''' Document
-
-''Document'' derives from ''Element''. ''Document'' has no constructor; it must be instantiated through a ''[wiki:documentation/PythonManual/APIReference#Context Context]'' object instead, either by loading an external RML file or creating an empty document. It has the following methods and properties:
-
-
+void''` `''
-   Pulls the document in front of other documents within its context with a similar z-index.
-
-
+void''` `''
-   Pushes the document behind other documents within its context with a similar z-index.
-
-
-NONE'', ''FOCUS'' or ''MODAL''. ''flags'' defaults to ''
-
-
+void''` `''
+Document.NONE'', ''Document.FOCUS'' or ''Document.MODAL''. ''flags'' defaults to ''Document.
+
+void''` `''
-   Hides the document.
-
-
+void''` `''
-   Hides and closes the document, destroying its contents.
-
-
+Element''` `''
-   Instances an element with a tag of ''tag_name''.
-
-
+ElementText''` `''
-   Instances a text element containing the string ''text''.
-
-
-
-
-
+`   `(''string'')
+ Read & write.
+
+`   `(''Context'')
-   The context the document belongs to. Read-only.
-
-== Event ==
-
-'''class''' Event
-
-The Event class has no constructor; it is generated internally. It has the following methods and properties:
-
-
+void''` `''
-   Stops the propagation of the event through the event cycle, if allowed.
-
-
+`   `(''Element'')
-   The element the event has propagated to. Read-only.
-
-
+`   `(''string'')
-   The string name of the event. Read-only.
-
-
+`   `(''Element'')
-   The element the event was originally targeted at. Read-only.
-
-
-
+`   `(`{k=`''string'',`v=`''[wiki:documentation/LuaManual/Variant variant]'')
+ Read-only [wiki:documentation/LuaManual/ProxyTables proxy table].
-
-== Context ==
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
-   Adds a cursor document loaded by another context into this context. The cursor document will be returned.
-