Rotulus – 1

A widget that shows a long, fast-growing stream of chat messages.

One frame of an animation.

An opaque handle to a row. A mark stays valid until the row it names goes (removed, trimmed by RotulusView:max-lines, or cleared), and is weak: using a stale one is a safe no-op, and rotulus_view_remove() returning FALSE is the intended way to find out.

A row under construction: the introspectable counterpart of RotulusRow. Build one, hand it to rotulus_view_append_message(), and free it; the view copies what it needs.

A row’s reactions under construction. Build one, hand it to rotulus_view_set_reactions(), and free it; the view copies what it needs.

A row, for the C row API. Language bindings use RotulusMessage.

A slice of text with a color and attributes, for the C row API. Runs are borrowed for the duration of the call; the view copies what it needs, so build them on the stack. The first four fields are all most callers set (ROTULUS_RUN).

Who said it. The view only compares key, hands it back in the speaker signals, and passes it to the avatar function. A wrong key is worse than none: it attaches the wrong avatar and groups two people’s messages.

Which way a RotulusView::load-more request pages.

What a row is.

Resolves a speaker’s key to the image in their avatar slot. Called on every draw, so an animated avatar animates; cache anything expensive. The function must not change the view.

Splits text carrying mIRC formatting codes (bold, italic, underline, strikethrough, monospace, reverse, reset, and colors by number or hex) into runs, with the codes removed. The runs point into text, which must outlive them. Colors 0..15 address the palette’s mIRC slots; the extended colors and hex colors are RGB.

The run’s background is a palette index for its background.

The run’s background_rgb is its background, as 0xRRGGBB.

Bold text.

Italic text.

Monospace text, as for code.

No attributes.

Swap the run’s foreground and background.

The run’s rgb is its foreground, as 0xRRGGBB, instead of color.

Struck-through text.

Underlined text.

The default RotulusView:avatar-size, in pixels.

A run color meaning the view’s default text color.

The default RotulusView:group-gap, in seconds.

The palette slot for the default background.

How many colors a palette holds: the mIRC colors, the roles, and the per-nick colors. rotulus_view_set_palette() takes this many.

The palette slot for the default text color.

The palette slot for the nick on a line that mentions you.

The palette slot for the selection’s background.

The palette slot for the selection’s foreground.

The palette slot for the last-read marker line.

How many palette slots the mIRC colors take, from slot 0, so that IRC formatting can address them by number.

The palette slot for secondary text: history rows and captions.

The palette slot for other people’s nicks.

The palette slot for the brackets around other people’s nicks.

The first of the per-nick color slots.

How many per-nick color slots there are, from ROTULUS_PAL_NICK_COLOR0.

The palette slot for the column divider.

The palette slot for the brackets around your own nick.

The palette slot for your own nick.

The palette slot for the tag of a status line.

The palette slot for the brackets around a status line’s tag.

The palette slot for the timestamp column.

A “/me” action. It never groups with its neighbors.

The row originated here rather than arriving from elsewhere. It breaks grouping independently of who the speaker is: in a conversation with yourself, both halves have the same speaker, and only direction tells your echo from the copy that came back.