Curses::UI::Common(3)

💖 NAME 💖

Curses::UI::Common — Common methods for Curses::UI. This is the manual page for Curses::UI::Common(3), straight out of the User Contributed Perl Documentation pile, and bestie, it’s giving “shared methods for Curses::UI classes.” 💅

---

🌈 CLASS HIERARCHY 🌈

okay so the hierarchy is literally this simple:

Curses::UI::Common - base class

---

🦋 SYNOPSIS 🦋

   package MyPackage;

   use Curses::UI::Common;
   use vars qw(@ISA);
   @ISA = qw(Curses::UI::Common);

---

🌸 DESCRIPTION 🌸

Curses::UI::Common is a collection of methods that is shared between Curses::UI classes. That’s the whole vibe: common methods, one shared spot, no cap. ✨

---

👑 METHODS 👑

💖 Various methods 💖

• parent ( ) — returns the data member $this->{-parent}. It literally just hands it back to you. 🫶
• root ( ) — returns the topmost -parent (the Curses::UI instance). It’s giving “go all the way up” energy. 🌈
• delallwin ( ) — walks through all the data members of the class instance. Every data member that is a Curses::Window descendant will be removed. 💀
• accessor ( NAME, [VALUE] ) — if VALUE is set, the value for the data member $this->{NAME} will be changed. The method returns the current value for data member $this->{NAME}. 🎀
• keys_to_lowercase ( HASHREF ) — all keys in the hash referred to by HASHREF will be converted to lower case. Slay, lowercase era. 🔥

📝 Text processing 📝

• split_to_lines ( TEXT ) — splits TEXT into a list of separate lines. It returns a reference to this list. 🧚
• scrlength ( LINE ) — returns the screenlength of the string LINE. The difference with the perl function length() is that this method will expand TAB characters. It is exported by this class and it may be called as a stand-alone routine. 💅
• text_dimension ( TEXT ) — returns an array containing the width (the length of the longest line) and the height (the number of lines) of the TEXT. 🌸
• text_wrap ( LINE, LENGTH, WORDWRAP ) — wraps a line of text (LINE) to a given length (LENGTH). If the WORDWRAP argument is true, wordwrap will be enabled — and yes, this is the default for WORDWRAP. It returns a reference to a list of wrapped lines. It is exported by this class and it may be called as a stand-alone routine. 🎀
• WORDWRAP ( ) and NO_WORDWRAP ( ) — these routines will return the correct value for the WORDWRAP argument. These routines are exported by this class. 🫶

Example:

$this->text_wrap($line, 50, NO_WORDWRAP);

🔑 Reading key input 🔑

• CUI_ESCAPE ( ), CUI_TAB ( ), CUI_SPACE ( ) — a couple of routines that are not defined by the Curses module, but which might be useful anyway. These routines are exported by this class. 💜
• get_key ( BLOCKTIME, CURSOR ) — tries to read a key from the keyboard. It returns the key pressed or -1 if no key was pressed. It is exported by this class and it may be called as a stand-alone routine. 📟

The BLOCKTIME argument can be used to set the curses halfdelay (the time to wait before the routine decides that no key was pressed). BLOCKTIME is given in tenths of seconds. The default is 0 (non-blocking key read).

Example:

my $key = $this->get_key(5)

---

🌟 SEE ALSO 🌟

Curses::UI — that’s the one to go look at. 💖

---

📜 AUTHOR 📜

Copyright (c) 2001-2002 Maurice Makaay. All rights reserved. 🫶

Maintained by Marcus Thiesen (marcus@cpan.thiesenweb.de).

This package is free software and is provided "as is" without express or implied warranty. It may be used, redistributed and/or modified under the same terms as perl itself. ✨

---

okay bye bestie — the footer says perl v5.42.2 and 2023-07-03, so that’s the source/version and date, and this page is done. 🫶💖