1Prima::Const(3)       User Contributed Perl Documentation      Prima::Const(3)
2
3
4

NAME

6       Prima::Const - predefined constants
7

DESCRIPTION

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
14       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
19       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

API

25   am::  - Prima::Icon auto masking
26       See also "autoMasking" in Prima::Image
27
28               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
33   apc:: - OS type
34       See "get_system_info" in Prima::Application
35
36               apc::Win32
37               apc::Unix
38
39   bi::  - border icons
40       See "borderIcons" in Prima::Window
41
42               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
49   bs::  - border styles
50       See "borderStyle" in Prima::Window
51
52               bs::None      - no border
53               bs::Single    - thin border
54               bs::Dialog    - thick border
55               bs::Sizeable  - thick border with interactive resize capabilities
56
57   ci::  - color indices
58       See "colorIndex" in Prima::Widget
59
60               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
70   cl:: - colors
71       See "colorIndex" in Prima::Widget
72
73       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
92       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
103       Special constants
104           See "Colors" in Prima::gp_problems
105
106                   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
112   cm::  - commands
113       Keyboard and mouse commands
114           See "key_down" in Prima::Widget, "mouse_down" in Prima::Widget
115
116                   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
126       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
163   cr::  - pointer cursor resources
164       See "pointerType" in Prima::Widget
165
166               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::DragNone                pointer for an invalid dragging target
184               cr::DragCopy                pointer to show that a dnd::Copy action can be accepted
185               cr::DragMove                pointer to show that a dnd::Move action can be accepted
186               cr::DragLink                pointer to show that a dnd::Link action can be accepted
187               cr::User                    user-defined icon
188
189   dbt::  - device bitmap types
190               dbt::Bitmap                 monochrome 1 bit bitmap
191               dbt::Pixmap                 bitmap compatible with display format
192               dbt::Layered                bitmap compatible with display format with alpha channel
193
194   dnd::  - drag and drop action constants and functions
195               dnd::None                   no DND action was selected or performed
196               dnd::Copy                   copy action
197               dnd::Move                   move action
198               dnd::Link                   link action
199               dnd::Mask                   combination of all valid actions
200
201       is_one_action ACTIONS
202           Returns true if "ACTIONS" is not a combination of "dnd::"
203           constants.
204
205       pointer ACTION
206           Returns a "cr::" constant corresponding to the "ACTION"
207
208       to_one_action ACTIONS
209           Selects a best single action from combination of allowes "ACTIONS"
210
211       keymod ACTION
212           Returns a "km::" keyboard modifier constant the "ACTION" will be
213           selected, when possible, if the user presses that modifier. Return
214           0 for "dnd::Copy" that is a standard action to be performed without
215           any modifiers.
216
217   dt::  - drive types
218       See "query_drive_type" in Prima::Utils
219
220               dt::None
221               dt::Unknown
222               dt::Floppy
223               dt::HDD
224               dt::Network
225               dt::CDROM
226               dt::Memory
227
228   dt::  - Prima::Drawable::draw_text constants
229               dt::Left              - text is aligned to the left boundary
230               dt::Right             - text is aligned to the right boundary
231               dt::Center            - text is aligned horizontally in center
232               dt::Top               - text is aligned to the upper boundary
233               dt::Bottom            - text is aligned to the lower boundary
234               dt::VCenter           - text is aligned vertically in center
235               dt::DrawMnemonic      - tilde-escapement and underlining is used
236               dt::DrawSingleChar    - sets tw::BreakSingle option to
237                                       Prima::Drawable::text_wrap call
238               dt::NewLineBreak      - sets tw::NewLineBreak option to
239                                       Prima::Drawable::text_wrap call
240               dt::SpaceBreak        - sets tw::SpaceBreak option to
241                                       Prima::Drawable::text_wrap call
242               dt::WordBreak         - sets tw::WordBreak option to
243                                       Prima::Drawable::text_wrap call
244               dt::ExpandTabs        - performs tab character ( \t ) expansion
245               dt::DrawPartial       - draws the last line, if it is visible partially
246               dt::UseExternalLeading- text lines positioned vertically with respect to
247                                       the font external leading
248               dt::UseClip           - assign ::clipRect property to the boundary rectangle
249               dt::QueryLinesDrawn   - calculates and returns number of lines drawn
250                                       ( contrary to dt::QueryHeight )
251               dt::QueryHeight       - if set, calculates and returns vertical extension
252                                       of the lines drawn
253               dt::NoWordWrap        - performs no word wrapping by the width of the boundaries
254               dt::WordWrap          - performs word wrapping by the width of the boundaries
255               dt::Default           - dt::NewLineBreak|dt::WordBreak|dt::ExpandTabs|
256                                       dt::UseExternalLeading
257
258   fdo:: - find / replace dialog options
259       See Prima::FindDialog
260
261               fdo::MatchCase
262               fdo::WordsOnly
263               fdo::RegularExpression
264               fdo::BackwardSearch
265               fdo::ReplacePrompt
266
267   fds:: - find / replace dialog scope type
268       See Prima::FindDialog
269
270               fds::Cursor
271               fds::Top
272               fds::Bottom
273
274   fe::  - file events constants
275       See Prima::File
276
277               fe::Read
278               fe::Write
279               fe::Exception
280
281   fm::  - fill modes
282       See "fillMode" in Prima::Drawable
283
284               fp::Alternate
285               fp::Winding
286               fp::Overlay
287
288   fp::  - standard fill pattern indices
289       See "fillPattern" in Prima::Drawable
290
291               fp::Empty
292               fp::Solid
293               fp::Line
294               fp::LtSlash
295               fp::Slash
296               fp::BkSlash
297               fp::LtBkSlash
298               fp::Hatch
299               fp::XHatch
300               fp::Interleave
301               fp::WideDot
302               fp::CloseDot
303               fp::SimpleDots
304               fp::Borland
305               fp::Parquet
306
307   fp::  - font pitches
308       See "pitch" in Prima::Drawable
309
310               fp::Default
311               fp::Fixed
312               fp::Variable
313
314   fr::  - fetch resource constants
315       See "fetch_resource" in Prima::Widget
316
317               fr::Color
318               fr::Font
319               fs::String
320
321   fs::  - font styles
322       See "style" in Prima::Drawable
323
324               fs::Normal
325               fs::Bold
326               fs::Thin
327               fs::Italic
328               fs::Underlined
329               fs::StruckOut
330               fs::Outline
331
332   fw::  - font weights
333       See "weight" in Prima::Drawable
334
335               fw::UltraLight
336               fw::ExtraLight
337               fw::Light
338               fw::SemiLight
339               fw::Medium
340               fw::SemiBold
341               fw::Bold
342               fw::ExtraBold
343               fw::UltraBold
344
345   ggo::  - glyph outline commands
346               ggo::Move
347               ggo::Line
348               ggo::Conic
349               ggo::Cubic
350
351       See also "render_glyph" in Prima::Drawable
352
353   gm::  - grow modes
354       See "growMode" in Prima::Widget
355
356       Basic constants
357                   gm::GrowLoX     widget's left side is kept in constant
358                                   distance from owner's right side
359                   gm::GrowLoY     widget's bottom side is kept in constant
360                                   distance from owner's top side
361                   gm::GrowHiX     widget's right side is kept in constant
362                                   distance from owner's right side
363                   gm::GrowHiY     widget's top side is kept in constant
364                                   distance from owner's top side
365                   gm::XCenter     widget is kept in center on its owner's
366                                   horizontal axis
367                   gm::YCenter     widget is kept in center on its owner's
368                                   vertical axis
369                   gm::DontCare    widgets origin is maintained constant relative
370                                   to the screen
371
372       Derived or aliased constants
373                   gm::GrowAll      gm::GrowLoX|gm::GrowLoY|gm::GrowHiX|gm::GrowHiY
374                   gm::Center       gm::XCenter|gm::YCenter
375                   gm::Client       gm::GrowHiX|gm::GrowHiY
376                   gm::Right        gm::GrowLoX|gm::GrowHiY
377                   gm::Left         gm::GrowHiY
378                   gm::Floor        gm::GrowHiX
379
380   gui:: - GUI types
381       See "get_system_info" in Prima::Application
382
383               gui::Default
384               gui::PM
385               gui::Windows
386               gui::XLib
387               gui::GTK
388
389   le::  - line end styles
390       See "lineEnd" in Prima::Drawable
391
392               le::Flat
393               le::Square
394               le::Round
395
396   lj::  - line join styles
397       See "lineJoin" in Prima::Drawable
398
399               lj::Round
400               lj::Bevel
401               lj::Miter
402
403   lp::  - predefined line pattern styles
404       See "linePattern" in Prima::Drawable
405
406               lp::Null           #    ""              /*              */
407               lp::Solid          #    "\1"            /* ___________  */
408               lp::Dash           #    "\x9\3"         /* __ __ __ __  */
409               lp::LongDash       #    "\x16\6"        /* _____ _____  */
410               lp::ShortDash      #    "\3\3"          /* _ _ _ _ _ _  */
411               lp::Dot            #    "\1\3"          /* . . . . . .  */
412               lp::DotDot         #    "\1\1"          /* ............ */
413               lp::DashDot        #    "\x9\6\1\3"     /* _._._._._._  */
414               lp::DashDotDot     #    "\x9\3\1\3\1\3" /* _.._.._.._.. */
415
416   im::  - image types
417       See "type" in Prima::Image.
418
419       Bit depth constants
420                   im::bpp1
421                   im::bpp4
422                   im::bpp8
423                   im::bpp16
424                   im::bpp24
425                   im::bpp32
426                   im::bpp64
427                   im::bpp128
428
429       Pixel format constants
430                   im::Color
431                   im::GrayScale
432                   im::RealNumber
433                   im::ComplexNumber
434                   im::TrigComplexNumber
435                   im::SignedInt
436
437       Mnemonic image types
438                   im::Mono          - im::bpp1
439                   im::BW            - im::bpp1 | im::GrayScale
440                   im::16            - im::bpp4
441                   im::Nibble        - im::bpp4
442                   im::256           - im::bpp8
443                   im::RGB           - im::bpp24
444                   im::Triple        - im::bpp24
445                   im::Byte          - gray 8-bit unsigned integer
446                   im::Short         - gray 16-bit unsigned integer
447                   im::Long          - gray 32-bit unsigned integer
448                   im::Float         - float
449                   im::Double        - double
450                   im::Complex       - dual float
451                   im::DComplex      - dual double
452                   im::TrigComplex   - dual float
453                   im::TrigDComplex  - dual double
454
455       Extra formats
456                   im::fmtBGR
457                   im::fmtRGBI
458                   im::fmtIRGB
459                   im::fmtBGRI
460                   im::fmtIBGR
461
462       Masks
463                   im::BPP      - bit depth constants
464                   im::Category - category constants
465                   im::FMT      - extra format constants
466
467   ict:: - image conversion types
468       See "conversion" in Prima::Image.
469
470               ict::None            - no dithering, with static palette or palette optimized by source palette
471               ict::Posterization   - no dithering, with optimized palette by source pixels
472               ict::Ordered         - 8x8 ordered halftone dithering
473               ict::ErrorDiffusion  - error diffusion dithering with static palette
474               ict::Optimized       - error diffusion dithering with optimized palette
475
476       Their values are combinations of "ictp::" and "ictd::" constants, see
477       below.
478
479   ictd:: - image conversion types, dithering
480       These constants select color correction (dithering) algorithm when
481       downsampling an image
482
483               ictd::None            - no dithering, pure colors only
484               ictd::Ordered         - 8x8 ordered halftone dithering (checkerboard)
485               ictd::ErrorDiffusion  - error diffusion dithering (2/5 down, 2/5 right, 1/5 down/right)
486
487   ictp:: - image conversion types, palette optimization
488       These constants select how the target palette is made up when
489       downsampling an image.
490
491               ictp::Unoptimized  - use whatever color mapping method is fastest,
492                                    image quality can be severely compromized
493               ictp::Cubic        - use static cubic palette; a bit slower,
494                                    guaranteed mediocre quality
495               ictp::Optimized    - collect available colors in the image;
496                                    slowest, gives best results
497
498       Not all combination of ictp and ictd constants are valid
499
500   is::  - image statistics indices
501       See "stats" in Prima::Image.
502
503               is::RangeLo  - minimum pixel value
504               is::RangeHi  - maximum pixel value
505               is::Mean     - mean value
506               is::Variance - variance
507               is::StdDev   - standard deviation
508               is::Sum      - sum of pixel values
509               is::Sum2     - sum of squares of pixel values
510
511   kb::  - keyboard virtual codes
512       See also "KeyDown" in Prima::Widget.
513
514       Modificator keys
515                   kb::ShiftL   kb::ShiftR   kb::CtrlL      kb::CtrlR
516                   kb::AltL     kb::AltR     kb::MetaL      kb::MetaR
517                   kb::SuperL   kb::SuperR   kb::HyperL     kb::HyperR
518                   kb::CapsLock kb::NumLock  kb::ScrollLock kb::ShiftLock
519
520       Keys with character code defined
521                   kb::Backspace  kb::Tab    kb::Linefeed   kb::Enter
522                   kb::Return     kb::Escape kb::Esc        kb::Space
523
524       Function keys
525                   kb::F1 .. kb::F30
526                   kb::L1 .. kb::L10
527                   kb::R1 .. kb::R10
528
529       Other
530                   kb::Clear    kb::Pause   kb::SysRq  kb::SysReq
531                   kb::Delete   kb::Home    kb::Left   kb::Up
532                   kb::Right    kb::Down    kb::PgUp   kb::Prior
533                   kb::PageUp   kb::PgDn    kb::Next   kb::PageDown
534                   kb::End      kb::Begin   kb::Select kb::Print
535                   kb::PrintScr kb::Execute kb::Insert kb::Undo
536                   kb::Redo     kb::Menu    kb::Find   kb::Cancel
537                   kb::Help     kb::Break   kb::BackTab
538
539       Masking constants
540                   kb::CharMask - character codes
541                   kb::CodeMask - virtual key codes ( all other kb:: values )
542                   kb::ModMask  - km:: values
543
544   km::  - keyboard modifiers
545       See also "KeyDown" in Prima::Widget.
546
547               km::Shift
548               km::Ctrl
549               km::Alt
550               km::KeyPad
551               km::DeadKey
552               km::Unicode
553
554   mt:: - modality types
555       See "get_modal" in Prima::Window, "get_modal_window" in Prima::Window
556
557               mt::None
558               mt::Shared
559               mt::Exclusive
560
561   nt::  - notification types
562       Used in "Prima::Component::notification_types" to describe event flow.
563
564       See also "Flow" in Prima::Object.
565
566       Starting point constants
567                   nt::PrivateFirst
568                   nt::CustomFirst
569
570       Direction constants
571                   nt::FluxReverse
572                   nt::FluxNormal
573
574       Complexity constants
575                   nt::Single
576                   nt::Multiple
577                   nt::Event
578
579       Composite constants
580                   nt::Default       ( PrivateFirst | Multiple | FluxReverse)
581                   nt::Property      ( PrivateFirst | Single   | FluxNormal )
582                   nt::Request       ( PrivateFirst | Event    | FluxNormal )
583                   nt::Notification  ( CustomFirst  | Multiple | FluxReverse )
584                   nt::Action        ( CustomFirst  | Single   | FluxReverse )
585                   nt::Command       ( CustomFirst  | Event    | FluxReverse )
586
587   mb::  - mouse buttons
588       See also "MouseDown" in Prima::Widget.
589
590               mb::b1 or mb::Left
591               mb::b2 or mb::Middle
592               mb::b3 or mb::Right
593               mb::b4
594               mb::b5
595               mb::b6
596               mb::b7
597               mb::b8
598
599   mb:: - message box constants
600       Message box and modal result button commands
601           See also "modalResult" in Prima::Window, "modalResult" in
602           Prima::Button.
603
604                   mb::OK, mb::Ok
605                   mb::Cancel
606                   mb::Yes
607                   mb::No
608                   mb::Abort
609                   mb::Retry
610                   mb::Ignore
611                   mb::Help
612
613       Message box composite ( multi-button ) constants
614                   mb::OKCancel, mb::OkCancel
615                   mb::YesNo
616                   mb::YesNoCancel
617                   mb::ChangeAll
618
619       Message box icon and bell constants
620                   mb::Error
621                   mb::Warning
622                   mb::Information
623                   mb::Question
624
625   ps:: - paint states
626               ps::Disabled    - can neither draw, nor get/set graphical properties on an object
627               ps::Enabled     - can both draw and get/set graphical properties on an object
628               ps::Information - can only get/set graphical properties on an object
629
630       For brevity, ps::Disabled is equal to 0 so this allows for simple
631       boolean testing whether one can get/set graphical properties on an
632       object.
633
634       See "get_paint_state" in Drawable.
635
636   rgn:: - result of Prima::Region.rect_inside
637               rgn::Inside
638               rgn::Outside    - rectangle is fully outside the region
639               rgn::Partially
640
641   rgnop:: - Prima::Region.combine set operations
642               rgnop::Copy
643               rgnop::Intersect
644               rgnop::Union
645               rgnop::Xor
646               rgnop::Diff
647
648   rop:: - raster operation codes
649       See "Raster operations" in Prima::Drawable
650
651               rop::Blackness      #   = 0
652               rop::NotOr          #   = !(src | dest)
653               rop::NotSrcAnd      #  &= !src
654               rop::NotPut         #   = !src
655               rop::NotDestAnd     #   = !dest & src
656               rop::Invert         #   = !dest
657               rop::XorPut         #  ^= src
658               rop::NotAnd         #   = !(src & dest)
659               rop::AndPut         #  &= src
660               rop::NotXor         #   = !(src ^ dest)
661               rop::NotSrcXor      #     alias for rop::NotXor
662               rop::NotDestXor     #     alias for rop::NotXor
663               rop::NoOper         #   = dest
664               rop::NotSrcOr       #  |= !src
665               rop::CopyPut        #   = src
666               rop::NotDestOr      #   = !dest | src
667               rop::OrPut          #  |= src
668               rop::Whiteness      #   = 1
669
670       12 Porter-Duff operators
671
672               rop::Clear       # = 0
673               rop::Xor         # = src ( 1 - dstA ) + dst ( 1 - srcA )
674               rop::SrcOver     # = src + dst (1 - srcA)
675               rop::DstOver     # = dst + src (1 - dstA)
676               rop::SrcCopy     # = src
677               rop::DstCopy     # = dst
678               rop::SrcIn       # = src dstA
679               rop::DstIn       # = dst srcA
680               rop::SrcOut      # = src ( 1 - dstA )
681               rop::DstOut      # = dst ( 1 - srcA )
682               rop::SrcAtop     # = src dstA + dst ( 1 - srcA )
683               rop::DstAtop     # = dst srcA + src ( 1 - dstA )
684
685               rop::PorterDuffMask - masks out all bits but the constants above
686
687       Photoshop operators
688
689               rop::Add
690               rop::Multiply
691               rop::Screen
692               rop::Overlay
693               rop::Darken
694               rop::Lighten
695               rop::ColorDodge
696               rop::ColorBurn
697               rop::HardLight
698               rop::SoftLight
699               rop::Difference
700               rop::Exclusion
701
702       Constant alpha flags
703
704               rop::SrcAlpha
705               rop::SrcAlphaShift
706               rop::DstAlpha
707               rop::DstAlphaShift
708               rop::ConstantAlpha
709
710       Others
711
712               rop::AlphaCopy
713
714   sbmp:: - system bitmaps indices
715       See also Prima::StdBitmap.
716
717               sbmp::Logo
718               sbmp::CheckBoxChecked
719               sbmp::CheckBoxCheckedPressed
720               sbmp::CheckBoxUnchecked
721               sbmp::CheckBoxUncheckedPressed
722               sbmp::RadioChecked
723               sbmp::RadioCheckedPressed
724               sbmp::RadioUnchecked
725               sbmp::RadioUncheckedPressed
726               sbmp::Warning
727               sbmp::Information
728               sbmp::Question
729               sbmp::OutlineCollapse
730               sbmp::OutlineExpand
731               sbmp::Error
732               sbmp::SysMenu
733               sbmp::SysMenuPressed
734               sbmp::Max
735               sbmp::MaxPressed
736               sbmp::Min
737               sbmp::MinPressed
738               sbmp::Restore
739               sbmp::RestorePressed
740               sbmp::Close
741               sbmp::ClosePressed
742               sbmp::Hide
743               sbmp::HidePressed
744               sbmp::DriveUnknown
745               sbmp::DriveFloppy
746               sbmp::DriveHDD
747               sbmp::DriveNetwork
748               sbmp::DriveCDROM
749               sbmp::DriveMemory
750               sbmp::GlyphOK
751               sbmp::GlyphCancel
752               sbmp::SFolderOpened
753               sbmp::SFolderClosed
754               sbmp::Last
755
756   scr:: - scroll exposure results
757       "Widget::scroll" returns one of these.
758
759               scr::Error           - failure
760               scr::NoExpose        - call resulted in no new exposed areas
761               scr::Expose          - call resulted in new exposed areas, expect a repaint
762
763   sv::  - system value indices
764       See also "get_system_value" in Prima::Application
765
766               sv::YMenu            - height of menu bar in top-level windows
767               sv::YTitleBar        - height of title bar in top-level windows
768               sv::XIcon            - width and height of main icon dimensions,
769               sv::YIcon              acceptable by the system
770               sv::XSmallIcon       - width and height of alternate icon dimensions,
771               sv::YSmallIcon         acceptable by the system
772               sv::XPointer         - width and height of mouse pointer icon
773               sv::YPointer           acceptable by the system
774               sv::XScrollbar       - width of the default vertical scrollbar
775               sv::YScrollbar       - height of the default horizontal scrollbar
776               sv::XCursor          - width of the system cursor
777               sv::AutoScrollFirst  - the initial and the repetitive
778               sv::AutoScrollNext     scroll timeouts
779               sv::InsertMode       - the system insert mode
780               sv::XbsNone          - widths and heights of the top-level window
781               sv::YbsNone            decorations, correspondingly, with borderStyle
782               sv::XbsSizeable        bs::None, bs::Sizeable, bs::Single, and
783               sv::YbsSizeable        bs::Dialog.
784               sv::XbsSingle
785               sv::YbsSingle
786               sv::XbsDialog
787               sv::YbsDialog
788               sv::MousePresent     - 1 if the mouse is present, 0 otherwise
789               sv::MouseButtons     - number of the mouse buttons
790               sv::WheelPresent     - 1 if the mouse wheel is present, 0 otherwise
791               sv::SubmenuDelay     - timeout ( in ms ) before a sub-menu shows on
792                                       an implicit selection
793               sv::FullDrag         - 1 if the top-level windows are dragged dynamically,
794                                      0 - with marquee mode
795               sv::DblClickDelay    - mouse double-click timeout in milliseconds
796               sv::ShapeExtension   - 1 if Prima::Widget::shape functionality is supported,
797                                      0 otherwise
798               sv::ColorPointer     - 1 if system accepts color pointer icons.
799               sv::CanUTF8_Input    - 1 if system can generate key codes in unicode
800               sv::CanUTF8_Output   - 1 if system can output utf8 text
801               sv::CompositeDisplay - 1 if system uses double-buffering and alpha composition for the desktop,
802                                      0 if it doesn't, -1 if unknown
803               sv::LayeredWidgets   - 1 if system supports layering
804               sv::DWM              - 1 if system supports DWM API
805               sv::FixedPointerSize - 0 if system doesn't support arbitrary sized pointers and will resize custom icons to the system size
806               sv::MenuCheckSize    - width and height of default menu check icon
807               sv::FriBidi          - 1 if Prima is compiled with libfribidi and full bidi unicode support is available
808
809   ta::  - alignment constants
810       Used in: Prima::InputLine, Prima::ImageViewer, Prima::Label.
811
812               ta::Left
813               ta::Right
814               ta::Center
815
816               ta::Top
817               ta::Bottom
818               ta::Middle
819
820   to::  - text output constants
821       These constants are used in various text and glyph related functions,
822       and form a somewhat vague group of bit values that may or may not be
823       used together depending on the function
824
825               to::Plain         - default value, 0
826               to::AddOverhangs  - used in C<get_text_width> and C<get_text_shape_width>
827                                   to request text overhangs to be included in the returned
828                                   text width
829               to::Glyphs        - used in C<get_font_abc> and C<get_font_def> to select extension of
830                                   glyph indexes rather than text codepoints
831               to::Unicode       - used in C<get_font_abc> and C<get_font_def> to select extension of
832                                   unicode rather than ascii text codepoints
833               to::RTL           - used in C<get_text_shape_width> to request RTL bidi direction.
834                                   Also used in C<Prima::Drawable::Glyphs::indexes> values to mark
835                                   RTL characters.
836
837   tw::  - text wrapping constants
838       See "text_wrap" in Prima::Drawable
839
840               tw::CalcMnemonic          - calculates tilde underline position
841               tw::CollapseTilde         - removes escaping tilde from text
842               tw::CalcTabs              - wraps text with respect to tab expansion
843               tw::ExpandTabs            - expands tab characters
844               tw::BreakSingle           - determines if text is broken to single
845                                           characters when text cannot be fit
846               tw::NewLineBreak          - breaks line on newline characters
847               tw::SpaceBreak            - breaks line on space or tab characters
848               tw::ReturnChunks          - returns wrapped text chunks
849               tw::ReturnLines           - returns positions and lengths of wrapped
850                                           text chunks
851               tw::WordBreak             - defines if text break by width goes by the
852                                           characters or by the words
853               tw::ReturnFirstLineLength - returns length of the first wrapped line
854               tw::Default               - tw::NewLineBreak | tw::CalcTabs | tw::ExpandTabs |
855                                           tw::ReturnLines | tw::WordBreak
856
857   wc::  - widget classes
858       See "widgetClass" in Prima::Widget
859
860               wc::Undef
861               wc::Button
862               wc::CheckBox
863               wc::Combo
864               wc::Dialog
865               wc::Edit
866               wc::InputLine
867               wc::Label
868               wc::ListBox
869               wc::Menu
870               wc::Popup
871               wc::Radio
872               wc::ScrollBar
873               wc::Slider
874               wc::Widget, wc::Custom
875               wc::Window
876               wc::Application
877
878   ws::  - window states
879       See "windowState" in Prima::Window
880
881               ws::Normal
882               ws::Minimized
883               ws::Maximized
884

AUTHOR

886       Dmitry Karasik, <dmitry@karasik.eu.org>.
887

SEE ALSO

889       Prima, Prima::Classes
890
891
892
893perl v5.32.1                      2021-01-27                   Prima::Const(3)
Impressum