<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!-- header_tag -->
<html lang="en">
<head>
<title>paper-column-interface - LilyPond program-reference</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="LilyPond program-reference">
<meta name="generator" content="makeinfo 4.11">
<link title="Top" rel="start" href="index.html#Top">
<link rel="up" href="Graphical-Object-Interfaces.html#Graphical-Object-Interfaces" title="Graphical Object Interfaces">
<link rel="prev" href="ottava_002dbracket_002dinterface.html#ottava_002dbracket_002dinterface" title="ottava-bracket-interface">
<link rel="next" href="parentheses_002dinterface.html#parentheses_002dinterface" title="parentheses-interface">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
hr { border:0; height:1; color: #000000; background-color: #000000; }
/* hr {
border: none;
height: 1px;
color: #666666;
background-color: #666666;
}
body {
border-left: 1px solid #666666;
border-right: 1px solid #666666;
color: #332d28;
margin-right: auto;
margin-left: auto;
width: 60em;
list-style-type: square;
font-family: Arial,Helvetica,sans-serif;
padding-right: 1em;
padding-left: 1em;
}
a {
border-bottom: 1px dashed #344242;
text-decoration: none;
color: #344242;
}
a:link {
text-decoration: none;
}
a:visited {
border-bottom: 1px dashed #666666;
color: #666666;
}
a:active {
border-bottom: 1px solid #00cccc;
color: #00cccc;
}
a:hover {
border-bottom: 1px solid #1d7b85;
color: #1d7b85;
}
blockquote {
border: 1px solid #cccccc;
padding: 3px;
width: 40em;
}
.node {
border-left: 1px solid #666666;
margin: -0.5em 0px 1em;
padding: 2px 1px 0px;
font-style: italic;
}
.node a {
border: none;
text-decoration: underline;
font-style: normal;
font-weight: bold;
}
.verbatim {
font-family: "Courier New",Courier,monospace;
}
.unnumberedsubsubsec {
font-size: large;
color: #1d7b85;
}
.subsubheading {
font-size: large;
color: #3b220d;
}
.contents {
border: 1px dashed #339999;
margin: 3px 2em;
list-style-type: square;
padding-right: 1em;
width: 40em;
background-color: #fcfff9;
}
.contents a {
border-bottom: 1px dashed #423d34;
text-decoration: none;
color: #423d34;
}
.contents a:visited {
border-bottom: 1px dashed #666666;
color: #666666;
}
.contents a:active {
border-bottom: 1px solid #f0d86d;
color: #f0d86d;
}
.contents a:hover {
border-bottom: 1px solid #3b220d;
color: #3b220d;
}
.menu {
border-left: 1px dashed #339999;
margin: 3px 2em 1em;
list-style-type: square;
padding-left: 1.4em;
width: 40em;
}
.unnumbered {
}
h2 {
font-size: x-large;
color: #1d7b85;
}
*/
--></style>
</head>
<BODY BGCOLOR=WHITE TEXT=BLACK>
<div class="node">
<p>
<a name="paper-column-interface"></a>
<a name="paper_002dcolumn_002dinterface"></a>
Next: <a rel="next" accesskey="n" href="parentheses_002dinterface.html#parentheses_002dinterface">parentheses-interface</a>,
Previous: <a rel="previous" accesskey="p" href="ottava_002dbracket_002dinterface.html#ottava_002dbracket_002dinterface">ottava-bracket-interface</a>,
Up: <a rel="up" accesskey="u" href="Graphical-Object-Interfaces.html#Graphical-Object-Interfaces">Graphical Object Interfaces</a>
<hr>
</div>
<h4 class="unnumberedsubsec">paper-column-interface</h4>
<p><code>Paper_column</code> objects form the top-most X parents for items. There are two types of columns: musical columns, where are attached to, and non-musical columns, where bar-lines, clefs, etc., are attached to. The spacing engine determines the X positions of these objects.
<p>They are numbered, the first (leftmost) is column 0. Numbering happens before line breaking, and columns are not renumbered after line breaking. Since many columns go unused, you should only use the rank field to get ordering information. Two adjacent columns may have non-adjacent numbers.
<h5 class="unnumberedsubsubsec">User settable properties:</h5>
<blockquote>
<dl>
<dt><code>between-cols</code> (pair)<dd>Where to attach a loose column to.
<br><dt><code>labels</code> (list)<dd>List of labels (symbols) placed on a column
<br><dt><code>line-break-penalty</code> (number)<dd>Penalty for a line break at this
column. This affects the choices of the line breaker; it avoids a
line break at a column with a positive penalty and prefers a line break
at a column with a negative penalty.
<br><dt><code>line-break-permission</code> (symbol)<dd>Instructs the line breaker on
whether to put a line break at this column. Can be <code>force</code> or
<code>allow</code>.
<br><dt><code>line-break-system-details</code> (list)<dd>An alist of properties to use
if this column is the start of a system.
<br><dt><code>page-break-penalty</code> (number)<dd>Penalty for page break at this
column. This affects the choices of the page breaker; it avoids a
page break at a column with a positive penalty and prefers a page break
at a column with a negative penalty.
<br><dt><code>page-break-permission</code> (symbol)<dd>Instructs the page breaker on
whether to put a page break at this column. Can be <code>force</code> or
<code>allow</code>.
<br><dt><code>page-turn-penalty</code> (number)<dd>Penalty for a page turn at this
column. This affects the choices of the page breaker; it avoids a
page turn at a column with a positive penalty and prefers a page turn
at a column with a negative penalty.
<br><dt><code>page-turn-permission</code> (symbol)<dd>Instructs the page breaker on
whether to put a page turn at this column. Can be <code>force</code> or
<code>allow</code>.
<br><dt><code>rhythmic-location</code> (rhythmic location)<dd>Where (bar number,
measure position) in the score.
<br><dt><code>shortest-playing-duration</code> (moment)<dd>The duration of the
shortest note playing here.
<br><dt><code>shortest-starter-duration</code> (moment)<dd>The duration of the
shortest note that starts here.
<br><dt><code>used</code> (boolean)<dd>If set, this spacing column is kept in the
spacing problem.
<br><dt><code>when</code> (moment)<dd>Global time step associated with this column
happen?
</dl>
</blockquote>
<h5 class="unnumberedsubsubsec">Internal properties:</h5>
<blockquote>
<dl>
<dt><code>bounded-by-me</code> (unknown)<dd>A list of spanners that have this
column as start/begin point. Only columns that have grobs or act as
bounds are spaced.
<br><dt><code>grace-spacing</code> (layout object)<dd>A run of grace notes.
<br><dt><code>spacing</code> (layout object)<dd>The spacing spanner governing this section.
</dl>
</blockquote>
<p>This grob interface is used in the following graphical object(s): <a href="NonMusicalPaperColumn.html#NonMusicalPaperColumn">NonMusicalPaperColumn</a> and <a href="PaperColumn.html#PaperColumn">PaperColumn</a>.
<!-- footer_tag --><br><hr>
<div class="node">
<p>
<a name="paper_002dcolumn_002dinterface"></a>
Next: <a rel="next" accesskey="n" href="parentheses_002dinterface.html#parentheses_002dinterface">parentheses-interface</a>,
Previous: <a rel="previous" accesskey="p" href="ottava_002dbracket_002dinterface.html#ottava_002dbracket_002dinterface">ottava-bracket-interface</a>,
Up: <a rel="up" accesskey="u" href="Graphical-Object-Interfaces.html#Graphical-Object-Interfaces">Graphical Object Interfaces</a>
</div>
<div style="background-color: #e8ffe8; padding: 2; border: #c0ffc0 1px solid;">
<p>
<font size="-1">
This page is for LilyPond-2.11.57 (development-branch).
<br>
<address>
Report errors to <a href="http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.bugs">http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.bugs</a>. </address>
<br>
Your <a href="http://lilypond.org/web/devel/participating/documentation-adding">suggestions for the documentation</a> are welcome.
</font>
</p>
</div>
</BODY></html>
