themes Namespace Reference

Functions
	update_themes_dir
	load
	delete_theme name
	theme_okay
	get_file theme_name
	get_all_themes
	get_visible_themes
	handle_theme_change ?name1? ?name2? ?op?
	handle_colorize_change name1 name2 op
	handle_hidden_change name1 name2 op
	import parent_win fname
	export parent_win theme odir creator website license
	export_custom ?parent_win?
	populate_theme_menu mnu
	get_current_theme
	get_imported name
	get_attributions name
	get_user_directory
	get_share_items dir
	share_changed dir

Function Documentation

delete_theme()

themes::delete_theme			name

Definition at line 95 of file themes.tcl.

  proc delete_theme {name} {

    variable files

    # If the theme file exists, delete the file
    if {[info exists files($name)] && [file exists $files($name)]} {
      file delete -force $files($name)
    }

    # Reload the theme information
    load

  }

export()

themes::export			parent_win theme odir creator website license

Definition at line 226 of file themes.tcl.

  proc export {parent_win theme odir creator website license} {

    # Create the theme directory
    file mkdir [set theme_dir [file join $odir $theme]]

    # Populate the theme directory with the given contents
    if {![theme::export $theme $theme_dir $creator $website $license]} {
      tk_messageBox -parent $parent_win -icon error -type ok -default ok \
        -message "Unable to export theme contents"
      return
    }

    # Get the current working directory
    set pwd [pwd]

    # Set the current working directory to the user themes directory
    cd $theme_dir

    puts "theme: $theme, odir: $odir, odir contents: [glob *]"
    puts [glob *]

    # Perform the archive
    if {[catch { zipper::list2zip $theme [glob *] [file join .. $theme.tkethemz]} rc]} {
      puts "list2zip, rc: $rc"
      if {[catch { exec -ignorestderr zip -r [file join .. $theme.tkethemz] $theme} rc]} {
        puts "zip, rc: $rc"
        tk_messageBox -parent $parent_win -icon error -type ok -default ok \
          -message "Unable to zip theme file"
        return
      }
    }

    # Restore the current working directory
    cd $pwd

    # Delete the theme directory and its contents
    file delete {*}[glob -nocomplain -directory $theme_dir *]
    file delete -force $theme_dir

  }

export_custom()

themes::export_custom			?parent_win?

Definition at line 269 of file themes.tcl.

  proc export_custom {{parent_win .}} {

    variable files
    variable themes_dir

    # Create the themes directory
    set output_dir [file join ~ Desktop UpdatedThemes]
    set current    [theme::get_current_theme]

    # If the output directory exists, delete it
    if {[file exists $output_dir]} {
      file delete -force $output_dir
    }

    # Make the output directory
    file mkdir $output_dir

    # Load each theme and then export it
    foreach {name theme_file} [array get files] {

      # Only consider themes from the themes_dir
      if {[string compare -length [string length $themes_dir] $theme_file $themes_dir] != 0} {
        continue
      }

      # Initialize some variables
      set license [file join [file dirname $theme_file] LICENSE]

      # Load the theme
      theme::read_tketheme $theme_file

      # Export the theme to the output directory
      array set attrs [list creator "" website "" date ""]
      array set attrs [theme::get_attributions]

      # Export the loaded theme
      export $parent_win $name $output_dir $attrs(creator) $attrs(website) $license

    }

    # Restore the theme namespace with the current theme contents
    theme::load_theme $files($current)

    # Tell the user that the export was successful
    gui::set_info_message [msgcat::mc "Batch custom theme export completed successfully"]

  }

get_all_themes()

themes::get_all_themes

Definition at line 134 of file themes.tcl.

  proc get_all_themes {} {

    variable files

    return [lsort [array names files]]

  }

get_attributions()

themes::get_attributions			name

Definition at line 369 of file themes.tcl.

  proc get_attributions {name} {

    variable files

    array set attrs [list creator "" website "" date ""]

    if {[info exists files($name)]} {
      array set attrs [theme::get_file_attributions $files($name)]
    }

    return [array get attrs]

  }

get_current_theme()

themes::get_current_theme

Definition at line 344 of file themes.tcl.

  proc get_current_theme {} {

    variable curr_theme

    return $curr_theme

  }

get_file()

themes::get_file			theme_name

Definition at line 120 of file themes.tcl.

  proc get_file {theme_name} {

    variable files

    if {[info exists files($theme_name)]} {
      return $files($theme_name)
    }

    return -code error "Filename for theme $theme_name does not exist"

  }

get_imported()

themes::get_imported			name

Definition at line 354 of file themes.tcl.

  proc get_imported {name} {

    variable files
    variable themes_dir

    if {[info exists files($name)]} {
      return [expr [string compare -length [string length $themes_dir] $themes_dir $files($name)] == 0]
    }

    return 0

  }

get_share_items()

themes::get_share_items			dir

Definition at line 395 of file themes.tcl.

  proc get_share_items {dir} {

    return [list themes]

  }

get_user_directory()

themes::get_user_directory

Definition at line 385 of file themes.tcl.

  proc get_user_directory {} {

    variable themes_dir

    return $themes_dir

  }

get_visible_themes()

themes::get_visible_themes

Definition at line 144 of file themes.tcl.

  proc get_visible_themes {} {

    variable files

    # Create list of files to
    return [lsort [::struct::set difference [array names files] [preferences::get Appearance/HiddenThemes]]]

  }

handle_colorize_change()

themes::handle_colorize_change			name1 name2 op

Definition at line 171 of file themes.tcl.

  proc handle_colorize_change {name1 name2 op} {

    theme::update_syntax

  }

handle_hidden_change()

themes::handle_hidden_change			name1 name2 op

Definition at line 179 of file themes.tcl.

  proc handle_hidden_change {name1 name2 op} {

    # Reload the themes
    load

  }

handle_theme_change()

themes::handle_theme_change			?name1? ?name2? ?op?

Definition at line 155 of file themes.tcl.

  proc handle_theme_change {{name1 ""} {name2 ""} {op ""}} {

    variable files

    set user_theme [preferences::get Appearance/Theme]

    if {[info exists files($user_theme)]} {
      theme::load_theme $files($user_theme)
    } else {
      theme::load_theme $files(Default)
    }

  }

import()

themes::import			parent_win fname

Definition at line 191 of file themes.tcl.

  proc import {parent_win fname} {

    variable files
    variable themes_dir

    # If the directory exists, move it out of the way
    set odir [file join $themes_dir [file rootname [file tail $fname]]]
    if {[file exists $odir]} {
      file rename $odir $odir.old
    }

    # Unzip the file contents
    if {[catch { zipper::unzip $fname $themes_dir} rc]} {
      if {[catch { exec -ignorestderr unzip -u $fname -d $themes_dir} rc]} {
        catch { file rename $odir.old $odir}
        tk_messageBox -parent $parent_win -icon error -type ok -default ok \
          -message "Unable to unzip theme file" -detail $rc
        return ""
      }
    }

    # Remove the old file if it exists
    catch { file delete [file exists $odir.old]}

    # Reload the available themes
    load

    # Return the pathname of the installed .tketheme file
    return $files([file rootname [file tail $fname]])

  }

load()

themes::load

Definition at line 48 of file themes.tcl.

  proc load {} {

    variable files
    variable themes_dir

    # Update the user's themes directory
    update_themes_dir

    # Trace changes to syntax preference values
    if {[array size files] == 0} {
      trace variable preferences::prefs(Appearance/Theme)        w themes::handle_theme_change
      trace variable preferences::prefs(Appearance/Colorize)     w themes::handle_colorize_change
      trace variable preferences::prefs(Appearance/HiddenThemes) w themes::handle_hidden_change
    }

    # Reset the files/themes arrays and unregister launcher items
    array unset files
    launcher::unregister [msgcat::mc "Theme:*"]

    # Load the tke_dir theme files
    set tfiles [utils::glob_install [file join $::tke_dir data themes] *.tketheme]

    # Load the theme files
    foreach item [glob -nocomplain -directory $themes_dir -types d *] {
      if {[file exists [file join $item [file tail $item].tketheme]]} {
        lappend tfiles [file join $item [file tail $item].tketheme]
      }
    }

    # Get the theme information
    foreach tfile $tfiles {
      set name         [file rootname [file tail $tfile]]
      set files($name) $tfile
    }

    # Create the launcher items (only display the visible themes)
    foreach name [get_visible_themes] {
      launcher::register [format "%s: %s" [msgcat::mc "Theme"] $name] [list theme::load_theme $files($name)] "" [list themes::theme_okay]
    }

    # Allow the preferences UI to be updated, if it exists
    pref_ui::themes_populate_table

  }

populate_theme_menu()

themes::populate_theme_menu			mnu

Definition at line 319 of file themes.tcl.

  proc populate_theme_menu {mnu} {

    variable files
    variable curr_theme

    # Get the current theme
    set curr_theme [theme::get_current_theme]

    # Figure out the state for the items
    set state [expr {[themer::window_exists] ? "disabled" : "normal"}]

    # Clear the menu
    $mnu delete 0 end

    # Populate the menu with the available themes
    foreach name [get_visible_themes] {
      $mnu add radiobutton -label $name -variable themes::curr_theme -value $name -command [list theme::load_theme $files($name)] -state $state
    }

    return $mnu

  }

share_changed()

themes::share_changed			dir

Definition at line 403 of file themes.tcl.

  proc share_changed {dir} {

    variable themes_dir

    set themes_dir [file join $dir themes]

  }

theme_okay()

themes::theme_okay

Definition at line 111 of file themes.tcl.

  proc theme_okay {} {

    return [expr [themer::window_exists] ^ 1]

  }

update_themes_dir()

themes::update_themes_dir

Definition at line 35 of file themes.tcl.

  proc update_themes_dir {} {

    variable themes_dir

    foreach fname [glob -nocomplain -directory $themes_dir *.tketheme] {
      file mkdir [file rootname $fname]
      file rename $fname [file rootname $fname]
    }

  }