From 6e1d335671e9affda395ca068541291fc112eb74 Mon Sep 17 00:00:00 2001 From: Robin Gareus Date: Thu, 31 Mar 2016 01:18:44 +0200 Subject: [PATCH] update lua class doc. up from 139 to 150 doxygen annotations. (558 still missing) --- .../24_lua-scripting/02_class_reference.html | 26 ++++++++++++++----- source/css/luadoc.css | 6 +++-- 2 files changed, 23 insertions(+), 9 deletions(-) diff --git a/_manual/24_lua-scripting/02_class_reference.html b/_manual/24_lua-scripting/02_class_reference.html index f62a390..66aa472 100644 --- a/_manual/24_lua-scripting/02_class_reference.html +++ b/_manual/24_lua-scripting/02_class_reference.html @@ -288,6 +288,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Methods AutoStateautomation_state () doubleget_value () +

Get the current effective `user' value based on automation state

boolisnil () voidset_automation_style (AutoStyle) voidset_value (double, GroupControlDisposition) @@ -355,7 +356,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Constructor ℂARDOUR.ChanMapping () Methods - unsigned intget (DataType, unsigned int) + unsigned intget (DataType, unsigned int)

get buffer mapping for given data type and pin

from
pin
type
data type

Returns mapped buffer number (or ChanMapping::Invalid)

voidset (DataType, unsigned int, unsigned int)

set buffer mapping for given data type

from
pin
to
buffer
type
data type
@@ -472,7 +473,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

C‡: ARDOUR::Location

is-a: PBD:StatefulDestructible

-

Base class for objects with saveable and undoable state

+

Location on Timeline - abstract representation for Markers, Loop/Punch Ranges, CD-Markers etc.

@@ -481,8 +482,10 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + +
Methods
longend ()
boollocked ()
intmove_to (long)
intset_end (long, bool, bool)

Set end position.

force
true to force setting, even if the given new end is before the current start.
allow_bbt_recompute
True to recompute BBT end time from the new given end time.
s
New end.
intset_length (long, long, bool)
intset_start (long, bool, bool)

Set start position.

s
New start.
force
true to force setting, even if the given new start is after the current end.
allow_bbt_recompute
True to recompute BBT start time from the new given start time.
longstart ()

Inherited from PBD:Stateful

@@ -642,6 +645,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolisnil () char*label () boolload_preset (PresetRecord) +

Set parameters using a preset

char*maker () char*name () LuaTable(unsigned int, ...)nth_parameter (unsigned int, bool&) @@ -668,6 +672,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Methods AutoStateautomation_state () doubleget_value () +

Get the current effective `user' value based on automation state

voidset_automation_style (AutoStyle) voidset_value (double, GroupControlDisposition)

Get and Set `internal' value

All derived classes must implement this.

Basic derived classes will ignore

group_override,
but more sophisticated children, notably those that proxy the value setting logic via an object that is aware of group relationships between this control and others, will find it useful.
@@ -826,6 +831,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C voidraise_to_top () voidset_hidden (bool) voidset_initial_position (long) +

A gui may need to create a region, then place it in an initial position determined by the user. When this takes place within one gui operation, we have to reset _last_position to prevent an implied move.

voidset_length (long) voidset_locked (bool) voidset_muted (bool) @@ -834,6 +840,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C voidset_position_locked (bool) voidset_start (long) voidset_sync_position (long) +

Set the region's sync point.

absolute_pos
Session time.
voidset_video_locked (bool) floatshift () longstart () @@ -841,7 +848,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolsync_marked () LuaTable(long, ...)sync_offset (int&) longsync_position () +

Returns Sync position in session time

voidtrim_end (long) +
new_endpoint
New region end point, such that, for example, a region at 0 of length 10 has an endpoint of 9.
voidtrim_front (long) voidtrim_to (long, long) boolvalid_transients () @@ -938,7 +947,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

∁ ARDOUR:Session

C‡: ARDOUR::Session

-

Base class for objects with saveable and undoable state

+

Ardour Session

@@ -969,6 +978,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -1021,7 +1031,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

∁ ARDOUR:TempoMap

C‡: ARDOUR::TempoMap

-

Base class for objects with saveable and undoable state

+

Tempo Map - mapping of timecode to musical time. convert audio-samples, sample-rate to Bar/Beat/Tick, Meter/Tempo

Methods
boolactively_recording ()
Routeroute_by_name (std::string)
Routeroute_by_remote_id (unsigned int)
intsave_state (std::string, bool, bool, bool)
snapshot_name
Name to save under, without .ardour / .pending prefix
voidscripts_changed ()
voidset_dirty ()
std::stringsnap_name ()
@@ -1125,11 +1135,12 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

∅ ArdourUI:ArdourMarker

C‡: ArdourMarker

-

Base class for objects with auto-disconnection. trackable must be inherited when objects shall automatically invalidate slots referring to them on destruction. A slot built from a member function of a trackable derived type installs a callback that is invoked when the trackable object is destroyed or overwritten.

add_destroy_notify_callback() and remove_destroy_notify_callback() can be used to manually install and remove callbacks when notification of the object dying is needed.

notify_callbacks() invokes and removes all previously installed callbacks and can therefore be used to disconnect from all signals.

Note that there is no virtual destructor. Don't use trackable* as pointer type for managing your data or the destructors of your derived types won't be called when deleting your objects.

 signal
+

Location Marker

Editor ruler representation of a location marker or range on the timeline.

This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.

∁ ArdourUI:Editor

C‡: PublicEditor

+

This class contains just the public interface of the Editor class, in order to decouple it from the private implementation, so that callers of PublicEditor need not be recompiled if private methods or member variables change.

Methods
voidadd_meter (Meter, BBT_TIME)
@@ -1225,6 +1236,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Methods
voidaccess_action (std::string, std::string)
+ @@ -1516,7 +1528,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

C‡: PBD::StatefulDestructible

is-a: PBD:Stateful

-

Base class for objects with saveable and undoable state

+

Base class for objects with saveable and undoable state with destruction notification

This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.

Inherited from PBD:Stateful

Methods
voidclear_all ()

Empty this RegionSelection.

longend_frame ()
unsigned longn_midi_regions ()
longstart ()
@@ -1862,4 +1874,4 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  • Timecode:BBT_TIME
    • -
    Ardour 4.7-489-g840c059  -  Sun, 27 Mar 2016 22:39:31 +0200
    +
    Ardour 4.7-535-g0818257  -  Thu, 31 Mar 2016 01:17:33 +0200
    diff --git a/source/css/luadoc.css b/source/css/luadoc.css index a7ef382..011b342 100644 --- a/source/css/luadoc.css +++ b/source/css/luadoc.css @@ -4,7 +4,7 @@ div.luafooter { text-align:center; font-size:80%; color: #888; marg #luaref h2 { margin:2em 0 0 0; padding:0em; border-bottom: 1px solid black; } #luaref h3.cls { margin:2em 0 0 0; padding: 0 0 0 1em; border: 1px dashed #6666ee; } -#luaref h3.cls abbr { text-decoration:none; cursor:default; } +#luaref h3.cls abbr { text-decoration:none; cursor:default; border: none;} #luaref h4.cls { margin:1em 0 0 0; } #luaref h3.class { background-color: #aaee66; } #luaref h3.enum { background-color: #aaaaaa; } @@ -25,7 +25,9 @@ div.luafooter { text-align:center; font-size:80%; color: #888; marg #luaref div.classdox p { margin: .5em 0 .5em .6em; } #luaref div.classdox { padding: .1em 1em; } #luaref div.classdox p { margin: .5em 0 .5em .6em; } -#luaref table.classmembers { width: 100%; } +#luaref div.result-discussion { font-size: 120%; } +#luaref span.word-returns { font-style: italic; } +#luaref table.classmembers { width: 100%; } #luaref table.classmembers th { text-align:left; border-bottom:1px solid black; padding-top:1em; } #luaref table.classmembers td.def { text-align:right; padding-right:.5em; white-space: nowrap; } #luaref table.classmembers td.decl { text-align:left; padding-left:.5em; white-space: nowrap; } -- 2.37.2