Using ly:grob-object to access grobs with \tweak - Revision history

Lemzwerg at 19:26, 29 December 2025

2025-12-29T19:26:44Z

← Older revision		Revision as of 19:26, 29 December 2025
Line 52:		Line 52:
	</lilypond>		</lilypond>

	~~[[Category:Scheme]]~~
	[[Category:Scheme]]		[[Category:Scheme]]
	[[Category:Tweaks and overrides]]		[[Category:Tweaks and overrides]]
	[[Category:Included in the official documentation]]		[[Category:Included in the official documentation]]
	[[Category:Snippet]]		[[Category:Snippet]]

Lemzwerg at 15:19, 28 December 2025

2025-12-28T15:19:44Z

← Older revision		Revision as of 15:19, 28 December 2025
Line 5:		Line 5:
	The console output of the example function below (<code>display-grobs</code>) is as follows.		The console output of the example function below (<code>display-grobs</code>) is as follows.

	~~<pre>~~		--------------------
	--------------------		#<Grob Accidental >
	#<Grob Accidental >		()
	()		#<Grob Stem >
	#<Grob Stem >
	~~</pre~~>

	It is probably not that useful, but it demonstrates that the grobs are indeed being accessed.		It is probably not that useful, but it demonstrates that the grobs are indeed being accessed.

Lemzwerg: New category

2025-11-21T23:20:22Z

New category

← Older revision		Revision as of 23:20, 21 November 2025
Line 57:		Line 57:
	[[Category:Scheme]]		[[Category:Scheme]]
	[[Category:Tweaks and overrides]]		[[Category:Tweaks and overrides]]
	[[Category:Included in the official documentation]][[Category:Snippet]]		[[Category:Included in the official documentation]]
			[[Category:Snippet]]

Lemzwerg at 23:02, 21 November 2025

2025-11-21T23:02:28Z

← Older revision		Revision as of 23:02, 21 November 2025
Line 57:		Line 57:
	[[Category:Scheme]]		[[Category:Scheme]]
	[[Category:Tweaks and overrides]]		[[Category:Tweaks and overrides]]
	[[Category:Included in the official documentation]]		[[Category:Included in the official documentation]][[Category:Snippet]]

Lemzwerg at 18:56, 18 November 2025

2025-11-18T18:56:29Z

← Older revision		Revision as of 18:56, 18 November 2025
Line 1:		Line 1:
	Some grobs can be accessed “laterally” from within another grob’s callback. These are usually listed as “layout objects” in the “Internal properties” section of a grob-interface. The function ly:grob-object is used to access these grobs.		Some grobs can be accessed “laterally” from within another grob’s callback. These are usually listed as “layout objects” in the “Internal properties” section of a grob interface. The function <code>ly:grob-object</code> is used to access these grobs.

	Demonstrated below are some ways of accessing grobs from within a NoteHead callback, but the technique is not limited to ~~NoteHeads~~. However, the NoteHead callback is particularly important, since it is the implicit callback used by the <code>\tweak</code> command.		Demonstrated below are some ways of accessing grobs from within a <code>NoteHead</code> callback, but the technique is not limited to <code>NoteHead</code>s. However, the <code>NoteHead</code> callback is particularly important, since it is the implicit callback used by the <code>\tweak</code> command.

	The example function ~~defined~~ below (~~"~~display-grobs~~"~~) is ~~probably not that useful, but it demonstrates that the grobs are indeed being accessed~~.		The console output of the example function below (<code>display-grobs</code>) is as follows.

	~~Example console output:~~		<pre>
			--------------------
			#<Grob Accidental >
			()
			#<Grob Stem >
			</pre>

	~~<code>#<Grob Accidental ></code><br />~~		It is probably not that useful, but it demonstrates that the grobs are indeed being accessed.
	~~<code>()</code><br />~~
	~~<code>#<Grob Stem ></code>~~

	<lilypond version="2.24">		<lilypond version="2.24">

Jean Abou Samra: Replace version="2.24.0" with version="2.24" now that the LilyWiki extension supports auto-selecting the latest release in a stable series

2025-11-16T18:51:04Z

Replace version="2.24.0" with version="2.24" now that the LilyWiki extension supports auto-selecting the latest release in a stable series

← Older revision		Revision as of 18:51, 16 November 2025
Line 11:		Line 11:
	<code>#<Grob Stem ></code>		<code>#<Grob Stem ></code>

	<lilypond version="2.24.0">		<lilypond version="2.24">
	#(define (notehead-get-accidental notehead)		#(define (notehead-get-accidental notehead)
	;; notehead is grob		;; notehead is grob

Jean Abou Samra: Import snippet from LSR

2025-10-26T22:38:58Z

Import snippet from LSR

New page

Some grobs can be accessed “laterally” from within another grob’s callback. These are usually listed as “layout objects” in the “Internal properties” section of a grob-interface. The function ly:grob-object is used to access these grobs.

Demonstrated below are some ways of accessing grobs from within a NoteHead callback, but the technique is not limited to NoteHeads. However, the NoteHead callback is particularly important, since it is the implicit callback used by the <code>\tweak</code> command.

The example function defined below ("display-grobs") is probably not that useful, but it demonstrates that the grobs are indeed being accessed.

Example console output:

<code>#<Grob Accidental ></code><br />
<code>()</code><br />
<code>#<Grob Stem ></code>

<lilypond version="2.24.0">
#(define (notehead-get-accidental notehead)
;; notehead is grob
(ly:grob-object notehead 'accidental-grob))

#(define (notehead-get-arpeggio notehead)
;; notehead is grob
(let ((notecolumn (notehead-get-notecolumn notehead)))
(ly:grob-object notecolumn 'arpeggio)))

#(define (notehead-get-notecolumn notehead)
;; notehead is grob
(ly:grob-parent notehead X))

#(define (notehead-get-stem notehead)
;; notehead is grob
(let ((notecolumn (notehead-get-notecolumn notehead)))
(ly:grob-object notecolumn 'stem)))

#(define (display-grobs notehead)
;; notehead is grob
(let ((accidental (notehead-get-accidental notehead))
(arpeggio (notehead-get-arpeggio notehead))
(stem (notehead-get-stem notehead)))
(format (current-error-port) "~2&~a\n" (make-string 20 #\-))
(for-each
(lambda (x) (format (current-error-port) "~a\n" x))
(list accidental arpeggio stem))))

\relative c' {
%% display grobs for each note head:
%\override NoteHead.before-line-breaking = #display-grobs
<c
%% or just for one:
\tweak before-line-breaking #display-grobs
es
g>1\arpeggio
}
</lilypond>

[[Category:Scheme]]
[[Category:Scheme]]
[[Category:Tweaks and overrides]]
[[Category:Included in the official documentation]]