Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/colinkiama/vala-gtk4-text-formatting-demo
An app that demonstrates how to create a Vala GTK 4 app with text formatting features.
https://github.com/colinkiama/vala-gtk4-text-formatting-demo
demo elementary elementary-apps elementary-os foundation gnome gtk gtk4 guide help text text-formatting vala vala-applications
Last synced: about 2 months ago
JSON representation
An app that demonstrates how to create a Vala GTK 4 app with text formatting features.
- Host: GitHub
- URL: https://github.com/colinkiama/vala-gtk4-text-formatting-demo
- Owner: colinkiama
- License: unlicense
- Created: 2023-03-26T12:38:51.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-05T09:36:04.000Z (about 1 year ago)
- Last Synced: 2024-10-12T18:51:36.668Z (3 months ago)
- Topics: demo, elementary, elementary-apps, elementary-os, foundation, gnome, gtk, gtk4, guide, help, text, text-formatting, vala, vala-applications
- Language: Vala
- Homepage:
- Size: 1.12 MB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: License.md
Awesome Lists containing this project
README
# text_formatting
An app that demonstrates how to create a Vala GTK 4 app with text formatting features.
Features:
- Logic of making text bold, italic and/or underlined
- Implements actions and binds them to action buttons
- Keyboard shortcuts for executing text formatting actions.
- Keeping formatting action states in sync based on caret (text cursor) position.
- Adding extra formatting menu to menu items in `Gtk.TextView` context menu
- And more...
## Prerequisites
- glib-2.0
- gobject-2.0
- gtk4
- gee-0.8
## Build instructions:
```Bash
$ meson build
$ ninja -C build
$ build/src/my_text_formatting_demo
```
## How to store/load formatted text data
You can retrieve the text using the `text` field in `Gtk.TextBuffer` or with `get_text()` however
the formatting is stored in the text buffer's tag table. Here's a block of code you can use to get the data you need
for each tag:
```vala
this.text_buffer.tag_table.foreach ((tag) => {
Gtk.TextIter start;
this.text_buffer.get_start_iter (out start);
do {
if (!start.starts_tag (tag)) continue;
Gtk.TextIter begin = start.copy ();
start.forward_to_tag_toggle (tag);
print ("Tag name: %s\n", tag.name);
print ("Tag start location: %d\n", begin.get_offset ());
print ("Tag end location: %d\n", start.get_offset ());
print ("\n");
} while (start.forward_to_tag_toggle (tag));
});
```
You could adapt the block of code above to store the tag data in a list and use that with the text from the text buffer
to store the formatted text data in any data format you desire.
To load the data and replicate the same formatting, you'll need to do the opposite. Parse the data from your data format then
provide the text buffer object with the text and formatting tags separately.
For an example of an app that does this in production, see Sticky Notes (Note: It's written in TypeScript): https://github.com/vixalien/sticky
## Resources Used
- GTK 4 Text Widget Overview - https://docs.gtk.org/gtk4/section-text-widget.html
- GTK 4 Documentation - https://docs.gtk.org/gtk4/
- GTK 4 Widget Fatory Demo - https://gitlab.gnome.org/GNOME/gtk/-/tree/main/demos/widget-factory
- Valadoc.org - https://valadoc.org
- elementary OS Mail - https://github.com/elementary/mail
- Sticky Notes App - https://github.com/vixalien/sticky