prima::label(3) [debian man page]
Prima::Label(3) User Contributed Perl Documentation Prima::Label(3) NAME
Prima::Label - static text widget DESCRIPTION
The class is designed for display of text, and assumes no user interaction. The text output capabilities include wrapping, horizontal and vertical alignment, and automatic widget resizing to match text extension. If text contains a tilde-escaped ( hot ) character, the label can explicitly focus the specified widget upon press of the character key, what feature is useful for dialog design. SYNOPSIS
my $label = Prima::Label-> create( text => 'Enter ~name:', focusLink => $name_inputline, alignment => ta::Center, ); API
Properties alignment INTEGER One of the following "ta::XXX" constants: ta::Left ta::Center ta::Right Selects the horizontal text alignment. Default value: "ta::Left" autoHeight BOOLEAN If 1, the widget height is automatically changed as text extensions change. Default value: 0 autoWidth BOOLEAN If 1, the widget width is automatically changed as text extensions change. Default value: 1 focusLink WIDGET Points to a widget, which is explicitly focused when the user presses the combination of a hot key with the "Alt" key. Prima::Label does not provide a separate property to access the hot key value, however it can be read from the "{accel}" variable. Default value: "undef". showAccelChar BOOLEAN If 0, the tilde ( ~ ) character is collapsed from the text, and the hot character is underlined. When the user presses combination of the escaped character with the "Alt" key, the "focusLink" widget is explicitly focused. If 1, the text is showed as is, and no hot character is underlined. Key combinations with "Alt" key are not recognized. Default value: 0 showPartial BOOLEAN Used to determine if the last line of text should be drawn if it can not be vertically fit in the widget interior. If 1, the last line is shown even if not visible in full. If 0, only full lines are drawn. Default value: 1 wordWrap BOOLEAN If 1, the text is wrapped if it can not be horizontally fit in the widget interior. If 0, the text is not wrapped unless new line characters are present in the text. New line characters signal line wrapping with no respect to "wordWrap" property value. Default value: 0 valignment INTEGER One of the following "ta::XXX" constants: ta::Top ta::Middle or ta::Center ta::Bottom Selects the vertical text alignment. NB: "ta::Middle" value is not equal to "ta::Center"'s, however the both constants produce equal effect here. Default value: "ta::Top" AUTHOR
Dmitry Karasik, <dmitry@karasik.eu.org>. SEE ALSO
Prima, Prima::Widget, examples/label.pl perl v5.14.2 2009-02-24 Prima::Label(3)
Check Out this Related Man Page
Prima::InputLine(3) User Contributed Perl Documentation Prima::InputLine(3) NAME
Prima::InputLine - standard input line widget DESCRIPTION
The class provides basic functionality of an input line, including hidden input, read-only state, selection, and clipboard operations. The input line text data is contained in text property. API
Events Change The notification is called when the text property is changed, either interactively or as a result of direct call. Properties alignment INTEGER One of the following "ta::" constants, defining the text alignment: ta::Left ta::Right ta::Center Default value: "ta::Left" autoHeight BOOLEAN If 1, adjusts the height of the widget automatically when its font changes. Default value: 1 autoSelect BOOLEAN If 1, all the text is selected when the widget becomes focused. Default value: 1 autoTab BOOLEAN If 1, the keyboard "kb::Left" and "kb::Right" commands, if received when the cursor is at the beginning or at the end of text, and cannot be mover farther, not processed. The result of this is that the default handler moves focus to a neighbor widget, in a way as if the Tab key was pressed. Default value: 0 borderWidth INTEGER Width of 3d-shade border around the widget. Default value: 2 charOffset INTEGER Selects the position of the cursor in characters starting from the beginning of text. firstChar Selects the first visible character of text insertMode BOOLEAN Governs the typing mode - if 1, the typed text is inserted, if 0, the text overwrites the old text. When "insertMode" is 0, the cursor shape is thick and covers the whole character; when 1, it is of default width. Default toggle key: Insert maxLen INTEGER The maximal length of the text, that can be stored into text or typed by the user. Default value: 256 passwordChar CHARACTER A character to be shown instead of the text letters when writeOnly property value is 1. Default value: '*' readOnly BOOLEAN If 1, the text cannot be edited by the user. Default value: 0 selection START, END Two integers, specifying the beginning and the end of the selected text. A case with no selection is when START equals END. selStart INTEGER Selects the start of text selection. selEnd INTEGER Selects the end of text selection. textRef SCALAR_REF If not undef, contains reference to the scalar that holds the text of the input line. All changes to ::text property are reflected there. The direct write access to the scalar is not recommended because it leaves internal structures inconsistent, and the only way to synchronize structures is to set-call either ::textRef or ::text after every such change. If undef, the internal text container is used. Default value: undef wordDelimiters STRING Contains string of character that are used for locating a word break. Default STRING value consists of punctuation marks, space and tab characters, and "xff" character. writeOnly BOOLEAN If 1, the input is not shown but mapped to passwordChar characters. Useful for a password entry. Default value: 0 Methods copy Copies the selected text, if any, to the clipboard. Default key: Ctrl+Insert cut Cuts the selected text into the clipboard. Default key: Shift+Delete delete Removes the selected text. Default key: Delete paste Copies text from the clipboard and inserts it in the cursor position. Default key: Shift+Insert select_all Selects all text AUTHOR
Dmitry Karasik, <dmitry@karasik.eu.org>. SEE ALSO
Prima, Prima::Widget, examples/edit.pl. perl v5.14.2 2009-02-24 Prima::InputLine(3)