Skip to main content

More on Pango Markup Strings

I don't like fiddling around with markup strings, even at the best of times. So, any convienient way of producing the right formatting is welcome news to me. Gtk widgets allow markupstrings for various text elements. So, I thought, how about creating strings on the fly using familiar Tcl means. Hence the following two procs below. One will create markup and the other remove it. The removal method is still basic, it will also strip out markup-like items such as <b> so its use is limited. It is also assumed that there will only be one "<span"  entry per string. Modifying the code to remove more that one <span group should not be too much of an issue.

The need behind creating these procs comes from wanting to quickly add/remove markup strings from tree/listview cells.

#---------------
# pango_string.tcl
#---------------
# !/bin/sh
# the next line restarts using tclsh \
exec tclsh "$0" "$@"
package require Gnocl

#---------------
# Create Pango formatted string.
#---------------
# Arguments
#    str        The text string to format.
#    args    Matched pair of options and values.
# Returns
#---------------
proc pango_string {str args} {
    set span_str ""
    foreach {a b} $args {
        puts "a = $a b = $b"
        switch -- $a {
            -big {
                if {$b} {set str  "<big>$str</big>" }
                }
            -bold {
                if {$b} { set str  "<b>$str</b>" }
                }
            -italic {
                if {$b} { set str  "<i>$str</i>" }
                }
            -small {
                if {$b} { set str  "<small>$str</small>" }
                }
            -strikethrough {
                if {$b} { set str  "<s>$str</s>" }
                }
            -sub {
                if {$b} { set str  "<sub>$str</sub>" }
                }
            -sup {
                if {$b} { set str  "<sup>$str</sup>"}
                }
            -tt {
                if {$b} { set str  "<tt>$str</tt>" }
                }
            -bg -
            -bgClr -
            -background {
                append span_str " background=\"$b\""
                }
            -fallback {
                append span_str " fallback=\"$b\""
                }
            -font {
                append span_str " font=\"$b\""
                }
            -fg -
            -fgClr -
            -foreground {
                append span_str " foreground=\"$b\""
                }
            -gravity {
                append span_str " gravity=\"$b\""
                }
            -gravityHint {
                append span_str " gravity_hint=\"$b\""
                }               
            -lang {
                append span_str " lang=\"$b\""
                }
            -rise {
                append span_str " rise=\"$b\""
                }
            -style {
                append span_str " style=\"$b\""
                }   
            -size {
                append span_str " size=\"$b\""
                }
            -letterSpacing {
                append span_str " letter_spacing=\"$b\""
                }
            -stretch {
                append span_str " stretch=\"$b\""
                }
            -strikethroughColor {
                append span_str " strikethrough_color=\"$b\""
                }
            -underline {
                if {$b == 1} {
                    set str  "<u>$str</u>"
                    } else {
                    append span_str " underline=\"$b\""
                    }
                }
            -underlineColor {
                append span_str " underline_color=\"$b\""
                }
            -variant {
                append span_str " size=\"$b\""
                }
            -weight {
                append span_str " size=\"$b\""
                }

        }
    }
   
    if {$span_str != ""} {
        set str "<span $span_str>$str</span>"
    }
   
    return $str
}


if {1} {
    set box [gnocl::box -orientation vertical]

    for {set i 0} {$i <= 5} {incr i} {
        set lab($i) [gnocl::label]
        $box add $lab($i)
    }

    $lab(0) configure -text [pango_string "Hello World" -bold 1]
    $lab(1) configure -text [pango_string "Hello World" -bold 1 -foreground red]
    $lab(2) configure -text "[pango_string "Hello" -bold 1 -foreground red] [pango_string "World" -bold 1 -foreground blue -italic 1]"
    $lab(3) configure -text "[pango_string "Hello" -stretch ultraexpanded -bold 1 -foreground red] [pango_string "World" -bold 1 -foreground blue -italic 1]"
    gnocl::window -child $box
}

#---------------
# Remove pango formatting from a string.
#---------------
# Arguments
#    str        string with pango markup
# Returns
#    plain text string
# Notes
#   Use with caution.
#    Will also strip <u> etc., from within text strings.
#---------------
proc pango_remove {str} {
    set str [string map {
        <u>     "" </u>     ""
        <b>     "" </b>     ""
        <i>     "" </i>     ""
        <s>     "" </s>     ""
        <big>   "" </big>   ""
        <small> "" </small> ""
        <sub>   "" </sub>   ""
        <sup>   "" </sup>   ""
        <tt>    "" </tt>    ""
        </span> ""
    } $str]

    # remove span
    set i [string first "<span" $str]
    if {!$i} {
        set j [string first ">" $str]
        set str [string range $str [incr j] end]
    }


    return $str
}

if {1} {
    set markup(block) "-fg red -bold 1"
    set str [eval pango_string "NO-<b>PANGO" $markup(block) ]
    puts $str
    puts ==|[pango_remove $str]|==
}


Comments

Popular posts from this blog

gnocl::calendar

Given this module some attention today. Added some of the more package wide options to the module and created customised handler for setting the month. (For some odd reason months are are counted 0-11 whereas days are 1-31.) There's still a little more to do to this one including the addition of code to store diary details. Here's the working test script to show the range of options at work. The percentage substitution string item %e explores something that I've been toying with, the name of the signal/event that initiated the call. Ok, a script can keep its own internal trace but who knows, it might prove useful. #--------------- # calendarTest.tcl #--------------- # Author:   William J Giddings # Date:     07/05/09 #--------------- #!/bin/sh # the next line restarts using tclsh \ exec tclsh "$0" "$@" #--------------- package require Gnocl set cal [gnocl::calendar] $cal configure -day 8 -month 7 -year 1956 $cal configure -rowHeight 1 -colWidth 1 $ca...

Gnocl Dashboard

Over the past few programming sessions I've been working on producing a central point, a dashboard, around which it's possible to see the various Gnocl widgets and commands in operation. In many ways like the demo script which shipped with the earlier releases of Gnocl but offers much more. The introspection functionality provides details of the various options and sub-commands of each Gnocl procedure which are displayed under the associated tab. Sample scripts are included for each item which offers newcomers a clearer insight into how make the most of what's on offer.

Getting Widget Style Properties

Until the move over to Gtk4, Gnocl is still built against the Gtk 2.21 libraries. One of the inconveniences of Gtk is getting and setting widget style settings which are considered to be set globally by the desktop style settings and not for the programmer to tinker around with. Needless to say, there are times when different defaults are preferred, largely to draw the users attention to 'something a bit different'. The function gtk_widget_modify_font  is a convenience function to set the widget basefont as shown in this snippet from the button.c module,  if ( options[baseFontIdx].status == GNOCL_STATUS_CHANGED ) { GtkWidget *label; label = gnoclFindChild ( GTK_WIDGET ( para->button ), GTK_TYPE_LABEL ); PangoFontDescription *font_desc = pango_font_description_from_string ( Tcl_GetString ( options[baseFontIdx].val.obj ) ); gtk_widget_modify_font ( GTK_WIDGET ( label ), font_desc ); pango_font_description_free ( font_desc ); } Unfortunately, there's no d...