swaplist(3tk)

💖 swaplist — move options between two lists 💖

okay bestie, gather round, because this one is actually so fun. it's a dialog. it has two listboxes. you move stuff between them. that's it, that's the whole vibe. it's giving "drag your faves into the right column" energy and honestly? obsessed. 🎀

---

✨ NAME ✨

swaplist — a dialog which lets a user move options between two lists. two lists. one destiny. periodt. 💅

---

🌸 SYNOPSIS 🌸

package require Tcl 8.4

package require Tk 8.4

package require swaplist ?0.1?

::swaplist::swaplist pathName variable completeList selectedList ?options?

like. look at it. so clean. so demure. 🦋

---

👑 DESCRIPTION 👑

so this package hands you a whole dialog — two listboxes, bestie, side by side — plus buttons to move items between them and reorder the right list. iconic behaviour, no notes. 🔥

::swaplist::swaplist pathName variable completeList selectedList ?options?

Creates a dialog which presents the user with a pair of listboxes. Items are selected by using the buttons to move them to the right list. The contents of the right list are put in the variable upon closure of the dialog. The command returns a boolean indicating if the user pressed OK or not. If -geometry is not specified, the dialog is centered in its parent toplevel unless its parent is . in which case the dialog is centered in the screen. ✨ (yes it's doing math about your parent window. it's a whole thing. it's fine. it's serving.)

🎀 Options:

• -embed — if this flag is supplied, the procedure will create a swaplist widget named pathName, with the variable set as the listvariable for the right side listbox. This flag will also cause the -title and -geometry flags to be ignored. 😭 (sorry girl, they're not invited to this party)
• -reorder — boolean specifying if buttons allowing the user to change the order of the right listbox should appear or not. defaults to true
• -title — sets the title of the dialog window. defaults to "Configuration"
• -llabel — sets the heading above the left list. defaults to "Available:"
• -rlabel — sets the heading above the right list. defaults to "Selected:"
• -lbuttontext — sets the text on the "move left" button. defaults to "<<"
• -rbuttontext — sets the text on the "move right" button. defaults to ">>"
• -ubuttontext — sets the text on the "move up" button. defaults to "Move Up"
• -dbuttontext — sets the text on the "move down" button. defaults to "Move Down"
• -geometry — sets the geometry of the dialog window.

---

🌈 EXAMPLE 🌈

here's the whole slay, copy-paste ready, bestie:

package require swaplist
namespace import swaplist::*

if {[swaplist .slist opts "1 2 3 4 5 6 7 8 9" "1 3 5"]} {
    puts "user chose numbers: $opts"
}

notice how the if only fires when the user hits OK — that's the boolean talking. if they bail, no puts, no drama. 🫶

---

💀 BUGS, IDEAS, FEEDBACK 💀

This document, and the package it describes, will undoubtedly contain bugs and other problems. Please report such in the category swaplist of the Tklib Trackers [http://core.tcl.tk/tklib/reportlist]. Please also report any ideas for enhancements you may have for either package and/or documentation.

bestie if you find a bug, PLEASE tell them, don't just suffer in silence. the tracker is right there. they want your feedback. it's not cringe to report a bug, it's cringe to hoard it. 🙈

---

⭐ KEYWORDS ⭐

dialog, disjointlistbox, listbox

---

🧚 CATEGORY 🧚

Widget

---

and that's the whole page, bestie 💜 this is swaplist, version 0.1, part of the tklib collection, living in the swaplist(3tk) manual. go forth and move items between lists like the main character you are. slay, fr fr. 💅✨