#  Whiteboard.tcl --
#  
#      This file is part of The Coccinella application. 
#      It implements the actual whiteboard.
#      
#  Copyright (c) 2002-2008  Mats Bengtsson
#  
#   This program is free software: you can redistribute it and/or modify
#   it under the terms of the GNU General Public License as published by
#   the Free Software Foundation, either version 3 of the License, or
#   (at your option) any later version.
#   
#   This program is distributed in the hope that it will be useful,
#   but WITHOUT ANY WARRANTY; without even the implied warranty of
#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#   GNU General Public License for more details.
#   
#   You should have received a copy of the GNU General Public License
#   along with this program.  If not, see <http://www.gnu.org/licenses/>.
#  
# $Id: Whiteboard.tcl,v 1.98 2008-05-28 09:51:08 matben Exp $

package require anigif
package require moviecontroller
package require uriencode
package require CanvasDraw
package require CanvasText
package require CanvasUtils
package require CanvasCutCopyPaste
package require CanvasCmd
package require CanvasFile
package require FileCache
package require FilePrefs
package require GetFileIface
package require Import
package require ItemInspector
package require Plugins
package require PutFileIface
package require WBPrefs
package require WDialogs
package require UI

package provide Whiteboard 1.0

namespace eval ::WB {
        
    # Add all event hooks.
    # We use 'whiteboardPrefsInitHook' since we depend on Plugins.
    ::hooks::register firstLaunchHook     ::WB::FirstLaunchHook
    ::hooks::register initHook            ::WB::InitHook
    #::hooks::register prefsInitHook       ::WB::InitPrefsHook
    ::hooks::register whiteboardPrefsInitHook       ::WB::InitPrefsHook
    ::hooks::register quitAppHook         ::WB::QuitAppHook
    ::hooks::register quitAppHook         ::WB::SaveAnyState
    ::hooks::register whiteboardCloseHook ::WB::CloseWhiteboard
    ::hooks::register loginHook           ::WB::LoginHook
    ::hooks::register logoutHook          ::WB::LogoutHook

    # Tool button mappings.
    variable btNo2Name 
    variable btName2No
    variable BtName
    array set btNo2Name	{
	00 point  01 move  10 line   11 arrow 
	20 rect   21 oval  30 pen    31 brush
	40 text   41 del   50 paint  51 poly 
	60 arc    61 rot
    }
    array set btName2No {
	point 00  move 01  line  10  arrow 11 
	rect  20  oval 21  pen   30  brush 31
	text  40  del  41  paint 50  poly  51 
	arc   60  rot  61
    }
    set BtName [dict create]
    dict set BtName point [mc "Point tool, click to mark, double click to inspect, right click to popup"]
    dict set BtName move  [mc "Move tool"]
    dict set BtName line  [mc "Line tool"]
    dict set BtName arrow [mc "Arrow tool"]
    dict set BtName rect  [mc "Rectangle tool"]
    dict set BtName oval  [mc "Oval tool"]
    dict set BtName del   [mc "Click to delete"]
    dict set BtName pen   [mc "Pen tool"]
    dict set BtName brush [mc "Brush tool"]
    dict set BtName paint [mc "Paint tool, shift-click for transparency"]
    dict set BtName poly  [mc "Polygon tool, spacebar to cancel"]
    dict set BtName arc   [mc "Arc tool, click to set center, spacebar to cancel"]
    dict set BtName rot   [mc "Rotate tool, select item first"]
    dict set BtName text  [mc "Text tool"]

    # Use option database for customization.
    option add *TopWhiteboard*TRadiobutton.padding  {0}             50

    # Shortcut buttons.
    option add *TopWhiteboard.saveImage            document-save            widgetDefault
    option add *TopWhiteboard.saveDisImage         document-save-Dis         widgetDefault
    option add *TopWhiteboard.openImage            document-open            widgetDefault
    option add *TopWhiteboard.openDisImage         document-open-Dis         widgetDefault
    option add *TopWhiteboard.importImage          document-import          widgetDefault
    option add *TopWhiteboard.importDisImage       document-import-Dis       widgetDefault
    option add *TopWhiteboard.sendImage            mail-send            widgetDefault
    option add *TopWhiteboard.sendDisImage         mail-send-Dis         widgetDefault
    option add *TopWhiteboard.printImage           document-print           widgetDefault
    option add *TopWhiteboard.printDisImage        document-print-Dis        widgetDefault
    option add *TopWhiteboard.stopImage            dialog-error            widgetDefault
    option add *TopWhiteboard.stopDisImage         dialog-error-Dis    widgetDefault

    # Other icons.
    option add *TopWhiteboard.connect16Image       network-disconnect     widgetDefault
    option add *TopWhiteboard.connected16Image     network-connect       widgetDefault
    option add *TopWhiteboard.logoImage            logo            widgetDefault

    # Drawing tool buttons.
    # First define typical names, then redefine special names.
    foreach tname [array names btName2No] {
	option add *TopWhiteboard.tool${tname}Image draw-$tname    widgetDefault
    }
    option add *TopWhiteboard.toolmoveImage   transform-move    widgetDefault
    option add *TopWhiteboard.toolrotImage    transform-rotate  widgetDefault
    option add *TopWhiteboard.toolpaintImage  fill-color        widgetDefault

    # Color selector.
    option add *TopWhiteboard.bwrectImage          bwrect          widgetDefault
    option add *TopWhiteboard.colorSelectorImage   colorSelector   widgetDefault
    option add *TopWhiteboard.colorSelBWImage      colorSelBW      widgetDefault
    option add *TopWhiteboard.colorSelSwapImage    colorSelSwap    widgetDefault
    
    # Canvas selections.
    option add *TopWhiteboard.aSelect              2               widgetDefault
    option add *TopWhiteboard.fgSelectNormal       black           widgetDefault
    option add *TopWhiteboard.fgSelectLocked       red             widgetDefault

    # Special for X11 menus to look ok.
    if {[tk windowingsystem] eq "x11"} {
	option add *TopWhiteboard.Menu.borderWidth 0               50
    }

    # Keeps various geometry info.
    variable dims
    
    # @@@ BAD!!!!!!!!!!!!!!!!!!!!!!???????????????
    # Canvas size; these are also min sizes. Add new line of tools.
    set dims(wCanOri) 350
    set dims(hCanOri) [expr 328 + 28]
    # Canvas size; with border.
    set dims(wMinCanvas) [expr $dims(wCanOri) + 2]
    set dims(hMinCanvas) [expr $dims(hCanOri) + 2]
    set dims(x) 30
    set dims(y) 30
    # Total size of the application (not including menu); only temporary values.
    set dims(wRoot) 1    
    set dims(hRoot) 1
    # As above but including the menu.
    set dims(wTot) 1    
    set dims(hTot) 1   
    
    # Total screen dimension.
    set dims(screenH) [winfo vrootheight .]
    set dims(screenW) [winfo vrootwidth .]

    # Unique id for main toplevels
    variable uidmain 0
        
    # Plugin stuff.
    variable menuSpecPublic
    set menuSpecPublic(wpaths) {}
    
    variable iconsInitted 0
    
    # Prefs:
    # Should text inserts be batched?
    set prefs(batchText) 1

    # Delay time in ms for batched text.
    set prefs(batchTextms) 2000

    # Want to fit all movies within canvas?
    set prefs(autoFitMovies) 1

    # Html sizes or point sizes when transferring text items?
    set prefs(useHtmlSizes) 1

    # Offset when duplicating canvas items and when opening images and movies.
    # Needed in ::CanvasUtils::NewImportAnchor
    set prefs(offsetCopy) 16

    # Grid spacing.
    set prefs(gridDist) 40                 
    
    # Mark bounding box (1) or each coords (0).
    set prefs(bboxOrCoords) 0
    
    # Scale factor used when scaling canvas items.
    set prefs(scaleFactor) 1.2
    set prefs(invScaleFac) [expr 1.0/$prefs(scaleFactor)]

    # Use common CG when scaling more than one item?
    set prefs(scaleCommonCG) 0

    # Fraction of points to strip when straighten.
    set prefs(straightenFrac) 0.3
    
    # Are there a working canvas dash option?
    set prefs(haveDash) 0
    if {![string match "mac*" $this(platform)]} {
	set prefs(haveDash) 1
    }
    
    set ::config(wb,status-label) 0
}

# WB::InitPrefsHook --
# 
#       There is a global 'state' array which contains a generic state
#       that is inherited by instance specific 'state' array '::WB::${w}::state'

proc ::WB::InitPrefsHook {} {
    global  prefs this
    variable gstate
    
    ::Debug 2 "::WB::InitPrefsHook"
    
    # The tool buttons.
    set gstate(tool)      "point"
    set gstate(toolPrev)  "point"
    set gstate(toolCache) "point"
        
    # Bg color for canvas.
    set gstate(bgColCan) white
    
    # fg and bg colors set in color selector; bgCol always white.
    set gstate(fgCol) black
    set gstate(bgCol) white
    
    # Grid on or off.
    set gstate(canGridOn) 0                  
    
    # Line thickness.
    set gstate(penThick) 1	
    
    # Brush thickness.
    set gstate(brushThick) 8	
    
    # Fill color for circles, polygons etc.
    set gstate(fill) 0
    
    # If polygons should be smoothed.
    set gstate(smooth) 0
    
    # Arc styles.
    set gstate(arcstyle) "arc"
    
    # Dash style.
    set gstate(dash) { }
    
    # Font prefs set in menus. Sizes according to html.
    set gstate(fontSize) 2
    set gstate(font) Helvetica
    set gstate(fontWeight) normal
            
    # Constrain movements to 45 degrees, else 90 degree intervals.
    set prefs(45) 1

    #----   url's for streaming live movies ----------------------------------------
    set prefs(shortsMulticastQT) {{   \
      {user specified}   \
      {Bloomberg}          \
      {Hard Radio}       \
      {NPR}  \
      {BBC World TV} } {  \
      {}  \
      www.apple.com/quicktime/showcase/radio/bloomberg/bloombergradio.mov  \
      www.apple.com/quicktime/showcase/radio/hardradio/hardradio.mov  \
      www.apple.com/quicktime/showcase/radio/npr/npr.mov  \
      www.apple.com/quicktime/favorites/bbc_world1/bbc_world1.mov}}

    # States and prefs to be stored in prefs file.
    ::PrefUtils::Add [list  \
      [list prefs(45)              prefs_45              $prefs(45)]             \
      [list prefs(shortsMulticastQT) prefs_shortsMulticastQT $prefs(shortsMulticastQT) userDefault] \
      [list ::WB::gstate(tool)        wb_gstate_tool        $gstate(tool)]           \
      [list ::WB::gstate(bgColCan)    wb_gstate_bgColCan    $gstate(bgColCan)]       \
      [list ::WB::gstate(fgCol)       wb_gstate_fgCol       $gstate(fgCol)]          \
      [list ::WB::gstate(penThick)    wb_gstate_penThick    $gstate(penThick)]       \
      [list ::WB::gstate(brushThick)  wb_gstate_brushThick  $gstate(brushThick)]     \
      [list ::WB::gstate(fill)        wb_gstate_fill        $gstate(fill)]           \
      [list ::WB::gstate(arcstyle)    wb_gstate_arcstyle    $gstate(arcstyle)]       \
      [list ::WB::gstate(fontSize)    wb_gstate_fontSize    $gstate(fontSize)]       \
      [list ::WB::gstate(font)        wb_gstate_font        $gstate(font)]           \
      [list ::WB::gstate(fontWeight)  wb_gstate_fontWeight  $gstate(fontWeight)]     \
      [list ::WB::gstate(smooth)      wb_gstate_smooth      $gstate(smooth)]         \
      [list ::WB::gstate(dash)        wb_gstate_dash        $gstate(dash)]           \
      [list ::WB::gstate(canGridOn)   wb_gstate_canGridOn   $gstate(canGridOn)]  ]    
}

proc ::WB::FirstLaunchHook {} {
    #::WDialogs::WelcomeCanvas
}

proc ::WB::InitHook {} {
    Init
    InitMenuDefs   
}

# WB::Init --
# 
#       Various initializations for the UI stuff.

proc ::WB::Init {} {
    global  this prefs
    variable wbicons
    
    ::Debug 2 "::WB::Init"
        
    # Dashed options. Used both for the Preference menu and ItemInspector.
    # Need to be careful not to use empty string for menu value in -variable
    # because this gives the 'value' value.
    variable dashFull2Short
    variable dashShort2Full

    array set dashFull2Short {
	none " " dotted . dash-dotted -. dashed -
    }
    array set dashShort2Full {
	" " none . dotted -. dash-dotted - dashed
    }
    set dashShort2Full() none    

    # Init canvas utils.
    ::CanvasUtils::Init
    
    # Create the mapping between Html sizes and font point sizes dynamically.
    ::CanvasUtils::CreateFontSizeMapping
        
    # Drag and Drop support...
    set prefs(haveTkDnD) 0
    if {[tk windowingsystem] ne "aqua"} {
	if {![catch {package require tkdnd}]} {
	    set prefs(haveTkDnD) 1
	}    
    }

    variable animateWave
    
    # Defines canvas binding tags suitable for each tool.
    ::CanvasUtils::BindWhiteboardBindtags
    
    # Bindtags instead of binding to toplevel.
    bind TopWhiteboard <Destroy> {+::WB::Free %W}
}

# WB::InitIcons --
# 
#       Get all standard icons using the option database with the
#       preloaded icons as fallback.

proc ::WB::InitIcons {w} {
    variable icons
    variable iconsInitted 1
    variable btNo2Name
    variable btName2No
    variable wbicons
    	
    # Get icons.
    set icons(brokenImage) [::Theme::FindIconSize 32 image-missing]
    
    # Drawing tool buttons.
    foreach name [array names btName2No] {
	set rsrc [option get $w tool${name}Image {}]
	set wbicons($name) [::Theme::FindIconSize 22 $rsrc]
    }
    
    # Color selector.
    foreach name {colorSelector colorSelBW colorSelSwap} {
	set rsrc [option get $w ${name}Image {}]
	set wbicons($name) [::Theme::FindIcon elements/$rsrc]
    }
    set rsrc [option get $w bwrectImage {}]
    set wbicons(bwrect) [::Theme::FindIcon elements/$rsrc]
}

# WB::InitMenuDefs --
# 
#       The menu organization.

proc ::WB::InitMenuDefs {} {
    global  prefs this
    variable menuDefs
    
    ::Debug 2 "::WB::InitMenuDefs"

    if {[string match "mac*" $this(platform)] && $prefs(haveMenus)} {
	set haveAppleMenu 1
    } else {
	set haveAppleMenu 0
    }
    
    # Defines which menus to use; names and labels.
    variable menuBarDef
    set menuBarDef {
	file    mFile
	edit    mEdit
	prefs   mPreferences
	items   mLibrary
	info    mInfo
    }
	
    # All menu definitions for the main (whiteboard) windows as:
    #      {{type name cmd state accelerator opts} {{...} {...} ...}}
    
    # May be customized by jabber, p2p...

    set menuDefs(main,info,aboutwhiteboard)  \
      {command   mAboutCoccinella    {[mc "&About %s" $prefs(appName)]} {::Splash::SplashScreen}    {}}
    set menuDefs(main,info,aboutquicktimetcl)  \
      {command   mAboutQuickTimeTcl  {[mc "&About %s" QuickTimeTcl]} {::Dialogs::AboutQuickTimeTcl}  {}}

    # Only basic functionality.
    set menuDefs(main,file) {
	{command   mImportImage/Movie... {[mc "&Import Image/Movie"]...} {::WB::OnMenuImport}          I}
	{command   mOpenStream...        {[mc "Open St&ream"]...} {::WB::OnMenuOpenURL}         {}}
	{command   mOpenFile...          {[mc "&Open File"]...} {::WB::OnMenuOpenCanvas}      {}}
	{separator}
	{command   mCloseWindow          {[mc "&Close Window"]} {::UI::CloseWindowEvent}      W}
	{command   mSave                 {[mc "&Save"]...} {::WB::OnMenuSaveCanvas}      S}
	{command   mSaveAs               {[mc "Save &As"]...} {::WB::OnMenuSaveAs}          {}}
	{command   mSaveAsItem           {[mc "Sa&ve As Item"]...} {::WB::OnMenuSaveAsItem}      {}}
	{separator}
	{command   mPageSetup            {[mc "Page Set&up"]...} {::WB::OnMenuPageSetup}       {}}
	{command   mPrint...             {[mc "&Print"]...} {::WB::OnMenuPrintCanvas}     P}
	{separator}
	{command   mQuit                 {[mc "&Quit"]} {::UserActions::DoQuit}       Q}
    }
	    
    # If embedded the embedding app should close us down.
    if {$this(embedded)} {
	#lset menuDefs(main,file) end 3 disabled
    } else {
	package require Multicast
    }
    
    set menuDefs(main,edit) {    
	{command     mUndo             {[mc "&Undo"]} {::WB::OnMenuUndo}         Z}
	{command     mRedo             {[mc "Re&do"]} {::WB::OnMenuRedo}         {Shift-Z}}
	{separator}
	{command     mCut              {[mc "Cu&t"]} {::UI::CutEvent}           X}
	{command     mCopy             {[mc "&Copy"]} {::UI::CopyEvent}          C}
	{command     mPaste            {[mc "&Paste"]} {::UI::PasteEvent}         V}
	{command     mSelectAll        {[mc "Select &All"]} {::WB::OnMenuAll}          A}
	{command     mClear            {[mc "Clear"]} {::WB::OnMenuEraseAll}     {}}
	{separator}
	{command     mEditItem...      {[mc "&Edit Item"]...} {::WB::OnMenuItemInspector}  {}}
	{separator}
	{command     mRaise            {[mc "&Raise"]} {::WB::OnMenuRaise}        R}
	{command     mLower            {[mc "&Lower"]} {::WB::OnMenuLower}        L}
	{separator}
	{command     mLarger           {[mc "Larger"]} {::WB::OnMenuLarger}       >}
	{command     mSmaller          {[mc "Smaller"]} {::WB::OnMenuSmaller}      <}
	{cascade     mFlip             {[mc "Flip"]} {}                             {} {} {
	    {command   mHorizontal     {[mc "Horizontal"]} {::WB::OnMenuFlipHorizontal}     {} {}}
	    {command   mVertical       {[mc "Vertical"]} {::WB::OnMenuFlipVertical}       {} {}}}
	}
	{command     mImageLarger      {[mc "Image Larger"]} {::WB::OnMenuImageLarger}   {}}
	{command     mImageSmaller     {[mc "Image Smaller"]} {::WB::OnMenuImageSmaller}  {}}
    }
    
    # These are used not only in the drop-down menus.
    set menuDefs(main,prefs,separator) 	{separator}
    set menuDefs(main,prefs,background)  \
      {command     mBackgroundColor...   {[mc "Background Color"]...} {::CanvasCmd::SetCanvasBgColor $w}    {}}
    set menuDefs(main,prefs,grid)  \
      {checkbutton mGrid             {[mc "Grid"]} {::CanvasCmd::DoCanvasGrid $w}      {} \
      {-variable ::WB::${w}::state(canGridOn)}}
    set menuDefs(main,prefs,thickness)  \
      {cascade     mThickness        {[mc "Thickness"]} {}                                       {} {} {
	{radio   1                 {1} {}                                         {} \
	  {-variable ::WB::${w}::state(penThick)}}
	{radio   2                 {2} {}                                         {} \
	  {-variable ::WB::${w}::state(penThick)}}
	{radio   4                 {4} {}                                         {} \
	  {-variable ::WB::${w}::state(penThick)}}
	{radio   6                 {6} {}                                         {} \
	  {-variable ::WB::${w}::state(penThick)}}}
    }
    set menuDefs(main,prefs,brushthickness)  \
      {cascade     mBrushThickness   {[mc "Brush Thickness"]} {}                                       {} {} {
	{radio   8                 {8} {}                                         {} \
	  {-variable ::WB::${w}::state(brushThick)}}
	{radio   10                {10} {}                                         {} \
	  {-variable ::WB::${w}::state(brushThick)}}
	{radio   12                {12} {}                                         {} \
	  {-variable ::WB::${w}::state(brushThick)}}
	{radio   16                {16} {}                                         {} \
	  {-variable ::WB::${w}::state(brushThick)}}}
    }
    set menuDefs(main,prefs,fill)  \
      {checkbutton mFill             {[mc "Fill"]} {}                                       {} \
      {-variable ::WB::${w}::state(fill)}}
    set menuDefs(main,prefs,smoothness)  \
      {cascade     mLineSmoothness   {[mc "Line Smoothness"]} {}                                       {} {} {
	{radio   None              {[mc "None"]} {set ::WB::${w}::state(smooth) 0}           {} \
	  {-value 0 -variable ::WB::${w}::state(splinesteps)}}
	{radio   2                 {2} {set ::WB::${w}::state(smooth) 1}           {} \
	  {-value 2 -variable ::WB::${w}::state(splinesteps)}}
	{radio   4                 {4} {set ::WB::${w}::state(smooth) 1}           {} \
	  {-value 4 -variable ::WB::${w}::state(splinesteps)}}
	{radio   6                 {6} {set ::WB::${w}::state(smooth) 1}           {} \
	  {-value 6 -variable ::WB::${w}::state(splinesteps)}}
	{radio   10                {10} {set ::WB::${w}::state(smooth) 1}           {} \
	  {-value 10 -variable ::WB::${w}::state(splinesteps)}}}
    }
    set menuDefs(main,prefs,smooth)  \
      {checkbutton mLineSmoothness   {[mc "Line Smoothness"]} {}                                       {} \
      {-variable ::WB::${w}::state(smooth)}}
    set menuDefs(main,prefs,arcs)  \
      {cascade     mArcs             {[mc "Arcs"]} {}                                       {} {} {
	{radio   mPieslice         {[mc "Pieslice"]} {}                                         {} \
	  {-value pieslice -variable ::WB::${w}::state(arcstyle)}}
	{radio   mChord            {[mc "Chord"]} {}                                         {} \
	  {-value chord -variable ::WB::${w}::state(arcstyle)}}
	{radio   mArc              {[mc "Arc"]} {}                                         {} \
	  {-value arc -variable ::WB::${w}::state(arcstyle)}}}
    }

    # Dashes need a special build process. Be sure not to substitute $w.
    set dashList {}
    foreach dash [lsort -decreasing [array names ::WB::dashFull2Short]] {
	set dashval $::WB::dashFull2Short($dash)
	set lname [dict create]
	dict set lname none        [mc "None"]
	dict set lname dotted      [mc "Dotted"]
	dict set lname dashed      [mc "Dashed"]
	dict set lname dash-dotted [mc "Dash-dotted"]
	set str [dict get $lname $dash]
	if {[string equal " " $dashval]} {
	    set dopts {-value { } -variable ::WB::${w}::state(dash)}
	} else {
	    set dopts [format {-value %s -variable ::WB::${w}::state(dash)} $dashval]
	}
	lappend dashList [list radio $dash $str {} {} $dopts]
    }
    set menuDefs(main,prefs,dash)  \
      [list cascade   mDash          {[mc "Dash"]} {}                                       {} {} $dashList]
	
    set menuDefs(main,prefs,constrain)  \
      {cascade     mShiftConstrain   {[mc "Shift Constrain"]} {}                                       {} {} {
	{radio   mTo90degrees      {[mc "To 90 degrees"]} {}                                         {} \
	  {-variable prefs(45) -value 0}}
	{radio   mTo45degrees      {[mc "To 45 degrees"]} {}                                         {} \
	  {-variable prefs(45) -value 1}}}
    }
    set menuDefs(main,prefs,font)  \
      {cascade     mFont             {[mc "Font"]} {}                                       {} {} {}}
    set menuDefs(main,prefs,fontsize)  \
      {cascade     mSize             {[mc "Size"]} {}                                       {} {} {
	{radio   1                 {1} {::WB::FontChanged $w size}             {} \
	  {-variable ::WB::${w}::state(fontSize)}}
	{radio   2                 {2} {::WB::FontChanged $w size}             {} \
	  {-variable ::WB::${w}::state(fontSize)}}
	{radio   3                 {3} {::WB::FontChanged $w size}             {} \
	  {-variable ::WB::${w}::state(fontSize)}}
	{radio   4                 {4} {::WB::FontChanged $w size}             {} \
	  {-variable ::WB::${w}::state(fontSize)}}
	{radio   5                 {5} {::WB::FontChanged $w size}             {} \
	  {-variable ::WB::${w}::state(fontSize)}}
	{radio   6                 {6} {::WB::FontChanged $w size}             {} \
	  {-variable ::WB::${w}::state(fontSize)}}}
    }
    set menuDefs(main,prefs,fontweight)  \
      {cascade     mWeight           {[mc "Weight"]} {}                                       {} {} {
	{radio   mNormal           {[mc "Normal"]} {::WB::FontChanged $w weight}           {} \
	  {-value normal -variable ::WB::${w}::state(fontWeight)}}
	{radio   mBold             {[mc "Bold"]} {::WB::FontChanged $w weight}           {} \
	  {-value bold -variable ::WB::${w}::state(fontWeight)}}
	{radio   mItalic           {[mc "Italic"]} {::WB::FontChanged $w weight}           {} \
	  {-value italic -variable ::WB::${w}::state(fontWeight)}}}
    }
    set menuDefs(main,prefs,prefs)  \
      {command     mPreferences...   {[mc "&Preferences"]...} {::Preferences::Build}                   {}}
    
    # Build hierarchical list.
    set menuDefs(main,prefs) {}
    foreach key {background grid thickness brushthickness fill smooth  \
      arcs dash constrain separator font fontsize fontweight separator prefs} {
	lappend menuDefs(main,prefs) $menuDefs(main,prefs,$key)
    }

    set menuDefs(main,info) {    
	{command     mServer         {[mc "&Server"]}  {::WDialogs::ShowInfoServer}         {}}	
	{command     mPlugins        {[mc "Plu&gins"]} {::WDialogs::InfoOnPlugins}          {}}	
	{separator}
    }
        
    # Make platform specific things and special menus etc. Indices!!! BAD!
    if {!$prefs(haveDash)} {
	lset menuDefs(main,prefs) 7 3 disabled
    }
    if {!$haveAppleMenu} {
	lappend menuDefs(main,info) $menuDefs(main,info,aboutwhiteboard)
    }
    if {!$haveAppleMenu && ![catch {package require QuickTimeTcl 3.1}]} {
	lappend menuDefs(main,info) $menuDefs(main,info,aboutquicktimetcl)
    }
	
    # Menu definitions for a minimal setup. Used on mac only.
    set menuDefs(min,file) {
	{command   mNewWindow        {[mc "New &Window"]} {::WB::NewWhiteboard}         N}
	{command   mCloseWindow      {[mc "&Close Window"]} {::UI::CloseWindowEvent}      W}
	{separator}
	{command   mQuit             {[mc "&Quit"]} {::UserActions::DoQuit}       Q}
    }	    
    set menuDefs(min,edit) {    
	{command   mCut              {[mc "Cu&t"]} {::UI::CutEvent}            X}
	{command   mCopy             {[mc "&Copy"]} {::UI::CopyEvent}           C}
	{command   mPaste            {[mc "&Paste"]} {::UI::PasteEvent}          V}
    }
    
    # Used only on mac until the -postcommand bug fixed.
    if {[tk windowingsystem] eq "aqua"} {
	set menuDefs(main,items) [MakeItemMenuDef $this(itemPath)]
	set altItemsMenuDefs     [MakeItemMenuDef $this(altItemPath)]
	if {[llength $altItemsMenuDefs]} {
	    lappend menuDefs(main,items) {separator}
	    set menuDefs(main,items) [concat $menuDefs(main,items) $altItemsMenuDefs]
	}
    } else {
	set menuDefs(main,items) [list]
    }
    
    # When registering new menu entries they shall be added at:
    variable menuDefsInsertInd

    # Let components register their menus *after* the last separator.
    foreach name {file edit prefs items info} {
	set idx [lindex [lsearch -all $menuDefs(main,$name) separator] end]
	if {$idx < 0} {
	    set idx [llength $menuDefs(main,$name)]
	}
	set menuDefsInsertInd(main,$name) $idx
    }
}

proc ::WB::QuitAppHook {} {
    global  wDlgs
    
    ::UI::SaveWinPrefixGeom $wDlgs(wb) whiteboard
}

# WB::NewWhiteboard --
#
#       Makes a unique whiteboard.
#
# Arguments:
#       args    -file fileName
#               -state normal|disabled 
#               -title name
#               -usewingeom 0|1
#               ?-key value ...? custom arguments
#       
# Results:
#       toplevel widget path

proc ::WB::NewWhiteboard {args} { 
    global wDlgs
    variable uidmain
    
    set w [GetNewToplevelPath]
    eval {BuildWhiteboard $w} $args
    return $w
}

proc ::WB::GetNewToplevelPath {} {
    global wDlgs
    variable uidmain
    
    return $wDlgs(wb)[incr uidmain]
}

# WB::BuildWhiteboard --
#
#       Makes the main toplevel window.
#
# Arguments:
#       w           toplevel widget path
#       args        see above
#       
# Results:
#       new instance toplevel created.

proc ::WB::BuildWhiteboard {w args} {
    global  this prefs config
    
    variable gstate
    variable dims
    variable wbicons
    variable iconsInitted
    
    Debug 2 "::WB::BuildWhiteboard w=$w, args='$args'"
    
    ::Plugins::InitPrefsHook

    namespace eval ::WB::${w}:: {}
    
    upvar ::WB::${w}::wapp wapp
    upvar ::WB::${w}::state state
    upvar ::WB::${w}::opts opts
    upvar ::WB::${w}::canvasImages canvasImages
    
    eval {::hooks::run whiteboardPreBuildHook $w} $args
    
    array set opts [list -state normal -title $prefs(theAppName) -usewingeom 0]
    array set opts $args
        
    set wfmain          $w.fmain
    set wfrleft         $wfmain.frleft
    set wfrcan          $wfmain.fc
    set wcomm           $w.fcomm
    set wtbar           $w.tb
    
    # Common widget paths.
    set wapp(toplevel)  $w
    set wapp(menu)      $w.menu
    set wapp(tbar)      $w.tb
    set wapp(tool)      $wfrleft.f.tool
    set wapp(buglabel)  $wfrleft.pad.f.bug
    set wapp(frcan)     $wfrcan
    set wapp(comm)      $wcomm
    set wapp(frstat)    $wcomm.st    
    set wapp(topchilds) [list $w.menu $w.tb $w.fmain $w.fcomm]
    
    # temporary...
    set wapp(can)       $wfrcan.can
    set wapp(xsc)       $wfrcan.xsc
    set wapp(ysc)       $wfrcan.ysc
    set wapp(can,)      $wapp(can)
    
    # Having the frame with canvas + scrollbars as a sibling makes it possible
    # to pack it in a different place.
    set wapp(ccon)      $w.fmain.cc
    
    # Notebook widget path to be packed into wapp(ccon).
    set wapp(nb)        $w.fmain.nb
    
    set canvasImages [list]
    
    # Init some of the state variables.
    # Inherit from the factory + preferences state.
    array set state [array get gstate]
    
    # This is the file we either opened from or last saved.
    set state(fileName) ""
    
    # Keep track if any unsaved edits.
    set state(unsaved) 0
    
    if {$opts(-state) eq "disabled"} {
	set state(tool) "point"
    }
    set state(msg) ""
    
    ::UI::Toplevel $w -class TopWhiteboard \
      -macclass {document {toolbarButton standardDocument}} \
      -closecommand ::WB::CloseHook

    wm withdraw $w
    wm title $w $opts(-title)
    
    bind $w <<ToolbarButton>> [list ::WB::OnToolbarButton $w]

    set iconResize [::Theme::FindIcon elements/sizegrip]
    set wbicons(resizehandle) $iconResize
    if {!$iconsInitted} {
	InitIcons $w
    }
    
    # Note that the order of calls can be critical as any 'update' may trigger
    # network events to attempt drawing etc. Beware!!!
     
    # Start with menus.
    BuildMenus $w
	
    # Special for X11 menus to look ok.
    if {[tk windowingsystem] eq "x11"} {
	ttk::separator $w.stop -orient horizontal
	pack $w.stop -side top -fill x
    }

    # Shortcut buttons at top? Do we want the toolbar to be visible.
    BuildToolbar $w
    pack  $wtbar  -side top -fill x
    
    # Make the connection frame.
    ttk::frame $wcomm
    pack  $wcomm  -side bottom -fill x
    
    # Status message part.
    if {$config(wb,status-label)} {
	ttk::label $wapp(frstat) -style Small.TLabel \
	  -textvariable ::WB::${w}::state(msg) -anchor w -padding {16 2}
	pack  $wapp(frstat)  -side top -fill x

	ttk::separator $wcomm.s -orient horizontal
	pack  $wcomm.s  -side top -fill x
    }
    
    # Build the header for the actual network setup. This is where we
    # may have mode specific parts, p2p, jabber...
    ::hooks::run whiteboardBuildEntryHook $w $wcomm
    
    ttk::separator $w.tsep -orient horizontal
    pack  $w.tsep  -side top -fill x
    set wapp(tsep) $w.tsep
    
    # Make frame for toolbar + canvas.
    frame $w.fmain
    frame $w.fmain.frleft
    frame $w.fmain.frleft.f -relief raised -borderwidth 1
    ttk::frame $w.fmain.frleft.f.tool
    frame $w.fmain.frleft.pad -relief raised -borderwidth 1
    ttk::frame $w.fmain.frleft.pad.f
    frame $w.fmain.cc -bd 1 -relief raised

    pack  $w.fmain            -side bottom -fill both -expand 1
    pack  $w.fmain.frleft     -side left -fill y
    pack  $w.fmain.frleft.f   -fill both
    pack  $w.fmain.frleft.f.tool -side top
    pack  $w.fmain.frleft.pad -fill both -expand 1
    pack  $w.fmain.frleft.pad.f  -fill both -expand 1
    pack  $w.fmain.cc         -fill both -expand 1 -side right
        
    # Make the tool buttons and invoke the one from the prefs file.
    BuildAllButtons $w
    
    # ...and the drawing canvas.
    NewCanvas $wapp(frcan) -background $state(bgColCan)
    set wapp(servCan) $wapp(can)
    pack $wapp(frcan) -in $wapp(ccon) -fill both -expand true -side right
    
    # Invoke tool button.
    SetToolButton $w $state(tool)

    # Add things that are defined in the prefs file and not updated else.
    ::CanvasCmd::DoCanvasGrid $w
    
    # Create the undo/redo object.
    # @@@ This shall be per canvas in the future!
    set state(undotoken) [undo::new]

    # Set up paste menu if something on the clipboard.
    GetFocus $w $w
    bind $w  <FocusIn>  +[list [namespace current]::GetFocus $w %W]

    if {$opts(-usewingeom)} {
	::UI::SetWindowGeometry $w
    } else {
	
	# Set window position only for the first whiteboard on screen.
	# Subsequent whiteboards are placed by the window manager.
	if {[llength [GetAllWhiteboards]] == 1} {	
	    ::UI::SetWindowGeometry $w whiteboard
	}
    }
    if {$prefs(haveTkDnD)} {
	update
	InitDnD $wapp(can)
    }
    catch {wm deiconify $w}
    #raise $w     This makes the window flashing when showed (linux)
    
    # A trick to let the window manager be finished before getting the geometry.
    # An 'update idletasks' needed anyway.
    after idle ::hooks::run whiteboardSetMinsizeHook $w

    if {[info exists opts(-file)]} {
	::CanvasFile::DrawCanvasItemFromFile $w $opts(-file)
    }
    
    ::hooks::run whiteboardPostBuildHook $w
}

proc ::WB::OnToolbarButton {w} {
    upvar ::WB::${w}::wapp wapp

    if {[llength [grab current]]} { return }
    if {[winfo ismapped $wapp(tbar)]} {
	HideToolbar $w
	set show 0
    } else {
	ShowToolbar $w
	set show 1
    }
    ::hooks::run uiWhiteboardToggleToolbar $show
}

proc ::WB::HideToolbar {w} {
    upvar ::WB::${w}::wapp wapp
    
    pack forget $wapp(tbar)
    pack forget $wapp(tsep)
}

proc ::WB::ShowToolbar {w} {
    upvar ::WB::${w}::wapp wapp
    
    pack $wapp(tbar) -side top -fill x
    pack $wapp(tsep) -side top -fill x
}

# WB::NewCanvas --
# 
#       Makes canvas with scrollbars in own frame.

proc ::WB::NewCanvas {w args} {
    global  prefs
    variable dims
    
    array set argsArr {
	-background white
    }
    array set argsArr $args
    
    frame $w -class WBCanvas
    set wcan $w.can
    set wxsc $w.xsc
    set wysc $w.ysc
    
    set bg $argsArr(-background)
    
    canvas $wcan -height $dims(hCanOri) -width $dims(wCanOri)  \
      -relief raised -bd 0 -background $bg -highlightbackground $bg \
      -scrollregion [list 0 0 $prefs(canScrollWidth) $prefs(canScrollHeight)]  \
      -xscrollcommand [list $wxsc set] -yscrollcommand [list $wysc set]	
    ttk::scrollbar $wxsc -command [list $wcan xview] -orient horizontal
    ttk::scrollbar $wysc -command [list $wcan yview] -orient vertical
    
    grid  $wcan  -row 0 -column 0 -sticky news -padx 0 -pady 0
    grid  $wysc  -row 0 -column 1 -sticky ns
    grid  $wxsc  -row 1 -column 0 -sticky ew
    grid columnconfigure $w 0 -weight 1
    grid rowconfigure    $w 0 -weight 1

    ::CanvasText::Init $wcan

    return $wcan
}

# Testing Pages...

namespace eval ::WB {
    
    variable pageuid 0
}

proc ::WB::NewCanvasPage {w name} {
    upvar ::WB::${w}::wapp wapp
    upvar ::WB::${w}::state state
    variable pageuid
    
    if {[string equal [winfo class [pack slaves $wapp(ccon)]] "WBCanvas"]} {
	
	# Repack the WBCanvas in notebook page.
	MoveCanvasToPage $w $name
    } else {
	set wnb $wapp(nb)
	set wpage $wnb.p[incr pageuid]
	ttk::frame $wpage
	$wnb add $wpage -text $name

	set frcan $wpage.fc
	NewCanvas $frcan -background $state(bgColCan)
	pack $frcan -fill both -expand true -side right
	set wapp(can,$name) $frcan.can
	set wapp(page,$name) $wpage
    }
}

proc ::WB::MoveCanvasToPage {w name} {
    upvar ::WB::${w}::wapp wapp
    variable pageuid
    
    # Repack the WBCanvas in notebook page.
    pack forget $wapp(frcan)
    
    set wnb $wapp(nb)
    ttk::notebook $wnb
    pack $wnb -in $wapp(ccon) -fill both -expand 1

    #bind $wnb <<NotebookTabChanged>> \
    #  [list [namespace current]::TabChanged $w]
    #ttk::notebook::enableTraversal $wnb

    set wpage $wnb.p[incr pageuid]
    ttk::frame $wpage
    $wnb add $wpage -text $name
    
    pack $wapp(frcan) -in $wpage -fill both -expand 1
    raise $wapp(frcan)
    set wapp(can,$name) $wapp(can,)
    set wapp(page,$name) $wpage
}

proc ::WB::DeleteCanvasPage {w name} {
    upvar ::WB::${w}::wapp wapp
    
    $wapp(nb) forget $wapp(page,$name)
}

proc ::WB::TabChanged {w} {
    upvar ::WB::${w}::wapp wapp
    upvar ::WB::${w}::state state

    Debug 3 "::WB::TabChanged name=$name"
    
    set wapp(can) $wapp(can,$name)
    
    # Invoke tool button.
    SetToolButton $w $state(tool)
    ::hooks::run whiteboardSelectPage $w $name
}

proc ::WB::CloseHook {w} {
    
    if {[winfo exists $w] && [string equal [winfo class $w] "TopWhiteboard"]} {
	set wcan [GetCanvasFromWtop $w]
	::Plugins::DeregisterCanvasInstBinds $wcan
	::hooks::run whiteboardCloseHook $w
    }   
}

# WB::CloseWhiteboard --
#
#       Called when closing whiteboard window; cleanup etc.

proc ::WB::CloseWhiteboard {w} {
    
    Debug 3 "::WB::CloseWhiteboard w=$w"
    
    # Verify that window still exists.
    if {![winfo exists $w]} {
	return
    }
    upvar ::WB::${w}::wapp wapp
    
    # Reset and cancel all put/get file operations related to this window!
    # I think we let put operations go on.
    #::PutFileIface::CancelAllWtop $w
    ::GetFileIface::CancelAllWtop $w
    
    # These should be handled internally in Import ???
    ::Import::HttpResetAll $w
    ::Import::Free $w
    DestroyMain $w
}

# WB::DestroyMain --
# 
#       Destroys toplevel whiteboard. Free cleans up.

proc ::WB::DestroyMain {w} {
    global  prefs
    
    upvar ::WB::${w}::wapp wapp
    upvar ::WB::${w}::opts opts
    
    Debug 3 "::WB::DestroyMain w=$w"
        
    # Save instance specific 'state' array into generic 'state'.
    if {$opts(-usewingeom)} {
	::UI::SaveWinGeom $w
    } else {
	::UI::SaveWinGeom whiteboard $w
    }
    SaveWhiteboardState $w

    catch {destroy $w}    
    #unset opts
    #unset wapp
    
    # We could do some cleanup here.
    #GarbageImages $w
    #::CanvasUtils::ItemFree $w
    #::UI::FreeMenu $w
}

# WB::CreateImageForWtop --
# 
#       Create an image that gets garbage collected when window closed.
#       
#       name     desired image name; can be empty
#       args     -file
#                -data

proc ::WB::CreateImageForWtop {wtop name args} {
    
    upvar ::WB::${wtop}::canvasImages canvasImages
    
    array set argsArr $args
    if {[info exists argsArr(-file)]} {
	if {[string tolower [file extension $argsArr(-file)]] eq ".gif"} {
	    set photo [::Utils::CreateGif $argsArr(-file) $name]
	} else {
	    if {$name eq ""} {
		set photo [image create photo -file $argsArr(-file)]
	    } else {
		set photo [image create photo $name -file $argsArr(-file)]
	    }
	}
    } else {
	if {$name eq ""} {
	    set photo [image create photo -data $argsArr(-data)]
	} else {
	    set photo [image create photo $name -data $argsArr(-data)]
	}
    }

    lappend canvasImages $photo
    return $photo
}

proc ::WB::AddImageToGarbageCollector {w name} {
    
    upvar ::WB::${w}::canvasImages canvasImages

    lappend canvasImages $name
}

proc ::WB::GarbageImages {w} {
    
    upvar ::WB::${w}::canvasImages canvasImages
    
    foreach name $canvasImages {
	if {[::anigif::isanigif $name]} {
	    ::anigif::delete $name
	} else {
	    if {![catch {image inuse $name}]} {
		catch {image delete $name}
	    }
	}
    }
}

# WB::SaveWhiteboardState
# 
# 

proc ::WB::SaveWhiteboardState {w} {
    upvar ::WB::${w}::wapp wapp
    variable gstate
    
    # Read back instance specific 'state' into generic 'state'.
    array set gstate [array get ::WB::${w}::state]
}

proc ::WB::SaveAnyState {} {
    
    set win ""
    set wbs [GetAllWhiteboards]
    if {[llength $wbs]} {
	set wfocus [focus]
	if {$wfocus ne ""} {
	    set win [winfo toplevel $wfocus]
	}
	set win [lsearch -inline $wbs $wfocus]
	if {$win eq ""} {
	    set win [lindex $wbs 0]
	}
	if {$win ne ""} {
	    ::WB::SaveWhiteboardState $win
	}	
    }
}

proc ::WB::GetStateArray {w} {
    upvar ::WB::${w}::state state

    return [array get state]
}

# WB::SaveWhiteboardDims --
# 
#       Stores the present whiteboard widget geom state in 'dims' array.

proc ::WB::SaveWhiteboardDims {w} {
    global  this

    upvar ::WB::dims dims
    upvar ::WB::${w}::wapp wapp
    
    set wcan $wapp(can)
        	    
    # Update actual size values. 'Root' no menu, 'Tot' with menu.
    #set dims(wStatMess) [winfo width $wapp(statmess)]
    if {[winfo exists $wapp(frstat)]} {
	set dims(wStatMess) [winfo width $wapp(frstat)]
    } else {
	set dims(wStatMess) 0
    }
    set dims(wRoot) [winfo width $w]
    set dims(hRoot) [winfo height $w]
    set dims(x) [winfo x $w]
    set dims(y) [winfo y $w]
    set dims(wTot) $dims(wRoot)
    
    # hMenu seems unreliable!!!
    if {![string match "mac*" $this(platform)]} {
	# MATS: seems to always give 1 Linux not...
	### EAS BEGIN
	set dims(hMenu) 1
	if {[winfo exists $w.#menu]} {
	    set dims(hMenu) [winfo height $w.#menu]
	}
	### EAS END
    } else {
	set dims(hMenu) 0
    }
    set dims(hTot) [expr $dims(hRoot) + $dims(hMenu)]
    set dims(wCanvas) [winfo width $wcan]
    set dims(hCanvas) [winfo height $wcan]

    Debug 3 "::WB::SaveWhiteboardDims dims(hRoot)=$dims(hRoot)"
}

# BADDDDDDDD!!!!!!!!!!!!!!!!!!!!!!!!!!!
#
# WB::SaveCleanWhiteboardDims --
# 
#       We want to save wRoot and hRoot as they would be without any connections 
#       in the communication frame. Non jabber only. Only needed when quitting
#       to get the correct dims when set from preferences when launched again.

proc ::WB::SaveCleanWhiteboardDims {w} {
    global prefs

    upvar ::WB::dims dims
    upvar ::WB::${w}::wapp wapp

    if {$w ne "."} {
	return
    }
    foreach {dims(wRoot) hRoot dims(x) dims(y)} [::UI::ParseWMGeometry [wm geometry .]] break
    set dims(hRoot) [expr $dims(hCanvas) + $dims(hStatus) +  \
      $dims(hCommClean) + $dims(hTop) + $dims(hFakeMenu)]
    incr dims(hRoot) [expr [winfo height $wapp(xsc)] + 4]
}

# WB::ConfigureMain --
#
#       Configure the options 'opts' state of a whiteboard.
#       Returns 'opts' if no arguments.

proc ::WB::ConfigureMain {w args} {
    
    upvar ::WB::${w}::wapp wapp
    upvar ::WB::${w}::opts opts
    
    if {[llength $args] == 0} {
	return [array get opts]
    } else {

	foreach {name value} $args {
	    
	    switch -- $name {
		-title {
		    wm title $w $value    
		}
		-state {
		    set wmenu $wapp(menu)
		    MenubarSetState $wmenu $value
		    if {[string equal $value "normal"]} {

		    } else {
			DisableShortcutButtonPad $w
		    }
		}
	    }
	}
    }
    eval {::hooks::run whiteboardConfigureHook $w} $args
}

proc ::WB::SetButtonTrayDefs {buttonDefs} {
    variable btShortDefs
    
    set btShortDefs $buttonDefs
}

proc ::WB::SetMenuDefs {key menuDef} {
    variable menuDefs
    
    set menuDefs(main,$key) $menuDef
}

proc ::WB::GetMenuDefs {key} {
    variable menuDefs
    
    return $menuDefs(main,$key)
}

proc ::WB::LoginHook {} {
    
    foreach w [GetAllWhiteboards] {

	# Make menus consistent.
	::hooks::run whiteboardFixMenusWhenHook $w "connect"
    }
}

proc ::WB::LogoutHook {} {
    
    # Multiinstance whiteboard UI stuff.
    foreach w [GetAllWhiteboards] {

	# If no more connections left, make menus consistent.
	::hooks::run whiteboardFixMenusWhenHook $w "disconnect"
    }   
}

# WB::SetStatusMessage --

proc ::WB::SetStatusMessage {w msg} {
    
    # Make it failsafe.
    if {![winfo exists $w]} {
	return
    }
    upvar ::WB::${w}::wapp wapp
    upvar ::WB::${w}::state state

    set state(msg) $msg
    #$wapp(statmess) itemconfigure stattxt -text $msg
}

proc ::WB::GetServerCanvasFromWtop {w} {    
    upvar ::WB::${w}::wapp wapp
    
    return $wapp(servCan)
}

proc ::WB::GetCanvasFromWtop {w} {    
    upvar ::WB::${w}::wapp wapp
    
    return $wapp(can)
}

# WB::GetButtonState --
#
#       This is a utility function mainly for plugins to get the tool buttons 
#       state.

proc ::WB::GetButtonState {w} {
    upvar ::WB::${w}::state state

    return $state(tool)
}

# This shall be per canvas in the future!
proc ::WB::GetUndoToken {wcan} { 
    set w [winfo toplevel $wcan]
    upvar ::WB::${w}::state state
    
    return $state(undotoken)
}

proc ::WB::GetButtonTray {w} {
    upvar ::WB::${w}::wapp wapp

    return $wapp(tbar)
}

proc ::WB::GetMenu {w} {

    return [::UI::GetMenuFromWindow $w]
}

# WB::GetAllWhiteboards --
# 
#       Return all whiteboard's toplevel widget paths as a list. 

proc ::WB::GetAllWhiteboards {} {    
    global  wDlgs

    return [lsort -dictionary \
      [lsearch -all -inline -glob [winfo children .] $wDlgs(wb)*]]
}

# WB::ToolCmd --
# 
#       Command for radiobutton tools.

proc ::WB::ToolCmd {w} {
    upvar ::WB::${w}::state state
        
    set state(toolPrev)  $state(toolCache)
    set state(toolCache) $state(tool)

    SetToolButton $w $state(tool)
}

# WB::SetToolButton --
#
#       Uhhh...  When a tool button is clicked.
#       
# Arguments:
#       w           toplevel widget path
#       btName 
#       
# Results:
#       tool buttons created and mapped

proc ::WB::SetToolButton {w btName} {
    global  prefs wapp this
    
    upvar ::WB::${w}::wapp wapp
    upvar ::WB::${w}::state state
    upvar ::WB::${w}::opts opts

    Debug 3 "SetToolButton:: w=$w, btName=$btName"
    
    set wcan $wapp(can)
    
    # Deselect text items.
    if {$btName ne "text"} {
	$wcan select clear
    }
    if {$btName eq "del" || $btName eq "text"} {
	::CanvasCmd::DeselectAll $wcan
    }
    
    # Cancel any outstanding polygon drawings.
    ::CanvasDraw::FinalizePoly $wcan -10 -10
    
    $wcan config -cursor {}
    
    RemoveAllBindings $wcan
    SetBindtags $wcan $btName 
    SetItemBinds $wcan $btName 
    SetFrameItemBinds $wcan $btName
    SetToolUI $wcan $btName
    
    # Should this be tool specific?
    SetKeyboardBinds $wcan $btName

    # This is a hook for plugins to register their own bindings.
    # Calls any registered bindings for the plugin, and deregisters old ones.
    ::Plugins::SetCanvasBinds $wcan $state(toolPrev) $btName
}

# WB::SetBindtags --
# 
#       Bindings directly to the canvas widget are dealt with using bindtags.
#
#       The bindtags used:
#         Whiteboard
#         WhiteboardNonText
#         WhiteboardPoint
#         WhiteboardMove
#         WhiteboardLine
#         WhiteboardArrow
#         WhiteboardRect
#         WhiteboardOval
#         WhiteboardText
#         WhiteboardDel
#         WhiteboardPen
#         WhiteboardBrush
#         WhiteboardPaint
#         WhiteboardPoly
#         WhiteboardArc
#         WhiteboardRot
#         
#       Be sure to NEVER use any of these as -class or any other bindtags!
#       
# Arguments:
#       wcan        canvas widget
#       btName      tool button name
#       
# Results:
#       none

proc ::WB::SetBindtags {wcan btName} {
    
    set w [winfo toplevel $wcan]
    
    variable BtName

    switch -- $btName {
	point - move - line - arrow - rect - oval -
	del - pen - brush - paint - poly - arc - rot {
	    
	    # For all nontext items we have generically named bindtags.
	    set tag Whiteboard[string totitle $btName]
	    bindtags $wcan [list $wcan $tag WhiteboardNonText Whiteboard $w all]
	}
	text {
	    bindtags $wcan  \
	      [list $wcan WhiteboardText Whiteboard $w all]
	}
    }
}

# WB::SetKeyboardBinds --
# 
#       Sets edit menu key binds.

proc ::WB::SetKeyboardBinds {wcan btName} {
    global  this
    
    set mod $this(modkey)
        
    # Generic nontext binds.
    # 
    # @@@ Could perhaps made to bind to 'Whiteboard'.
    if {$btName ne "text"} {
	bind $wcan <BackSpace> [list ::CanvasDraw::DeleteSelected $wcan]
	bind $wcan <Delete>    [list ::CanvasDraw::DeleteSelected $wcan]
	bind $wcan <Control-d> [list ::CanvasDraw::DeleteSelected $wcan]
    }
}

# WB::SetItemBinds --
#
#       Mainly sets all button specific item binds.
#       
# Arguments:
#       wcan        canvas widget
#       btName      tool button name
#       
# Results:
#       none

proc ::WB::SetItemBinds {wcan btName} {
    global  this

    set w [winfo toplevel $wcan]

    # These ones are needed to cancel selection since we compete
    # with Button-1 binding to canvas.
    switch -- $this(platform) {
	macosx {
	    $wcan bind std <Control-ButtonRelease-1> {
		::CanvasDraw::CancelBox %W
		::CanvasDraw::CancelPoly %W
	    }
	    $wcan bind std <Control-B1-Motion> {
		::CanvasDraw::CancelBox %W
		::CanvasDraw::CancelPoly %W
	    }
	}
    }

    # Typical B3 bindings independent of tool selected.
    $wcan bind std&&!locked <<ButtonPopup>> {
	::CanvasUtils::DoItemPopup %W %X %Y 
    }
    $wcan bind std&&locked <<ButtonPopup>> {
	::CanvasUtils::DoLockedPopup %W %X %Y 
    }

    switch -- $btName {
	point {
	    $wcan bind std <Double-Button-1>  \
	      [list ::ItemInspector::ItemInspector $wcan current]

	    switch -- $this(platform) {
		macosx {
		    $wcan bind std&&!locked <Button-1> {
			::CanvasUtils::StartTimerToPopupEx %W %X %Y \
			  ::CanvasUtils::DoItemPopup
		    }
		    $wcan bind std&&locked <Button-1> {
			::CanvasUtils::StartTimerToPopupEx %W %X %Y \
			  ::CanvasUtils::DoLockedPopup
		    }
		    $wcan bind std <ButtonRelease-1> {
			::CanvasUtils::StopTimerToPopupEx
		    }
		}
	    }
	}
	move {
	    
	    # Bindings for moving items; movies need special class.
	    # The frame with the movie gets the mouse events, not the canvas.
	    # Binds directly to canvas widget since we want to move selected 
	    # items as well.
	    # With shift constrained move.

	    $wcan bind std&&!locked <Button-1> {
		::CanvasDraw::InitMoveCurrent %W [%W canvasx %x] [%W canvasy %y]
	    }
	    $wcan bind std&&!locked <B1-Motion> {
		::CanvasDraw::DragMoveCurrent %W [%W canvasx %x] [%W canvasy %y]
	    }
	    $wcan bind std&&!locked <ButtonRelease-1> {
		::CanvasDraw::FinalMoveCurrent %W [%W canvasx %x] [%W canvasy %y]
	    }
	    $wcan bind std&&!locked <Shift-B1-Motion> {
		::CanvasDraw::DragMoveCurrent %W [%W canvasx %x] [%W canvasy %y] shift
	    }
	    
	    $wcan bind tbbox&&(oval||rectangle) <Button-1> {
		::CanvasDraw::InitMoveRectPoint %W [%W canvasx %x] [%W canvasy %y]
	    }
	    $wcan bind tbbox&&(oval||rectangle) <B1-Motion> {
		::CanvasDraw::DragMoveRectPoint %W [%W canvasx %x] [%W canvasy %y]
	    }
	    $wcan bind tbbox&&(oval||rectangle) <ButtonRelease-1> {
		::CanvasDraw::FinalMoveRectPoint %W [%W canvasx %x] [%W canvasy %y]
	    }
	    $wcan bind tbbox&&(oval||rectangle) <Shift-B1-Motion> {
		::CanvasDraw::DragMoveRectPoint %W [%W canvasx %x] [%W canvasy %y] shift
	    }
	    
	    $wcan bind tbbox&&(line||polygon) <Button-1> {
		::CanvasDraw::InitMovePolyLinePoint %W [%W canvasx %x] [%W canvasy %y]
	    }
	    $wcan bind tbbox&&(line||polygon) <B1-Motion> {
		::CanvasDraw::DragMovePolyLinePoint %W [%W canvasx %x] [%W canvasy %y]
	    }
	    $wcan bind tbbox&&(line||polygon) <ButtonRelease-1> {
		::CanvasDraw::FinalMovePolyLinePoint %W [%W canvasx %x] [%W canvasy %y]
	    }
	    $wcan bind tbbox&&(line||polygon) <Shift-B1-Motion> {
		::CanvasDraw::DragMovePolyLinePoint %W [%W canvasx %x] [%W canvasy %y] shift
	    }
	    
	    $wcan bind tbbox&&arc <Button-1> {
		::CanvasDraw::InitMoveArcPoint %W [%W canvasx %x] [%W canvasy %y]
	    }
	    $wcan bind tbbox&&arc <B1-Motion> {
		::CanvasDraw::DragMoveArcPoint %W [%W canvasx %x] [%W canvasy %y]
	    }
	    $wcan bind tbbox&&arc <ButtonRelease-1> {
		::CanvasDraw::FinalMoveArcPoint %W [%W canvasx %x] [%W canvasy %y]
	    }
	    $wcan bind tbbox&&arc <Shift-B1-Motion> {
		::CanvasDraw::DragMoveArcPoint %W [%W canvasx %x] [%W canvasy %y] shift
	    }
	}
	text {
	    ::CanvasText::EditBind $wcan
	}
	del {
	    $wcan bind std&&!locked <Button-1> {
		::CanvasDraw::DeleteCurrent %W
	    }
	}
    }
}

proc ::WB::SetToolUI {wcan btName} {
    global  this

    variable BtName

    set w [winfo toplevel $wcan]
    SetStatusMessage $w [dict get $BtName $btName]

    switch -- $btName {
	point {
	    switch -- $this(platform) {
		macosx {
		    SetStatusMessage $w [mc "Point tool, click to mark, double click to inspect, press to popup"]
		}
		default {
		    SetStatusMessage $w [mc "Point tool, click to mark, double click to inspect, right click to popup"]		      
		}
	    }
	}
	move {
	    $wcan config -cursor fleur
	}
	text {
	    $wcan config -cursor xterm
	}
	pen {
	    $wcan config -cursor pencil
	}
	rot {
	    $wcan config -cursor exchange
	}
    }
}

# WB::SetFrameItemBinds --
#
#       Binding to canvas windows (QTFrame) must be made specifically for each
#       whiteboard instance.
#       Needed in two situations:
#       1) Clicking tool button
#       2) When whiteboard gets focus
#       
# Arguments:
#       wcan        canvas widget
#       btName      tool button name
#       
# Results:
#       none

proc ::WB::SetFrameItemBinds {wcan btName} {
    global  this

    set w [winfo toplevel $wcan]

    bind QTFrame <Button-1> {}
    bind QTFrame <B1-Motion> {}
    bind QTFrame <ButtonRelease-1> {}
    bind QTFrame <Shift-B1-Motion> {}
    bind SnackFrame <Button-1> {}
    bind SnackFrame <B1-Motion> {}
    bind SnackFrame <ButtonRelease-1> {}
    bind SnackFrame <Shift-B1-Motion> {}

    bind QTFrame <<ButtonPopup>> {
	::CanvasUtils::DoQuickTimePopup %W %X %Y 
    }
    bind SnackFrame <<ButtonPopup>> {
	::CanvasUtils::DoWindowPopup %W %X %Y 
    }
    
    switch -- $btName {
	point {

	    switch -- $this(platform) {
		macintosh - macosx {
		    bind QTFrame <Button-1> {
			::CanvasUtils::StartTimerToPopupEx %W %X %Y \
			  ::CanvasUtils::DoQuickTimePopup
		    }
		    bind QTFrame <ButtonRelease-1> {
			::CanvasUtils::StopTimerToPopupEx
		    }
		    bind SnackFrame <Button-1> {
			::CanvasUtils::StartTimerToWindowPopup %W %X %Y 
		    }
		    bind SnackFrame <ButtonRelease-1> {
			::CanvasUtils::StopTimerToWindowPopup
		    }
		}
	    }
	}
	move {
	    
	    # Need to substitute $wcan.
	    bind QTFrame <Button-1>  \
	      [subst {::CanvasDraw::InitMoveFrame $wcan %W %x %y}]
	    bind QTFrame <B1-Motion>  \
	      [subst {::CanvasDraw::DoMoveFrame $wcan %W %x %y}]
	    bind QTFrame <ButtonRelease-1>  \
	      [subst {::CanvasDraw::FinMoveFrame $wcan %W %x %y}]
	    bind QTFrame <Shift-B1-Motion>  \
	      [subst {::CanvasDraw::FinMoveFrame $wcan %W %x %y}]
	    
	    bind SnackFrame <Button-1>  \
	      [subst {::CanvasDraw::InitMoveFrame $wcan %W %x %y}]
	    bind SnackFrame <B1-Motion>  \
	      [subst {::CanvasDraw::DoMoveFrame $wcan %W %x %y}]
	    bind SnackFrame <ButtonRelease-1>  \
	      [subst {::CanvasDraw::FinMoveFrame $wcan %W %x %y}]
	    bind SnackFrame <Shift-B1-Motion>  \
	      [subst {::CanvasDraw::FinMoveFrame $wcan %W %x %y}]
	}
	del {
	    bind QTFrame <Button-1>  \
	      [subst {::CanvasDraw::DeleteFrame $wcan %W %x %y}]
	    bind SnackFrame <Button-1>  \
	      [subst {::CanvasDraw::DeleteFrame $wcan %W %x %y}]
	}
    }
}

# WB::RemoveAllBindings --
#
#       Clears all application defined bindings in the canvas.
#       
# Arguments:
#       wcan   the canvas widget.
#       
# Results:
#       none

proc ::WB::RemoveAllBindings {wcan} {
    
    Debug 3 "::WB::RemoveAllBindings wcan=$wcan"
    
    # List all tags that we may bind to.
    foreach btag {
	all  std  std&&locked  std&&!locked  
	text  tbbox&&arc  tbbox&&(oval||rectangle)
    } {
	foreach seq [$wcan bind $btag] {
	    $wcan bind $btag $seq {}
	}
    }
    
    # Seems necessary for the arc item... More?
    bind $wcan <Shift-B1-Motion> {}
	    
    # Remove any text insertion...
    $wcan focus {}
}

# RegisterCanvasClassBinds, RegisterCanvasInstBinds --
# 
#       Wrapper for plugins custom canvas bindings.
#       *Class* binds to all whiteboards, 
#       *Inst* binds only to the specified instance (w).

proc ::WB::RegisterCanvasClassBinds {name canvasBindList} {
    
    # Register the actual bindings.
    ::Plugins::RegisterCanvasClassBinds $name $canvasBindList
    
    # Must set the bindings for each instance.
    foreach w [::WB::GetAllWhiteboards] {
	upvar ::WB::${w}::state state
	upvar ::WB::${w}::wapp wapp
	
	::Plugins::SetCanvasBinds $wapp(can) $state(toolPrev) $state(tool)
    }
}

proc ::WB::RegisterCanvasInstBinds {wcan name canvasBindList} {

    set w [winfo toplevel $wcan]
    upvar ::WB::${w}::state state

    # Register the actual bindings.
    ::Plugins::RegisterCanvasInstBinds $wcan $name $canvasBindList
    
    # Must set the bindings for this instance.
    ::Plugins::SetCanvasBinds $wcan $state(toolPrev) $state(tool)
}

# WB::HaveCanvasFocus, ... --
#
#       These are functions used for menu and keyboard whiteboard commands.
#       Commands that need an explicit selection requires canvas focus but
#       other commands operate on the frontmost canvas.

proc ::WB::HaveCanvasFocus {} {
    if {[winfo exists [focus]]} {
	if {[winfo class [winfo parent [focus]]] eq "WBCanvas"} {
	    return 1
	}
    }
    return 0
}

proc ::WB::GetFrontmostCanvas {} {
    if {[winfo exists [focus]]} {
	return [GetCanvasFromWtop [winfo toplevel [focus]]]
    }
}

proc ::WB::HaveSelection {wcan} {
    return [expr {[llength [$wcan find withtag selected]] == 0 ? 0 : 1}]
}

proc ::WB::StateNormal {wcan} {
    set w [winfo toplevel $wcan]
    upvar ::WB::${w}::opts opts
    return [expr {($opts(-state) eq "normal") ? 1 : 0}]
}

# Menu events ------------------------------------------------------------------

# File menu.

proc ::WB::OnMenuImport {} {
    if {[llength [grab current]]} { return }
    OnImport [GetFrontmostCanvas]
}

proc ::WB::OnMenuOpenURL {} {
    if {[llength [grab current]]} { return }
    OnOpenURL [GetFrontmostCanvas]
}

proc ::WB::OnMenuOpenCanvas {} {
    if {[llength [grab current]]} { return }
    OnOpenCanvas [GetFrontmostCanvas]
}

proc ::WB::OnMenuSaveCanvas {} {
    if {[llength [grab current]]} { return }
    OnSaveCanvas [GetFrontmostCanvas]
}

proc ::WB::OnMenuSaveAs {} {
    if {[llength [grab current]]} { return }
    OnSaveAs [GetFrontmostCanvas]
}

proc ::WB::OnMenuSaveAsItem {} {
    if {[llength [grab current]]} { return }
    OnSaveAsItem [GetFrontmostCanvas]
}

proc ::WB::OnMenuPageSetup {} {
    if {[llength [grab current]]} { return }
    OnPageSetup [GetFrontmostCanvas]
}

proc ::WB::OnMenuPrintCanvas {} {
    if {[llength [grab current]]} { return }
    OnPrintCanvas [GetFrontmostCanvas]
}

# Edit menu.

proc ::WB::OnMenuUndo {} {
    if {[llength [grab current]]} { return }
    OnUndo [GetFrontmostCanvas]
}

proc ::WB::OnMenuRedo {} {
    if {[llength [grab current]]} { return }
    OnRedo [GetFrontmostCanvas]
}

proc ::WB::OnMenuAll {} {
    if {[llength [grab current]]} { return }
    OnAll [GetFrontmostCanvas]
}

proc ::WB::OnMenuEraseAll {} {
    if {[llength [grab current]]} { return }
    OnEraseAll [GetFrontmostCanvas]
}

proc ::WB::OnMenuRaise {} {
    if {[llength [grab current]]} { return }
    if {[HaveCanvasFocus]} {
	OnRaise [focus]
    }
}

proc ::WB::OnMenuLower {} {
    if {[llength [grab current]]} { return }
    if {[HaveCanvasFocus]} {
	OnLower [focus]
    }
}

proc ::WB::OnMenuLarger {} {
    if {[llength [grab current]]} { return }
    if {[HaveCanvasFocus]} {
	OnLarger [focus]
    }
}

proc ::WB::OnMenuSmaller {} {
    if {[llength [grab current]]} { return }
    if {[HaveCanvasFocus]} {
	OnSmaller [focus]
    }
}

proc ::WB::OnMenuItemInspector {} {
    if {[llength [grab current]]} { return }
    if {[HaveCanvasFocus]} {
	OnItemInspector [focus]
    }
}

proc ::WB::OnMenuFlipHorizontal {} {
    if {[llength [grab current]]} { return }
    if {[HaveCanvasFocus]} {
	OnFlipHorizontal [focus]
    }
}

proc ::WB::OnMenuFlipVertical {} {
    if {[llength [grab current]]} { return }
    if {[HaveCanvasFocus]} {
	OnFlipVertical [focus]
    }
}

proc ::WB::OnMenuImageLarger {} {
    if {[llength [grab current]]} { return }
    if {[HaveCanvasFocus]} {
	OnImageLarger [focus]
    }
}

proc ::WB::OnMenuImageSmaller {} {
    if {[llength [grab current]]} { return }
    if {[HaveCanvasFocus]} {
	OnImageSmaller [focus]
    }
}

# Keyboard events --------------------------------------------------------------

# File events.

proc ::WB::OnImport {wcan} {
    if {[StateNormal $wcan]} {
	::Import::ImportImageOrMovieDlg $wcan
    }
}

proc ::WB::OnOpenURL {wcan} {
    if {[StateNormal $wcan] && [::Plugins::HavePackage QuickTimeTcl]} {
	::Multicast::OpenMulticast $wcan
    }
}

proc ::WB::OnOpenCanvas {wcan} {
    if {[StateNormal $wcan]} {
	::CanvasFile::OpenCanvasFileDlg $wcan
    }
}

proc ::WB::OnSaveCanvas {wcan} {
    ::CanvasFile::Save $wcan
}

proc ::WB::OnSaveAs {wcan} {
    ::CanvasFile::SaveAsDlg $wcan
}

proc ::WB::OnSaveAsItem {wcan} {
    if {[StateNormal $wcan]} {
	::CanvasFile::DoSaveAsItem $wcan
    }
}

proc ::WB::OnPageSetup {wcan} {
    ::UserActions::PageSetup [winfo toplevel $wcan]
}

proc ::WB::OnPrintCanvas {wcan} {
    ::UserActions::DoPrintCanvas $wcan
}

# Edit events.

proc ::WB::OnUndo {wcan} {
    if {[StateNormal $wcan] && [undo::canundo [GetUndoToken $wcan]]} {
	::CanvasCmd::Undo $wcan
    }
}

proc ::WB::OnRedo {wcan} {
    if {[StateNormal $wcan] && [undo::canredo [GetUndoToken $wcan]]} {
	::CanvasCmd::Redo $wcan
    }
}

proc ::WB::OnAll {wcan} {
    ::CanvasCmd::SelectAll $wcan
}

proc ::WB::OnEraseAll {wcan} {
    if {[StateNormal $wcan]} {
	::CanvasCmd::DoEraseAll $wcan
    }
}

proc ::WB::OnLower {wcan} {
    if {[HaveSelection $wcan] && [StateNormal $wcan]} {
	::CanvasCmd::RaiseOrLowerItems $wcan lower
    }
}

proc ::WB::OnRaise {wcan} {
    if {[HaveSelection $wcan] && [StateNormal $wcan]} {
	::CanvasCmd::RaiseOrLowerItems $wcan raise
    }
}

proc ::WB::OnLarger {wcan} {
    global  prefs
    if {[HaveSelection $wcan] && [StateNormal $wcan]} {
	::CanvasCmd::ResizeItem $wcan $prefs(scaleFactor)
    }    
}

proc ::WB::OnSmaller {wcan} {
    global  prefs
    if {[HaveSelection $wcan] && [StateNormal $wcan]} {
	::CanvasCmd::ResizeItem $wcan $prefs(invScaleFac)
    }    
}

proc ::WB::OnItemInspector {wcan} {
    if {[HaveSelection $wcan] && [StateNormal $wcan]} {
	::ItemInspector::ItemInspector $wcan selected
    }
}

proc ::WB::OnFlipHorizontal {wcan} {
    if {[HaveSelection $wcan] && [StateNormal $wcan]} {
	::CanvasCmd::FlipItem $wcan horizontal
    }
}

proc ::WB::OnFlipVertical {wcan} {
    if {[HaveSelection $wcan] && [StateNormal $wcan]} {
	::CanvasCmd::FlipItem $wcan vertical
    }
}

proc ::WB::OnImageLarger {wcan} {
    if {[HaveSelection $wcan] && [StateNormal $wcan]} {
	::Import::ResizeImage $wcan 2 sel auto
    }
}

proc ::WB::OnImageSmaller {wcan} {
    if {[HaveSelection $wcan] && [StateNormal $wcan]} {
	::Import::ResizeImage $wcan -2 sel auto
    }
}

proc ::WB::OnKeyAnyArrow {wcan detail} {
    if {[HaveSelection $wcan] && [StateNormal $wcan]} {
	::CanvasCmd::MoveSelected $wcan $detail
    }
}

# WB::BuildMenus --
#
#       Makes all menus for a toplevel window.
#
# Arguments:
#       w           toplevel widget path
#       
# Results:
#       menu created

proc ::WB::BuildMenus {w} {
    global  this wDlgs prefs dashFull2Short
    
    variable menuDefs
    variable menuBarDef
    upvar ::WB::${w}::wapp wapp
    upvar ::WB::${w}::state state
    upvar ::WB::${w}::opts opts
    
    ::Debug 2 "::WB::BuildMenus"
	
    set wcan   $wapp(can)
    set wmenu  $wapp(menu)
    
    if {$prefs(haveMenus)} {
	menu $wmenu -tearoff 0
    } else {
	frame $wmenu -bd 1 -relief raised
    }
    if {[tk windowingsystem] eq "aqua" && $prefs(haveMenus)} {
	set haveAppleMenu 1
    } else {
	set haveAppleMenu 0
    }
    if {$haveAppleMenu} {
	::UI::BuildAppleMenu $w $wmenu.apple $opts(-state)
    }
    foreach {name mLabel} $menuBarDef {
	BuildMenu $w $wmenu $name
    }    
    if {[tk windowingsystem] ne "aqua"} {
	$wmenu.items configure \
	  -postcommand [list ::WB::BuildItemsMenu $w $wmenu.items]
    }

    # Plugin menus if any.
    BuildRegisteredMenus $w $wmenu

    # The edit menu binds directly to canvas.
    ::UI::SetMenuAcceleratorBinds $w $wmenu.file
    ::UI::SetMenuAcceleratorBinds $w $wmenu.prefs
    ::UI::SetMenuAcceleratorBinds $w $wmenu.info

    # Handle '-state disabled' option. Keep Edit/Copy.
    if {$opts(-state) eq "disabled"} {
	MenubarSetState $wmenu disabled
    }
    
    # Use a function for this to dynamically build this menu if needed.
    BuildFontMenu $w $prefs(canvasFonts)    

    $wmenu.file configure -postcommand  \
      [list ::WB::FilePostCommand $w $wmenu.file]
    $wmenu.edit configure -postcommand  \
      [list ::WB::EditPostCommand $w $wmenu.edit]
    $wmenu.prefs configure -postcommand  \
      [list ::WB::PrefsPostCommand $w $wmenu.prefs]

    # End menus; place the menubar.
    if {$prefs(haveMenus)} {
	$w configure -menu $wmenu
    } else {
	pack $wmenu -side top -fill x
    }
}

proc ::WB::BuildMenu {w wmenu name} {
    variable menuDefs
    variable menuBarDef
    variable extraMenuDefs
    variable menuDefsInsertInd

    set lname [dict create]
    dict set lname file    [mc "&File"]
    dict set lname prefs   [mc "&Preferences"]
    dict set lname info    [mc "&Info"]
    dict set lname edit    [mc "&Edit"]
    dict set lname items   [mc "&Library"]
    set str [dict get $lname $name]

    array set mLabel $menuBarDef
    array set locname $menuBarDef
    set menuMerged $menuDefs(main,$name)
    if {[info exists extraMenuDefs(main,$name)]} {
	set menuMerged [eval {
	    linsert $menuMerged $menuDefsInsertInd(main,$name)
	} $extraMenuDefs(main,$name)]
    }
    ::UI::NewMenu $w $wmenu.$name  $mLabel($name)  $str  $menuMerged
}

# WB::RegisterNewMenu --
# 
#       Registers a new whiteboard menu.
#       
# Arguments:
#       mtail       widget tail name
#       name        menu label
#       menuSpec    {type name cmd accelerator opts} {{...} {...} ...}
#       
# Results:
#       menu entries added when whiteboard built.

proc ::WB::RegisterNewMenu {mtail name menuSpec} {    
    variable menuSpecPublic 
	
    # Make a new menu
    if {[lsearch $menuSpecPublic(wpaths) $mtail] < 0} {
	lappend menuSpecPublic(wpaths) $mtail
    }
    set menuSpecPublic($mtail,name) $name
    set menuSpecPublic($mtail,specs) [list $menuSpec]
}

proc ::WB::BuildRegisteredMenus {w wmenu} {
    variable menuSpecPublic
        
    foreach mtail $menuSpecPublic(wpaths) {
	set name  $menuSpecPublic($mtail,name)
	set specs $menuSpecPublic($mtail,specs)
	::UI::NewMenu $w $wmenu.$mtail $name $name $specs
    }
}

# WB::RegisterMenuEntry --
# 
#       Lets plugins/components register their own menu entry.

proc ::WB::RegisterMenuEntry {name menuSpec} {
    
    # Keeps track of all registered menu entries.
    variable extraMenuDefs
    
    # Add these entries in a section above the bottom section.
    # Add separator to section component entries.
    
    if {![info exists extraMenuDefs(main,$name)]} {

	# Add separator if this is the first addon entry.
	set extraMenuDefs(main,$name) {separator}
    }
    lappend extraMenuDefs(main,$name) $menuSpec
}

# WB::MenubarSetState --
#
#       Handle '-state disabled' option. Sets in a readonly state.

proc ::WB::MenubarSetState {wmenu mbstate} {
    variable menuSpecPublic
    
    $wmenu entryconfigure [mc "&Preferences"] -state $mbstate
    $wmenu entryconfigure [mc "&Library"] -state $mbstate
    $wmenu entryconfigure [mc "&Info"] -state $mbstate
	
    # Handle all 'plugins'.
    foreach wpath $menuSpecPublic(wpaths) {
	set name $menuSpecPublic($wpath,name)
	$wmenu entryconfigure $name -state $mbstate
    }
}

namespace eval ::WB:: {
    variable extButtonDefs {}
}

# WB::BuildToolbar --
#
#       Build the actual shortcut button pad.

proc ::WB::BuildToolbar {w} {
    global  wDlgs
    variable btShortDefs
    variable extButtonDefs
    upvar ::WB::${w}::wapp wapp
    upvar ::WB::${w}::opts opts
    
    set wcan   $wapp(can)
    set wtbar  $wapp(tbar)

    ::ttoolbar::ttoolbar $wtbar

    # We need to substitute $wcan, $w etc specific for this wb instance.
    foreach {name cmd} $btShortDefs {
	set icon    [::Theme::Find32Icon $w ${name}Image]
	set iconDis [::Theme::Find32Icon $w ${name}DisImage]
	set cmd [subst -nocommands -nobackslashes $cmd]
	set txt [string totitle $name]
	$wtbar newbutton $name -text [mc $txt] \
	  -image $icon -disabledimage $iconDis -command $cmd
    }
    
    # Extra buttons from components if any.
    foreach btdef $extButtonDefs {
	foreach {name icon iconDis cmd} $btdef {
	    set cmd [subst -nocommands -nobackslashes $cmd]
	    set txt [string totitle $name]
	    $wtbar newbutton $name -text [mc $txt] \
	      -image $icon -disabledimage $iconDis -command $cmd
	}
    }

    # Anything special here.
    ::hooks::run whiteboardBuildButtonTrayHook $wtbar

    if {$opts(-state) eq "disabled"} {
	DisableShortcutButtonPad $w
    }
}

proc ::WB::RegisterShortcutButtons {btdefs} {
    variable extButtonDefs

    # Be sure to not have duplicates. Keep order!
    set names {}
    foreach spec $extButtonDefs {
	set name [lindex $spec 0]
	lappend names $name
	set tmpArr($name) $spec
    }
    foreach spec $btdefs {
	set name [lindex $spec 0]
	if {![info exists tmpArr($name)]} {
	    lappend names $name
	    set tmpArr($name) $spec
	}
    }
    set tmpDefs {}
    foreach name $names {
	lappend tmpDefs $tmpArr($name)
    }
    set extButtonDefs $tmpDefs
}

proc ::WB::DeregisterShortcutButton {name} {
    variable extButtonDefs

    set ind 0
    foreach btdef $extButtonDefs {
	if {[string equal [lindex $btdef 0] $name]} {
	    set extButtonDefs [lreplace $extButtonDefs $ind $ind]
	    break
	}
	incr ind
    }
}

# WB::DisableShortcutButtonPad --
#
#       Sets the state of the main to "read only".

proc ::WB::DisableShortcutButtonPad {w} {
    variable btShortDefs
    upvar ::WB::${w}::wapp wapp
    
    set wtbar $wapp(tbar)
    foreach {name cmd} $btShortDefs {

	switch -- $name {
	    save - print - stop {
		continue
	    }
	    default {
		$wtbar buttonconfigure $name -state disabled
	    }
	}
    }
}

# WB::BuildAllButtons --
#
#       Makes the toolbar button pad for the drawing tools.
#       
# Arguments:
#       w           toplevel widget path
#       
# Results:
#       tool buttons created and mapped

proc ::WB::BuildAllButtons {w} {
    global  prefs this
    
    variable btNo2Name 
    variable btName2No
    variable BtName
    variable wbicons
    upvar ::WB::${w}::state state
    upvar ::WB::${w}::wapp wapp
    upvar ::WB::${w}::opts opts
    
    set wtool $wapp(tool)
    
    for {set icol 0} {$icol <= 1} {incr icol} {
	for {set irow 0} {$irow <= 6} {incr irow} {
	    set name $btNo2Name($irow$icol)
	    set wlabel $wtool.bt$irow$icol
	    
	    ttk::radiobutton $wlabel -style Toolbutton \
	      -variable ::WB::${w}::state(tool) -value $name \
	      -command [list [namespace current]::ToolCmd $w] \
	      -image $wbicons($name)
	    grid  $wlabel  -row $irow -column $icol -padx 0 -pady 0
	    
	    if {[string equal $opts(-state) "disabled"]} {
		$wlabel state {disabled}
	    } else {
		
		# Handle bindings to popup options.
		if {[string match "mac*" $this(platform)]} {
		    bind $wlabel <Button-1>        \
		      +[list [namespace current]::StartTimerToToolPopup $w %W $name]
		    bind $wlabel <ButtonRelease-1> \
		      [namespace current]::StopTimerToToolPopup
		}
		bind $wlabel <<ButtonPopup>> [list [namespace current]::DoToolPopup $w %W $name]
	    }
	    set str [dict get $BtName $name]
	    if {($name eq "point") && ($this(platform) eq "macosx")} {
		set str [mc "Point tool, click to mark, double click to inspect, press to popup"]
	    }
	    ::balloonhelp::balloonforwindow $wlabel $str
	}
    }
    
    # Make all popups.
    BuildToolPopups $w
    BuildToolPopupFontMenu $w $prefs(canvasFonts)
    
    # Color selector.
    BuildColorSelector $w 
}

proc ::WB::BuildColorSelector {w} {
    variable wbicons
    upvar ::WB::${w}::state state
    upvar ::WB::${w}::wapp wapp
    upvar ::WB::${w}::opts opts
    
    set wtool $wapp(tool)
    set wcolsel $wtool.f.col
    set wfg     $wcolsel.fg
    set wbg1    $wcolsel.bg1
    set wbg2    $wcolsel.bg2
    set wbw     $wcolsel.bw
    set wswap   $wcolsel.swap

    set fg $state(fgCol)
    set bg $state(bgCol)

    # Need an extra frame else place gets misplaced.
    ttk::frame $wtool.f
    ttk::label $wcolsel -compound image -image $wbicons(colorSelector)
    label $wfg   -image $wbicons(bwrect) -bd 0 -width 34 -height 24 -bg $fg
    label $wbg1  -image $wbicons(bwrect) -bd 0 -width 14 -height 12 -bg $bg
    label $wbg2  -image $wbicons(bwrect) -bd 0 -width 34 -height 12 -bg $bg
    ttk::label $wbw   -image $wbicons(colorSelBW)
    ttk::label $wswap -image $wbicons(colorSelSwap)
    
    # The ttk::label seems to put an extra 2 pixel border. @@@ BAD
    set off 2
    grid  $wtool.f  -  -sticky ew
    pack  $wcolsel  -side top
    place $wfg   -x [expr {6+$off}]  -y [expr {5+$off}]
    place $wbg1  -x [expr {42+$off}] -y [expr {19+$off}]
    place $wbg2  -x [expr {22+$off}] -y [expr {31+$off}]
    place $wbw   -x  4 -y 33
    place $wswap -x 46 -y  3

    if {![string equal $opts(-state) "disabled"]} {
	bind $wfg   <Button-1> [list [namespace current]::OnColorSelector $w]
	bind $wbw   <Button-1> [list [namespace current]::OnColorSelectorReset $w]
	bind $wswap <Button-1> [list [namespace current]::OnColorSelectorSwitch $w]
    }
    set wapp(colSel)    $wfg
    set wapp(colSelBg1) $wbg1
    set wapp(colSelBg2) $wbg2
}

proc ::WB::BuildToolPopups {w} {
    global  prefs
    
    variable menuDefs
    upvar ::WB::${w}::wapp wapp
    
    set wtool $wapp(tool)
    
    # List of which entries where.
    array set menuArr {
	line       {thickness dash constrain}
	arrow      {thickness dash constrain}
	rect       {thickness fill dash}
	oval       {thickness fill dash}
	pen        {thickness smooth}
	brush      {brushthickness smooth}
	text       {font fontsize fontweight}
	poly       {thickness fill dash smooth}
	arc        {thickness fill dash arcs}
    }
    foreach name [array names menuArr] {
	set mDef($name) {}
	foreach key $menuArr($name) {
	    lappend mDef($name) $menuDefs(main,prefs,$key)
	}
	::UI::NewMenu $w $wtool.pop${name} {} TESTJE $mDef($name)
	if {!$prefs(haveDash) && ([lsearch $menuArr($name) dash] >= 0)} {
	    ::UI::MenuMethod $wtool.pop${name} entryconfigure mDash -state disabled -label [mc "Dash"]
	}
    }
}

# WB::StartTimerToToolPopup, StopTimerToToolPopup, DoToolPopup --
#
#       Some functions to handle the tool popup menu.

proc ::WB::StartTimerToToolPopup {w wbutton name} {
    
    variable toolPopupId
    
    if {[info exists toolPopupId]} {
	catch {after cancel $toolPopupId}
    }
    set toolPopupId [after 1000 \
      [list [namespace current]::DoToolPopup $w $wbutton $name]]
}

proc ::WB::StopTimerToToolPopup {} {
    
    variable toolPopupId

    if {[info exists toolPopupId]} {
	catch {after cancel $toolPopupId}
    }
}

proc ::WB::DoToolPopup {w wbutton name} {
    
    upvar ::WB::${w}::wapp wapp

    set wtool $wapp(tool)
    set wpop $wtool.pop${name}
    if {[winfo exists $wpop]} {
	set x [winfo rootx $w]
	set y [expr [winfo rooty $wbutton] + [winfo height $wbutton]]
	tk_popup $wpop $x $y
    }
}

proc ::WB::OnColorSelectorSwitch {w} {
    
    upvar ::WB::${w}::state state
    upvar ::WB::${w}::wapp wapp

    $wapp(colSel)    configure -bg $state(bgCol)
    $wapp(colSelBg1) configure -bg $state(fgCol)
    $wapp(colSelBg2) configure -bg $state(fgCol)
    set tmp $state(fgCol)
    set state(fgCol) $state(bgCol)
    set state(bgCol) $tmp
}

# WB::OnColorSelector --
#
#       Callback procedure for the color selector in the tools frame.
#       
# Arguments:
#       
# Results:
#       color dialog shown.

proc ::WB::OnColorSelector {w} {
    
    upvar ::WB::${w}::state state
    upvar ::WB::${w}::wapp wapp

    set col [tk_chooseColor -initialcolor $state(fgCol)]
    if {$col ne ""} {
	set state(fgCol) $col
	$wapp(colSel) configure -bg $state(fgCol)
    }
}

proc ::WB::OnColorSelectorReset {w} {

    upvar ::WB::${w}::state state
    upvar ::WB::${w}::wapp wapp

    $wapp(colSel)    configure -bg black
    $wapp(colSelBg1) configure -bg white
    $wapp(colSelBg2) configure -bg white
    set state(fgCol) black
    set state(bgCol) white
}
	
# Access functions to make it possible to isolate these variables.

proc ::WB::ToolBtNameToNum {name} {

    variable btName2No 
    return $btName2No($name)
}

proc ::WB::ToolBtNumToName {num} {

    variable btNo2Name     
    return $btNo2Name($num)
}

# ::WB::SetBasicMinsize --
# 
#       Makes a wm minsize call to set the minsize of the basic whiteboard.
#       Shall only be called after idle!

proc ::WB::SetBasicMinsize {w} {
    
    eval {wm minsize $w} [GetBasicWhiteboardMinsize $w]
}

# WB::GetBasicWhiteboardMinsize --
# 
#       Computes the minimum width and height of whiteboard including any menu
#       but excluding any custom made entry parts.

proc ::WB::GetBasicWhiteboardMinsize {w} {
    global  this prefs
    
    variable wbicons
    upvar ::WB::${w}::wapp wapp

    # Let the geometry manager finish before getting widget sizes.
    update idletasks
  
    # The min height.
    # If we have a custom made menubar using a frame with labels (embedded).
    if {$prefs(haveMenus)} {
	set hFakeMenu 0
	if {![string match "mac*" $this(platform)]} {
	     set hMenu 1
	     # In 8.4 it seems that .wb1.#wb1#menu is used.
	     set wmenu_ $w.#${w}#menu
	     if {[winfo exists $wmenu_]} {
		 set hMenu [winfo height $wmenu_]
	     }
	 } else {
	     set hMenu 0
	 }
    } else {
	set hMenu [winfo reqheight $wapp(menu)]
    }
    set hTop 0
    if {[winfo exists $wapp(tbar)]} {
	set hTop [winfo reqheight $wapp(tbar)]
    }
    set hTool     [winfo reqheight $wapp(tool)]
    #set hBugImage [image height $wapp(bugImage)]
    set hBugImage 0
    if {[winfo exists $wapp(frstat)]} {
	set hStatus   [winfo reqheight $wapp(frstat)]
    } else {
	set hStatus 0
    }
    
    # The min width.
    set wButtons  [$wapp(tbar) minwidth]
    
    set wMin [expr {$wButtons + 6}]
    set hMin [expr {$hMenu + $hTop + $hTool + $hBugImage + $hStatus}]
    
    return [list $wMin $hMin]
}

# ::WB::SetCanvasSize --
#
#       From the canvas size, 'cw' and 'ch', set the total application size.
#       
# Arguments:
#
# Results:
#       None.

proc ::WB::SetCanvasSize {w cw ch} {
    global  this
    upvar ::WB::${w}::wapp wapp

    # Compute new root size from the desired canvas size.
    set thick [expr int([$wapp(can) cget -highlightthickness])]
    set widthtot  [expr $cw + [winfo reqwidth $wapp(tool)]]
    set heighttot [expr $ch + \
      [winfo reqheight $wapp(comm)] + \
      [winfo reqheight $wapp(tbar)]]
    incr widthtot  [expr [winfo reqwidth $wapp(ysc)] + 4 + $thick]
    incr heighttot [expr [winfo reqheight $wapp(xsc)] + 4 + $thick]
    
    # Menu is a bit tricky. Not needed since wm geometry doesn't count it!
    if {0} {
	if {![string match "mac*" $this(platform)]} {
	    # ad hoc !
	    set wmenu "${w}.#[winfo name $w]#menu"
	    if {[winfo exists $wmenu]} {
		incr heighttot [winfo height $wmenu]
	    }
	}
    }
    
    # Make sure not bigger than the screen.
    set wscreen [winfo screenwidth $w]
    set hscreen [winfo screenheight $w]
    if {$widthtot > $wscreen} {
	set widthtot $wscreen
    }
    if {$heighttot > $hscreen} {
	set heighttot $hscreen
    }
    wm geometry $w ${widthtot}x${heighttot}

    Debug 4 "::WB::SetCanvasSize:: cw=$cw, ch=$ch, heighttot=$heighttot, \
      heighttot=$heighttot"
}

proc ::WB::GetCanvasSize {w} {
    upvar ::WB::${w}::wapp wapp

    return [list [winfo width $wapp(can)] [winfo height $wapp(can)]]
}

proc ::WB::SetScrollregion {w swidth sheight} {
    upvar ::WB::${w}::wapp wapp

    $wapp(can) configure -scrollregion [list 0 0 $swidth $sheight]
}

proc ::WB::FilePostCommand {w wmenu} {
    upvar ::WB::${w}::opts opts

    set editable 0
    if {$opts(-state) eq "normal"} {
	set editable 1
    }
    if {$editable} {
	::UI::MenuEnableAll $wmenu
	if {![::Plugins::HavePackage QuickTimeTcl]} {
	    ::UI::MenuMethod $wmenu entryconfigure mOpenStream... -state disabled -label [mc "Open St&ream"]...
	}
    } else {
	::UI::MenuDisableAllBut $wmenu {
	    mNewWindow mCloseWindow mSave mPageSetup mPrint...
	}
    }
    ::hooks::run menuPostCommand whiteboard-file $wmenu
    
    # Workaround for mac bug.
    update idletasks
}

# WB::EditPostCommand --
# 
#       Post command for edit menu.
#       
# Arguments:
#       w           toplevel widget path
#       wmenu       the edit menu
#
# Results:

proc ::WB::EditPostCommand {w wmenu} {
    
    set wfocus [focus]

    # Start by having all off.
    ::UI::MenuDisableAllBut $wmenu {}

    if {[winfo exists $wfocus]} {
	set wclass [winfo class $wfocus]
	if {$wclass eq "Canvas" && [winfo class [winfo parent $wfocus]] eq "WBCanvas"} {
	    set wclass WBCanvas
	}

	switch -- $wclass {
	    TEntry - Entry - Text {
		foreach {mkey mstate} [::UI::GenericCCPMenuStates] {
		    ::UI::MenuMethod $wmenu entryconfigure $mkey -state $mstate
		}	
	    }
	    WBCanvas {
		EditPostCommandWhiteboard $w $wmenu		
	    }
	}
    }

    ::hooks::run menuPostCommand whiteboard-edit $wmenu

    # Workaround for mac bug.
    update idletasks
}

# WB::EditPostCommandWhiteboard --
# 
#       Sets the specific whiteboard edit menu entry states.

proc ::WB::EditPostCommandWhiteboard {w wmenu} {
    upvar ::WB::${w}::wapp wapp
    upvar ::WB::${w}::opts opts

    set wcan $wapp(can)
    set normal 0
    if {$opts(-state) eq "normal"} {
	set normal 1
    }
    set selected [$wcan find withtag selected]
    set len [llength $selected]
    set haveSelection 0
    set haveTextSelection 0
    set haveFlip 0
    set haveImage 0
    set haveText 0
    set haveResize 1
    set flip 0
    set resize 0
    set resizeImage 0
    
    foreach id $selected {
	switch -- [$wcan type $id] {
	    line - polygon {
		set haveFlip 1
		set haveResize 1
	    }
	    rectangle - oval {
		set haveResize 1
	    }
	    image {
		set haveImage 1
	    }
	    text {
		set haveText 1
	    }
	}
    }
    if {$len == 1} {
	if {$haveImage} {
	    set resizeImage 1
	}
	if {$haveFlip} {
	    set flip 1
	}
    }
    if {$len} {
	set haveSelection 1
    } else {
	set t [$wcan select item]
	if {$t ne {}} {
	    set text [$wcan itemcget $t -text]
	    set start [$wcan index $t sel.first]
	    set end [$wcan index $t sel.last]
	    if {[string length [string range $text $start $end]]} {
		set haveTextSelection 1
	    }
	}
    }
    if {$haveResize && !$haveImage && !$haveText} {
	set resize 1
    }

    # Undo and redo.
    if {$normal && [undo::canundo [GetUndoToken $wcan]]} {
	::UI::MenuMethod $wmenu entryconfigure mUndo -state normal -label [mc "&Undo"]
    } else {
	::UI::MenuMethod $wmenu entryconfigure mUndo -state disabled -label [mc "&Undo"]
    }
    if {$normal && [undo::canredo [GetUndoToken $wcan]]} {
	::UI::MenuMethod $wmenu entryconfigure mRedo -state normal -label [mc "Re&do"]
    } else {
	::UI::MenuMethod $wmenu entryconfigure mRedo -state disabled -label [mc "Re&do"]
    }
    
    # Cut, copy and paste menu entries.
    if {$haveSelection} {
	if {$normal} {
	    ::UI::MenuMethod $wmenu entryconfigure mCut  -state normal -label [mc "Cu&t"]
	} else {
	    ::UI::MenuMethod $wmenu entryconfigure mCut  -state disabled -label [mc "Cu&t"]
	}
	::UI::MenuMethod $wmenu entryconfigure mCopy -state normal -label [mc "&Copy"]
    } elseif {$haveTextSelection} {
	::UI::MenuMethod $wmenu entryconfigure mCut  -state normal -label [mc "Cu&t"]
	::UI::MenuMethod $wmenu entryconfigure mCopy -state normal -label [mc "&Copy"]
    } else {
	::UI::MenuMethod $wmenu entryconfigure mCut  -state disabled -label [mc "Cu&t"]
	::UI::MenuMethod $wmenu entryconfigure mCopy -state disabled -label [mc "&Copy"]
    }
    if {[catch {selection get -sel CLIPBOARD} str]} {
	::UI::MenuMethod $wmenu entryconfigure mPaste -state disabled -label [mc "&Paste"]
    } elseif {$normal && ($str ne "")} {
	::UI::MenuMethod $wmenu entryconfigure mPaste -state normal -label [mc "&Paste"]
    } else {
	::UI::MenuMethod $wmenu entryconfigure mPaste -state disabled -label [mc "&Paste"]
    }

    # All and Erase All.
    ::UI::MenuMethod $wmenu entryconfigure mSelectAll -state normal -label [mc "Select &All"]
    if {$normal} {
	::UI::MenuMethod $wmenu entryconfigure mClear -state normal -label [mc "Clear"]
    } else {
	::UI::MenuMethod $wmenu entryconfigure mClear -state disabled -label [mc "Clear"]
    }
    if {!$len || !$normal} {
	
	# There is no selection in the canvas or whiteboard disabled.
	::UI::MenuMethod $wmenu entryconfigure mEditItem... -state disabled -label [mc "&Edit Item"]...
	::UI::MenuMethod $wmenu entryconfigure mRaise -state disabled -label [mc "&Raise"]
	::UI::MenuMethod $wmenu entryconfigure mLower -state disabled -label [mc "&Lower"]
	::UI::MenuMethod $wmenu entryconfigure mLarger -state disabled -label [mc "Larger"]
	::UI::MenuMethod $wmenu entryconfigure mSmaller -state disabled -label [mc "Smaller"]
	::UI::MenuMethod $wmenu entryconfigure mFlip -state disabled -label [mc "Flip"]
	::UI::MenuMethod $wmenu entryconfigure mImageLarger -state disabled -label [mc "Image Larger"]
	::UI::MenuMethod $wmenu entryconfigure mImageSmaller -state disabled -label [mc "Image Smaller"]  
    } else {	
	::UI::MenuMethod $wmenu entryconfigure mEditItem... -state normal -label [mc "&Edit Item"]...
	::UI::MenuMethod $wmenu entryconfigure mRaise -state normal -label [mc "&Raise"]
	::UI::MenuMethod $wmenu entryconfigure mLower -state normal -label [mc "&Lower"]
	if {$flip} {
	    ::UI::MenuMethod $wmenu entryconfigure mFlip -state normal -label [mc "Flip"]
	} else {
	    ::UI::MenuMethod $wmenu entryconfigure mFlip -state disabled -label [mc "Flip"]
	}
	if {$resizeImage} {
	    ::UI::MenuMethod $wmenu entryconfigure mImageLarger -state normal -label [mc "Image Larger"]
	    ::UI::MenuMethod $wmenu entryconfigure mImageSmaller -state normal -label [mc "Image Smaller"]  
	} else {
	    ::UI::MenuMethod $wmenu entryconfigure mImageLarger -state disabled -label [mc "Image Larger"]
	    ::UI::MenuMethod $wmenu entryconfigure mImageSmaller -state disabled -label [mc "Image Smaller"]  
	}	
	if {$resize} {
	    ::UI::MenuMethod $wmenu entryconfigure mLarger -state normal -label [mc "Larger"]
	    ::UI::MenuMethod $wmenu entryconfigure mSmaller -state normal -label [mc "Smaller"]
	} else {
	    ::UI::MenuMethod $wmenu entryconfigure mLarger -state disabled -label [mc "Larger"]
	    ::UI::MenuMethod $wmenu entryconfigure mSmaller -state disabled -label [mc "Smaller"]
	}
    }
}

proc ::WB::PrefsPostCommand {w wmenu} {
    
    # Complete menu disabled for disabled whiteboard.
    
    ::hooks::run menuPostCommand whiteboard-prefs $wmenu
    
    # Workaround for mac bug.
    update idletasks
}

# WB::GetFocus --
#
#       Check clipboard and activate corresponding menus. ???   
#       
# Results:
#       none.

proc ::WB::GetFocus {w wevent} {
    
    upvar ::WB::${w}::opts opts
    upvar ::WB::${w}::wapp wapp

    set wcan $wapp(can)

    # Bind to toplevel may fire multiple times.
    if {$w ne $wevent} {
	return
    }
    Debug 3 "GetFocus:: w=$w, wevent=$wevent"
    
    SetFrameItemBinds $wcan [GetButtonState $w]
}

# WB::MakeItemMenuDef --
# 
#       Makes a menuDefs list recursively for canvas files.
#       Only for mac until -postcommand bug fixed.

proc ::WB::MakeItemMenuDef {dir} {
    
    set mdef {}
    foreach f [glob -nocomplain -directory $dir *] {
	
	# Sort out directories we shouldn't search.
	switch -- [string tolower [file tail $f]] {
	    . - resource.frk - cvs {
		continue
	    }
	}
	if {[file isdirectory $f]} {
	    set submdef [MakeItemMenuDef $f]
	    set name [file tail $f]
	    if {[llength $submdef]} {
		lappend mdef [list cascade $name $name {} {} {} $submdef]
	    }
	} elseif {[string equal [file extension $f] ".can"]} {
	    set name [file rootname [file tail $f]]
	    set cmd {::CanvasFile::DrawCanvasItemFromFile $w}

	    # Important to protect any $ since we do 'subst'.
	    lappend cmd [string map {$ \\$} $f]
	    lappend mdef [list command $name $name $cmd {}]
	}
    }
    return $mdef
}

# WB::BuildItemsMenu, AddItemsMenu --
# 
#       Builds items (library) menu dynamically from -postcommand.

proc ::WB::BuildItemsMenu {w m} {
    global  this
    
    foreach msub [winfo children $m] {
	destroy $msub
    }
    $m delete 0 end
 
    AddItemsMenu $w $m $this(itemPath)
    if {[HaveAnyCanFiles $this(altItemPath)]} {
	$m add separator
	AddItemsMenu $w $m $this(altItemPath)
    }
    
    # Workaround for mac bug. Still doesn't work for submenus.
    update idletasks
}

proc ::WB::AddItemsMenu {w m dir} {
    
    set n 0
    foreach f [glob -nocomplain -directory $dir *] {
	
	# Sort out directories we shouldn't search.
	switch -- [string tolower [file tail $f]] {
	    . - resource.frk - cvs {
		continue
	    }
	}
	if {[file isdirectory $f] && [HaveAnyCanFiles $f]} {
	    set msub $m.$n
	    menu $msub -tearoff 0
	    set nsub [AddItemsMenu $w $msub $f]
	    set name [file tail $f]
	    $m add cascade -label $name -menu $msub
	} elseif {[string equal [file extension $f] ".can"]} {
	    set name [file rootname [file tail $f]]
	    set cmd [list ::CanvasFile::DrawCanvasItemFromFile $w $f]
	    $m add command -label $name -command $cmd
	}
	incr n
    }
    return $n
}

proc ::WB::HaveAnyCanFiles {dir} {
    
    foreach f [glob -nocomplain -directory $dir *] {
	if {[file isdirectory $f]} {
	    if {[HaveAnyCanFiles $f]} {
		return 1
	    }
	} elseif {[string equal [file extension $f] ".can"]} {
	    return 1
	}
    }
    return 0
}

# WB::BuildFontMenu ---
# 
#       Creates the font selection menu, and removes any old.
#    
# Arguments:
#       mt         The menu path.
#       allFonts   List of names of the fonts.
#       
# Results:
#       font submenu built.

proc ::WB::BuildFontMenu {w allFonts} {
    
    set mt $w.menu.prefs.mfont
    
    $mt delete 0 end
    foreach afont $allFonts {
	$mt add radio -label $afont -variable ::WB::${w}::state(font)  \
	  -command [list ::WB::FontChanged $w name]
    }
    
    # Be sure that the presently selected font family is still there,
    # else choose helvetica.
    set fontStateVar ::WB::${w}::state(font)
    if {[lsearch -exact $allFonts $fontStateVar] == -1} {
	set ::WB::${w}::state(font) {Helvetica}
    }
}

proc ::WB::BuildToolPopupFontMenu {w allFonts} {
    upvar ::WB::${w}::wapp wapp
    
    set wtool $wapp(tool)
    set mt $wtool.poptext.mfont
    
    $mt delete 0 end
    foreach afont $allFonts {
	$mt add radio -label $afont -variable ::WB::${w}::state(font)  \
	  -command [list ::WB::FontChanged $w name]
    }
}

proc ::WB::BuildAllFontMenus {allFonts} {

    # Must do this for all open whiteboards!
    foreach w [GetAllWhiteboards] {
	BuildFontMenu $w $allFonts
	BuildToolPopupFontMenu $w $allFonts
    }
}

# WB::FontChanged --
# 
#       Callback procedure for the font menu. When new font name, size or weight,
#       and we have focus on a text item, change the font spec of this item.
#
# Arguments:
#       w           toplevel widget path
#       what        name, size or weight
#       
# Results:
#       updates text item, sends to all clients.

proc ::WB::FontChanged {w what} {
    global  fontSize2Points fontPoints2Size

    upvar ::WB::${w}::wapp wapp
    upvar ::WB::${w}::state state
    
    set wcan $wapp(can)

    # If there is a focus on a text item, change the font for this item.
    set idfocus [$wcan focus]
    
    if {[string length $idfocus] > 0} {
	set theItno [::CanvasUtils::GetUtag $wcan focus]
	if {[string length $theItno] == 0} {
	    return
	}
	if {[$wcan type $theItno] ne "text"} {
	    return
	}
	set fontSpec [$wcan itemcget $theItno -font]
	if {[llength $fontSpec] > 0} {
	    array set whatToInd {name 0 size 1 weight 2}
	    array set whatToPref {name font size fontSize weight fontWeight}
	    set ind $whatToInd($what)

	    # Need to translate html size to point size.
	    if {$what eq "size"} {
		set newFontSpec [lreplace $fontSpec $ind $ind  \
		  $fontSize2Points($state($whatToPref($what)))]
	    } else {
		set newFontSpec [lreplace $fontSpec $ind $ind  \
		  $state($whatToPref($what))]
	    }
	    ::CanvasUtils::ItemConfigure $wcan $theItno -font $newFontSpec
	}
    }
}

proc ::WB::StartStopAnimatedWave {w start} {
    
}

# WB::CreateBrokenImage --
# 
#       Creates an actual image with the broken symbol that matches
#       up the width and height. The image is garbage collected.

proc ::WB::CreateBrokenImage {wcan width height} {
    variable icons
    
    set w [winfo toplevel $wcan]
    upvar ::WB::${w}::canvasImages canvasImages
    
    if {($width == 0) || ($height == 0)} {
	set name $icons(brokenImage)
    } else {
	set zoomx [expr $width/[image width $icons(brokenImage)]]
	set zoomy [expr $height/[image height $icons(brokenImage)]]
	if {($zoomx < 1) && ($zoomy < 1)} {
	    set name $icons(brokenImage)
	} else {
	    set zoomx [expr $zoomx < 1 ? 1 : $zoomx]
	    set zoomy [expr $zoomy < 1 ? 1 : $zoomy]
	    set name [image create photo -width $width -height $height]
	    $name blank
	    $name copy $icons(brokenImage) -to 0 0 $width $height  \
	      -zoom $zoomx $zoomy -compositingrule overlay
	    lappend canvasImages $name
	}
    }
    return $name
}

proc ::WB::InitDnD {wcan} {
    
    dnd bindtarget $wcan text/uri-list <Drop>      [list ::WB::DnDDrop %W %D %T %x %y]   
    dnd bindtarget $wcan text/uri-list <DragEnter> [list ::WB::DnDEnter %W %A %D %T]   
    dnd bindtarget $wcan text/uri-list <DragLeave> [list ::WB::DnDLeave %W %D %T]       
}

proc ::WB::DnDDrop {wcan data type x y} {
    global  prefs
    
    ::Debug 2 "::WB::DnDDrop data=$data, type=$type"

    set w [winfo toplevel $wcan]

    foreach f $data {
	
	# Strip off any file:// prefix.
	set f [string map {file:// ""} $f]
	set f [::uri::urn::unquote $f]
	
	# Allow also .can files to be dropped.
	if {[file extension $f] eq ".can"} {
	    ::CanvasFile::DrawCanvasItemFromFile $w $f
	} else {
	    set mime [::Types::GetMimeTypeForFileName $f]
	    set haveImporter [::Plugins::HaveImporterForMime $mime]
	    if {$haveImporter} {
		set opts [list -coords [list $x $y]]
		set errMsg [::Import::DoImport $wcan $opts -file $f]
		if {$errMsg ne ""} {
		    ::UI::MessageBox -title [mc "Error"] -icon error -type ok \
		      -message "Failed importing: $errMsg" -parent $w
		}
		incr x $prefs(offsetCopy)
		incr y $prefs(offsetCopy)
	    } else {
		::UI::MessageBox -title [mc "Error"] -icon error -type ok \
		  -message [mc "Cannot find importer for the MIME type %s" $mime] -parent $w
	    }
	}
    }
}

proc ::WB::DnDEnter {wcan action data type} {
    
    ::Debug 2 "::WB::DnDEnter action=$action, data=$data, type=$type"

    set act "none"
    foreach f $data {
	if {[file extension $f] eq ".can"} {
	    set haveImporter 1
	} else {
	    
	    # Require at least one file importable.
	    set haveImporter [::Plugins::HaveImporterForMime  \
	      [::Types::GetMimeTypeForFileName $f]]
	}
	if {$haveImporter} {
	    focus $wcan
	    set act $action
	    break
	}
    }
    return $act
}

proc ::WB::DnDLeave {wcan data type} {
    
    focus [winfo toplevel $wcan] 
}

#       Some stuff to handle sending messages using hooks.
#       The idea is to isolate us from jabber, p2p etc.
#       It shall only deal with remote clients, local drawing must be handled
#       separately.

# ::WB::SendMessageList --
# 
#       Invokes any registered send message hook. The 'cmdList' must
#       be without the "CANVAS:" prefix!

proc ::WB::SendMessageList {w cmdList args} {
    
    eval {::hooks::run whiteboardSendMessageHook $w $cmdList} $args
}

# ::WB::SendGenMessageList --
# 
#       Invokes any registered send message hook. 
#       The commands in the cmdList may include any prefix.
#       The prefix shall be included in commands of the cmdList.
#       @@@ THIS IS ACTUALLY A BAD SOLUTION AND SHALL BE REMOVED LATER!!!

proc ::WB::SendGenMessageList {w cmdList args} {
    
    eval {::hooks::run whiteboardSendGenMessageHook $w $cmdList} $args
}

# ::WB::PutFile --
# 
#       Invokes any registered hook for putting a file. This is only called
#       when we want to do p2p file transports (put/get).

proc ::WB::PutFile {w fileName opts args} {
    
    eval {::hooks::run whiteboardPutFileHook $w $fileName $opts} $args
}

# ::WB::RegisterHandler --
# 
#       Register handlers for additional command in the protocol.

proc ::WB::RegisterHandler {prefix cmd} {
    variable handler

    set handler($prefix) $cmd
    ::hooks::run whiteboardRegisterHandlerHook $prefix $cmd
}

# ::WB::GetRegisteredHandlers --
# 
#       Code that wants to get registered handlers must call this to get
#       the present handlers, and to add the 'whiteboardRegisterHandlerHook'
#       to get subsequent handlers.

proc ::WB::GetRegisteredHandlers {} {
    variable handler

    return [array get handler]
}

# ::WB::Free --
# 
#       Destroy handler only for cleanup.

proc ::WB::Free {w} {
        
    Debug 2 "::WB::Free w=$w"
	    
    # We could do some cleanup here.
    GarbageImages $w
    ::CanvasUtils::ItemFree $w
    ::UI::FreeMenu $w
    
    namespace delete ::WB::${w}
}

#-------------------------------------------------------------------------------

