richtext/dev.mkeeda.arranger.richtext/AttributeEditScope

AttributeEditScope

class AttributeEditScope

A builder DSL for safely mutating multiple text attributes within a specific range.

Functions

backgroundColor

fun AttributeEditScope.backgroundColor(color: RgbaColor)

Convenience function to set the background color within this builder.

blockquote

fun AttributeEditScope.blockquote()

Convenience function to set the blockquote attribute of the paragraph within this builder. The applied range will automatically snap to paragraph boundaries.

bold

fun AttributeEditScope.bold()

Convenience function to apply the bold text attribute within this builder.

bulletList

fun AttributeEditScope.bulletList(level: ListIndentLevel)

Convenience function to set the bullet list attribute of the paragraph within this builder. The applied range will automatically snap to paragraph boundaries.

clearAll

fun clearAll()

Removes all rich text attributes (both span and paragraph level) in the range. Including user-customized attributes.

clearBackgroundColor

fun AttributeEditScope.clearBackgroundColor()

Convenience function to remove the background color attribute in the range.

clearBlockquote

fun AttributeEditScope.clearBlockquote()

Convenience function to remove the blockquote attribute in the range.

clearBold

fun AttributeEditScope.clearBold()

Convenience function to remove the bold attribute in the range.

clearBulletList

fun AttributeEditScope.clearBulletList()

Convenience function to remove the bullet list attribute in the range.

clearFontSize

fun AttributeEditScope.clearFontSize()

Convenience function to remove the font size attribute in the range.

clearHeadingLevel

fun AttributeEditScope.clearHeadingLevel()

Convenience function to remove the heading attribute in the range.

clearInlineCode

fun AttributeEditScope.clearInlineCode()

Convenience function to remove the inline code attribute in the range.

clearItalic

fun AttributeEditScope.clearItalic()

Convenience function to remove the italic attribute in the range.

clearLink

fun AttributeEditScope.clearLink()

Convenience function to remove the link attribute in the range.

clearOrderedList

fun AttributeEditScope.clearOrderedList()

Convenience function to remove the ordered list attribute in the range.

clearStrikethrough

fun AttributeEditScope.clearStrikethrough()

Convenience function to remove the strikethrough attribute in the range.

clearTextAlignment

fun AttributeEditScope.clearTextAlignment()

Convenience function to remove the text alignment attribute in the range.

clearTextColor

fun AttributeEditScope.clearTextColor()

Convenience function to remove the text color attribute in the range.

clearUnderline

fun AttributeEditScope.clearUnderline()

Convenience function to remove the underline attribute in the range.

fontSize

fun AttributeEditScope.fontSize(size: TextSize)

Convenience function to set the font size within this builder.

headingLevel

fun AttributeEditScope.headingLevel(level: HeadingLevel?)

Convenience function to set the heading level of the paragraph within this builder. The applied range will automatically snap to paragraph boundaries.

inlineCode

fun AttributeEditScope.inlineCode()

Convenience function to apply the inline code text attribute within this builder.

italic

fun AttributeEditScope.italic()

Convenience function to apply the italic text attribute within this builder.

link

fun AttributeEditScope.link(url: String)

Convenience function to set the link attribute within this builder.

orderedList

fun AttributeEditScope.orderedList(level: ListIndentLevel)

Convenience function to set the ordered list attribute of the paragraph within this builder. The applied range will automatically snap to paragraph boundaries.

setParagraphAttribute

fun <T : Any> setParagraphAttribute(key: ParagraphAttributeKey<T>, value: T?)

Sets or removes a paragraph-level attribute for the given key. The underlying range is automatically snapped to paragraph boundaries.

setSpanAttribute

fun <T : Any> setSpanAttribute(key: SpanAttributeKey<T>, value: T?)

Sets or removes a character span attribute for the given key. If value is null, the span attribute is removed from the specified range.

strikethrough

fun AttributeEditScope.strikethrough()

Convenience function to apply the strikethrough text attribute within this builder.

textAlignment

fun AttributeEditScope.textAlignment(alignment: TextAlignment?)

Convenience function to set the text alignment of the paragraph within this builder. The applied range will automatically snap to paragraph boundaries.

textColor

fun AttributeEditScope.textColor(color: RgbaColor)

Convenience function to set the text color within this builder.

underline

fun AttributeEditScope.underline()

Convenience function to apply the underline text attribute within this builder.