1Prima::Const(3) User Contributed Perl Documentation Prima::Const(3)
2
6 Prima::Const - predefined constants
7
9 "Prima::Const" and Prima::Classes is a minimal set of perl modules
10 needed for the toolkit. Since the module provides bindings for the core
11 constants, it is required to be included in every Prima-related module
12 and program.
13 The constants are assembled under the top-level package names, with no
15 "Prima::" prefix. This violates the perl guidelines about package
16 naming, however, it was considered way too inconvenient to prefix every
17 constant with "Prima::" string.
18 This document provides description of all core-coded constants. The
20 constants are also described in the articles together with the
21 corresponding methods and properties. For example, "nt" constants are
22 also described in "Flow" in Prima::Object article.
23
25 am:: - Prima::Icon auto masking
26 See also "autoMasking" in Prima::Image
27 am::None - no mask update performed
29 am::MaskColor - mask update based on Prima::Icon::maskColor property
30 am::MaskIndex - mask update based on Prima::Icon::maskIndex property
31 am::Auto - mask update based on corner pixel values
32 apc:: - OS type
34 See "get_system_info" in Prima::Application
35 apc::Win32
37 apc::Unix
38 bi:: - border icons
40 See "borderIcons" in Prima::Window
41 bi::SystemMenu - system menu button and/or close button
43 ( usually with icon ) is shown
44 bi::Minimize - minimize button
45 bi::Maximize - maximize ( and eventual restore )
46 bi::TitleBar - window title
47 bi::All - all of the above
48 bs:: - border styles
50 See "borderStyle" in Prima::Window
51 bs::None - no border
53 bs::Single - thin border
54 bs::Dialog - thick border
55 bs::Sizeable - thick border with interactive resize capabilities
56 ci:: - color indices
58 See "colorIndex" in Prima::Widget
59 ci::NormalText or ci::Fore
61 ci::Normal or ci::Back
62 ci::HiliteText
63 ci::Hilite
64 ci::DisabledText
65 ci::Disabled
66 ci::Light3DColor
67 ci::Dark3DColor
68 ci::MaxId
69 cl:: - colors
71 See "colorIndex" in Prima::Widget
72 Direct color constants
74 cl::Black
75 cl::Blue
76 cl::Green
77 cl::Cyan
78 cl::Red
79 cl::Magenta
80 cl::Brown
81 cl::LightGray
82 cl::DarkGray
83 cl::LightBlue
84 cl::LightGreen
85 cl::LightCyan
86 cl::LightRed
87 cl::LightMagenta
88 cl::Yellow
89 cl::White
90 cl::Gray
91 Indirect color constants
93 cl::NormalText, cl::Fore
94 cl::Normal, cl::Back
95 cl::HiliteText
96 cl::Hilite
97 cl::DisabledText
98 cl::Disabled
99 cl::Light3DColor
100 cl::Dark3DColor
101 cl::MaxSysColor
102 Special constants
104 See "Colors" in Prima::gp_problems
105 cl::Set - logical all-1 color
107 cl::Clear - logical all-0 color
108 cl::Invalid - invalid color value
109 cl::SysFlag - indirect color constant bit set
110 cl::SysMask - indirect color constant bit clear mask
111 cm:: - commands
113 Keyboard and mouse commands
114 See "key_down" in Prima::Widget, "mouse_down" in Prima::Widget
115 cm::KeyDown
117 cm::KeyUp
118 cm::MouseDown
119 cm::MouseUp
120 cm::MouseClick
121 cm::MouseWheel
122 cm::MouseMove
123 cm::MouseEnter
124 cm::MouseLeave
125 Internal commands ( used in core only or not used at all )
127 cm::Close
128 cm::Create
129 cm::Destroy
130 cm::Hide
131 cm::Show
132 cm::ReceiveFocus
133 cm::ReleaseFocus
134 cm::Paint
135 cm::Repaint
136 cm::Size
137 cm::Move
138 cm::ColorChanged
139 cm::ZOrderChanged
140 cm::Enable
141 cm::Disable
142 cm::Activate
143 cm::Deactivate
144 cm::FontChanged
145 cm::WindowState
146 cm::Timer
147 cm::Click
148 cm::CalcBounds
149 cm::Post
150 cm::Popup
151 cm::Execute
152 cm::Setup
153 cm::Hint
154 cm::DragDrop
155 cm::DragOver
156 cm::EndDrag
157 cm::Menu
158 cm::EndModal
159 cm::MenuCmd
160 cm::TranslateAccel
161 cm::DelegateKey
162 cr:: - pointer cursor resources
164 See "pointerType" in Prima::Widget
165 cr::Default same pointer type as owner's
167 cr::Arrow arrow pointer
168 cr::Text text entry cursor-like pointer
169 cr::Wait hourglass
170 cr::Size general size action pointer
171 cr::Move general move action pointer
172 cr::SizeWest, cr::SizeW right-move action pointer
173 cr::SizeEast, cr::SizeE left-move action pointer
174 cr::SizeWE general horizontal-move action pointer
175 cr::SizeNorth, cr::SizeN up-move action pointer
176 cr::SizeSouth, cr::SizeS down-move action pointer
177 cr::SizeNS general vertical-move action pointer
178 cr::SizeNW up-right move action pointer
179 cr::SizeSE down-left move action pointer
180 cr::SizeNE up-left move action pointer
181 cr::SizeSW down-right move action pointer
182 cr::Invalid invalid action pointer
183 cr::User user-defined icon
184 dbt:: - device bitmap types
186 dbt::Bitmap monochrome 1 bit bitmap
187 dbt::Pixmap bitmap compatible with display format
188 dbt::Layered bitmap compatible with display format with alpha channel
189 dt:: - drive types
191 See "query_drive_type" in Prima::Utils
192 dt::None
194 dt::Unknown
195 dt::Floppy
196 dt::HDD
197 dt::Network
198 dt::CDROM
199 dt::Memory
200 dt:: - Prima::Drawable::draw_text constants
202 dt::Left - text is aligned to the left boundary
203 dt::Right - text is aligned to the right boundary
204 dt::Center - text is aligned horizontally in center
205 dt::Top - text is aligned to the upper boundary
206 dt::Bottom - text is aligned to the lower boundary
207 dt::VCenter - text is aligned vertically in center
208 dt::DrawMnemonic - tilde-escapement and underlining is used
209 dt::DrawSingleChar - sets tw::BreakSingle option to
210 Prima::Drawable::text_wrap call
211 dt::NewLineBreak - sets tw::NewLineBreak option to
212 Prima::Drawable::text_wrap call
213 dt::SpaceBreak - sets tw::SpaceBreak option to
214 Prima::Drawable::text_wrap call
215 dt::WordBreak - sets tw::WordBreak option to
216 Prima::Drawable::text_wrap call
217 dt::ExpandTabs - performs tab character ( \t ) expansion
218 dt::DrawPartial - draws the last line, if it is visible partially
219 dt::UseExternalLeading- text lines positioned vertically with respect to
220 the font external leading
221 dt::UseClip - assign ::clipRect property to the boundary rectangle
222 dt::QueryLinesDrawn - calculates and returns number of lines drawn
223 ( contrary to dt::QueryHeight )
224 dt::QueryHeight - if set, calculates and returns vertical extension
225 of the lines drawn
226 dt::NoWordWrap - performs no word wrapping by the width of the boundaries
227 dt::WordWrap - performs word wrapping by the width of the boundaries
228 dt::BidiText - use bidirectional formatting, if available
229 dt::Default - dt::NewLineBreak|dt::WordBreak|dt::ExpandTabs|
230 dt::UseExternalLeading
231 fdo:: - find / replace dialog options
233 See Prima::EditDialog
234 fdo::MatchCase
236 fdo::WordsOnly
237 fdo::RegularExpression
238 fdo::BackwardSearch
239 fdo::ReplacePrompt
240 fds:: - find / replace dialog scope type
242 See Prima::EditDialog
243 fds::Cursor
245 fds::Top
246 fds::Bottom
247 fe:: - file events constants
249 See Prima::File
250 fe::Read
252 fe::Write
253 fe::Exception
254 fp:: - standard fill pattern indices
256 See "fillPattern" in Prima::Drawable
257 fp::Empty
259 fp::Solid
260 fp::Line
261 fp::LtSlash
262 fp::Slash
263 fp::BkSlash
264 fp::LtBkSlash
265 fp::Hatch
266 fp::XHatch
267 fp::Interleave
268 fp::WideDot
269 fp::CloseDot
270 fp::SimpleDots
271 fp::Borland
272 fp::Parquet
273 fp:: - font pitches
275 See "pitch" in Prima::Drawable
276 fp::Default
278 fp::Fixed
279 fp::Variable
280 fr:: - fetch resource constants
282 See "fetch_resource" in Prima::Widget
283 fr::Color
285 fr::Font
286 fs::String
287 fs:: - font styles
289 See "style" in Prima::Drawable
290 fs::Normal
292 fs::Bold
293 fs::Thin
294 fs::Italic
295 fs::Underlined
296 fs::StruckOut
297 fs::Outline
298 fw:: - font weights
300 See "weight" in Prima::Drawable
301 fw::UltraLight
303 fw::ExtraLight
304 fw::Light
305 fw::SemiLight
306 fw::Medium
307 fw::SemiBold
308 fw::Bold
309 fw::ExtraBold
310 fw::UltraBold
311 gm:: - grow modes
313 See "growMode" in Prima::Widget
314 Basic constants
316 gm::GrowLoX widget's left side is kept in constant
317 distance from owner's right side
318 gm::GrowLoY widget's bottom side is kept in constant
319 distance from owner's top side
320 gm::GrowHiX widget's right side is kept in constant
321 distance from owner's right side
322 gm::GrowHiY widget's top side is kept in constant
323 distance from owner's top side
324 gm::XCenter widget is kept in center on its owner's
325 horizontal axis
326 gm::YCenter widget is kept in center on its owner's
327 vertical axis
328 gm::DontCare widgets origin is maintained constant relative
329 to the screen
330 Derived or aliased constants
332 gm::GrowAll gm::GrowLoX|gm::GrowLoY|gm::GrowHiX|gm::GrowHiY
333 gm::Center gm::XCenter|gm::YCenter
334 gm::Client gm::GrowHiX|gm::GrowHiY
335 gm::Right gm::GrowLoX|gm::GrowHiY
336 gm::Left gm::GrowHiY
337 gm::Floor gm::GrowHiX
338 gui:: - GUI types
340 See "get_system_info" in Prima::Application
341 gui::Default
343 gui::PM
344 gui::Windows
345 gui::XLib
346 gui::GTK2
347 le:: - line end styles
349 See "lineEnd" in Prima::Drawable
350 le::Flat
352 le::Square
353 le::Round
354 lj:: - line join styles
356 See "lineJoin" in Prima::Drawable
357 lj::Round
359 lj::Bevel
360 lj::Miter
361 lp:: - predefined line pattern styles
363 See "linePattern" in Prima::Drawable
364 lp::Null # "" /* */
366 lp::Solid # "\1" /* ___________ */
367 lp::Dash # "\x9\3" /* __ __ __ __ */
368 lp::LongDash # "\x16\6" /* _____ _____ */
369 lp::ShortDash # "\3\3" /* _ _ _ _ _ _ */
370 lp::Dot # "\1\3" /* . . . . . . */
371 lp::DotDot # "\1\1" /* ............ */
372 lp::DashDot # "\x9\6\1\3" /* _._._._._._ */
373 lp::DashDotDot # "\x9\3\1\3\1\3" /* _.._.._.._.. */
374 im:: - image types
376 See "type" in Prima::Image.
377 Bit depth constants
379 im::bpp1
380 im::bpp4
381 im::bpp8
382 im::bpp16
383 im::bpp24
384 im::bpp32
385 im::bpp64
386 im::bpp128
387 Pixel format constants
389 im::Color
390 im::GrayScale
391 im::RealNumber
392 im::ComplexNumber
393 im::TrigComplexNumber
394 im::SignedInt
395 Mnemonic image types
397 im::Mono - im::bpp1
398 im::BW - im::bpp1 | im::GrayScale
399 im::16 - im::bpp4
400 im::Nibble - im::bpp4
401 im::256 - im::bpp8
402 im::RGB - im::bpp24
403 im::Triple - im::bpp24
404 im::Byte - gray 8-bit unsigned integer
405 im::Short - gray 16-bit unsigned integer
406 im::Long - gray 32-bit unsigned integer
407 im::Float - float
408 im::Double - double
409 im::Complex - dual float
410 im::DComplex - dual double
411 im::TrigComplex - dual float
412 im::TrigDComplex - dual double
413 Extra formats
415 im::fmtBGR
416 im::fmtRGBI
417 im::fmtIRGB
418 im::fmtBGRI
419 im::fmtIBGR
420 Masks
422 im::BPP - bit depth constants
423 im::Category - category constants
424 im::FMT - extra format constants
425 ict:: - image conversion types
427 See "conversion" in Prima::Image.
428 ict::None - no dithering
430 ict::Ordered - 8x8 ordered halftone dithering
431 ict::ErrorDiffusion - error diffusion dithering with static palette
432 ict::Optimized - error diffusion dithering with optimized palette
433 is:: - image statistics indices
435 See "stats" in Prima::Image.
436 is::RangeLo - minimum pixel value
438 is::RangeHi - maximum pixel value
439 is::Mean - mean value
440 is::Variance - variance
441 is::StdDev - standard deviation
442 is::Sum - sum of pixel values
443 is::Sum2 - sum of squares of pixel values
444 kb:: - keyboard virtual codes
446 See also "KeyDown" in Prima::Widget.
447 Modificator keys
449 kb::ShiftL kb::ShiftR kb::CtrlL kb::CtrlR
450 kb::AltL kb::AltR kb::MetaL kb::MetaR
451 kb::SuperL kb::SuperR kb::HyperL kb::HyperR
452 kb::CapsLock kb::NumLock kb::ScrollLock kb::ShiftLock
453 Keys with character code defined
455 kb::Backspace kb::Tab kb::Linefeed kb::Enter
456 kb::Return kb::Escape kb::Esc kb::Space
457 Function keys
459 kb::F1 .. kb::F30
460 kb::L1 .. kb::L10
461 kb::R1 .. kb::R10
462 Other
464 kb::Clear kb::Pause kb::SysRq kb::SysReq
465 kb::Delete kb::Home kb::Left kb::Up
466 kb::Right kb::Down kb::PgUp kb::Prior
467 kb::PageUp kb::PgDn kb::Next kb::PageDown
468 kb::End kb::Begin kb::Select kb::Print
469 kb::PrintScr kb::Execute kb::Insert kb::Undo
470 kb::Redo kb::Menu kb::Find kb::Cancel
471 kb::Help kb::Break kb::BackTab
472 Masking constants
474 kb::CharMask - character codes
475 kb::CodeMask - virtual key codes ( all other kb:: values )
476 kb::ModMask - km:: values
477 km:: - keyboard modifiers
479 See also "KeyDown" in Prima::Widget.
480 km::Shift
482 km::Ctrl
483 km::Alt
484 km::KeyPad
485 km::DeadKey
486 km::Unicode
487 mt:: - modality types
489 See "get_modal" in Prima::Window, "get_modal_window" in Prima::Window
490 mt::None
492 mt::Shared
493 mt::Exclusive
494 nt:: - notification types
496 Used in "Prima::Component::notification_types" to describe event flow.
497 See also "Flow" in Prima::Object.
499 Starting point constants
501 nt::PrivateFirst
502 nt::CustomFirst
503 Direction constants
505 nt::FluxReverse
506 nt::FluxNormal
507 Complexity constants
509 nt::Single
510 nt::Multiple
511 nt::Event
512 Composite constants
514 nt::Default ( PrivateFirst | Multiple | FluxReverse)
515 nt::Property ( PrivateFirst | Single | FluxNormal )
516 nt::Request ( PrivateFirst | Event | FluxNormal )
517 nt::Notification ( CustomFirst | Multiple | FluxReverse )
518 nt::Action ( CustomFirst | Single | FluxReverse )
519 nt::Command ( CustomFirst | Event | FluxReverse )
520 mb:: - mouse buttons
522 See also "MouseDown" in Prima::Widget.
523 mb::b1 or mb::Left
525 mb::b2 or mb::Middle
526 mb::b3 or mb::Right
527 mb::b4
528 mb::b5
529 mb::b6
530 mb::b7
531 mb::b8
532 mb:: - message box constants
534 Message box and modal result button commands
535 See also "modalResult" in Prima::Window, "modalResult" in
536 Prima::Button.
537 mb::OK, mb::Ok
539 mb::Cancel
540 mb::Yes
541 mb::No
542 mb::Abort
543 mb::Retry
544 mb::Ignore
545 mb::Help
546 Message box composite ( multi-button ) constants
548 mb::OKCancel, mb::OkCancel
549 mb::YesNo
550 mb::YesNoCancel
551 Message box icon and bell constants
553 mb::Error
554 mb::Warning
555 mb::Information
556 mb::Question
557 ps:: - paint states
559 ps::Disabled - can neither draw, nor get/set graphical properties on an object
560 ps::Enabled - can both draw and get/set graphical properties on an object
561 ps::Information - can only get/set graphical properties on an object
562 For brevity, ps::Disabled is equal to 0 so this allows for simple
564 boolean testing whether one can get/set graphical properties on an
565 object.
566 See "get_paint_state" in Drawable.
568 rgn:: - result of Prima::Region.rect_inside
570 rgn::Inside
571 rgn::Outside - rectangle is fully outside the region
572 rgn::Partially
573 rgnop:: - Prima::Region.combine set operations
575 rgnop::Copy
576 rgnop::Intersect
577 rgnop::Union
578 rgnop::Xor
579 rgnop::Diff
580 rop:: - raster operation codes
582 See "Raster operations" in Prima::Drawable
583 rop::Blackness # = 0
585 rop::NotOr # = !(src | dest)
586 rop::NotSrcAnd # &= !src
587 rop::NotPut # = !src
588 rop::NotDestAnd # = !dest & src
589 rop::Invert # = !dest
590 rop::XorPut # ^= src
591 rop::NotAnd # = !(src & dest)
592 rop::AndPut # &= src
593 rop::NotXor # = !(src ^ dest)
594 rop::NotSrcXor # alias for rop::NotXor
595 rop::NotDestXor # alias for rop::NotXor
596 rop::NoOper # = dest
597 rop::NotSrcOr # |= !src
598 rop::CopyPut # = src
599 rop::NotDestOr # = !dest | src
600 rop::OrPut # |= src
601 rop::Whiteness # = 1
602 12 Porter-Duff operators
604 rop::Clear
606 rop::Xor
607 rop::SrcOver
608 rop::DstOver
609 rop::SrcCopy
610 rop::DstCopy
611 rop::SrcIn
612 rop::DstIn
613 rop::SrcOut
614 rop::DstOut
615 rop::SrcAtop
616 rop::DstAtop
617 rop::PorterDuffMask - masks out all bits but the constants above
619 Constant alpha flags
621 rop::SrcAlpha
623 rop::SrcAlphaShift
624 rop::DstAlpha
625 rop::DstAlphaShift
626 rop::ConstantAlpha
627 Others
629 rop::AlphaCopy
631 sbmp:: - system bitmaps indices
633 See also Prima::StdBitmap.
634 sbmp::Logo
636 sbmp::CheckBoxChecked
637 sbmp::CheckBoxCheckedPressed
638 sbmp::CheckBoxUnchecked
639 sbmp::CheckBoxUncheckedPressed
640 sbmp::RadioChecked
641 sbmp::RadioCheckedPressed
642 sbmp::RadioUnchecked
643 sbmp::RadioUncheckedPressed
644 sbmp::Warning
645 sbmp::Information
646 sbmp::Question
647 sbmp::OutlineCollapse
648 sbmp::OutlineExpand
649 sbmp::Error
650 sbmp::SysMenu
651 sbmp::SysMenuPressed
652 sbmp::Max
653 sbmp::MaxPressed
654 sbmp::Min
655 sbmp::MinPressed
656 sbmp::Restore
657 sbmp::RestorePressed
658 sbmp::Close
659 sbmp::ClosePressed
660 sbmp::Hide
661 sbmp::HidePressed
662 sbmp::DriveUnknown
663 sbmp::DriveFloppy
664 sbmp::DriveHDD
665 sbmp::DriveNetwork
666 sbmp::DriveCDROM
667 sbmp::DriveMemory
668 sbmp::GlyphOK
669 sbmp::GlyphCancel
670 sbmp::SFolderOpened
671 sbmp::SFolderClosed
672 sbmp::Last
673 sv:: - system value indices
675 See also "get_system_value" in Prima::Application
676 sv::YMenu - height of menu bar in top-level windows
678 sv::YTitleBar - height of title bar in top-level windows
679 sv::XIcon - width and height of main icon dimensions,
680 sv::YIcon acceptable by the system
681 sv::XSmallIcon - width and height of alternate icon dimensions,
682 sv::YSmallIcon acceptable by the system
683 sv::XPointer - width and height of mouse pointer icon
684 sv::YPointer acceptable by the system
685 sv::XScrollbar - width of the default vertical scrollbar
686 sv::YScrollbar - height of the default horizontal scrollbar
687 sv::XCursor - width of the system cursor
688 sv::AutoScrollFirst - the initial and the repetitive
689 sv::AutoScrollNext scroll timeouts
690 sv::InsertMode - the system insert mode
691 sv::XbsNone - widths and heights of the top-level window
692 sv::YbsNone decorations, correspondingly, with borderStyle
693 sv::XbsSizeable bs::None, bs::Sizeable, bs::Single, and
694 sv::YbsSizeable bs::Dialog.
695 sv::XbsSingle
696 sv::YbsSingle
697 sv::XbsDialog
698 sv::YbsDialog
699 sv::MousePresent - 1 if the mouse is present, 0 otherwise
700 sv::MouseButtons - number of the mouse buttons
701 sv::WheelPresent - 1 if the mouse wheel is present, 0 otherwise
702 sv::SubmenuDelay - timeout ( in ms ) before a sub-menu shows on
703 an implicit selection
704 sv::FullDrag - 1 if the top-level windows are dragged dynamically,
705 0 - with marquee mode
706 sv::DblClickDelay - mouse double-click timeout in milliseconds
707 sv::ShapeExtension - 1 if Prima::Widget::shape functionality is supported,
708 0 otherwise
709 sv::ColorPointer - 1 if system accepts color pointer icons.
710 sv::CanUTF8_Input - 1 if system can generate key codes in unicode
711 sv::CanUTF8_Output - 1 if system can output utf8 text
712 sv::CompositeDisplay - 1 if system uses double-buffering and alpha composition for the desktop,
713 0 if it doesn't, -1 if unknown
714 sv::LayeredWidgets - 1 if system supports layering
715 sv::DWM - 1 if system supports DWM API
716 ta:: - alignment constants
718 Used in: Prima::InputLine, Prima::ImageViewer, Prima::Label,
719 Prima::Terminals.
720 ta::Left
722 ta::Right
723 ta::Center
724 ta::Top
726 ta::Bottom
727 ta::Middle
728 tw:: - text wrapping constants
730 See "text_wrap" in Prima::Drawable
731 tw::CalcMnemonic - calculates tilde underline position
733 tw::CollapseTilde - removes escaping tilde from text
734 tw::CalcTabs - wraps text with respect to tab expansion
735 tw::ExpandTabs - expands tab characters
736 tw::BreakSingle - determines if text is broken to single
737 characters when text cannot be fit
738 tw::NewLineBreak - breaks line on newline characters
739 tw::SpaceBreak - breaks line on space or tab characters
740 tw::ReturnChunks - returns wrapped text chunks
741 tw::ReturnLines - returns positions and lengths of wrapped
742 text chunks
743 tw::WordBreak - defines if text break by width goes by the
744 characters or by the words
745 tw::ReturnFirstLineLength - returns length of the first wrapped line
746 tw::Default - tw::NewLineBreak | tw::CalcTabs | tw::ExpandTabs |
747 tw::ReturnLines | tw::WordBreak
748 wc:: - widget classes
750 See "widgetClass" in Prima::Widget
751 wc::Undef
753 wc::Button
754 wc::CheckBox
755 wc::Combo
756 wc::Dialog
757 wc::Edit
758 wc::InputLine
759 wc::Label
760 wc::ListBox
761 wc::Menu
762 wc::Popup
763 wc::Radio
764 wc::ScrollBar
765 wc::Slider
766 wc::Widget, wc::Custom
767 wc::Window
768 wc::Application
769 ws:: - window states
771 See "windowState" in Prima::Window
772 ws::Normal
774 ws::Minimized
775 ws::Maximized
776
778 Dmitry Karasik, <dmitry@karasik.eu.org>.
779
781 Prima, Prima::Classes
782perl v5.28.0 2017-03-13 Prima::Const(3)