|
NAMEPrima::Const - predefined constantsDESCRIPTION"Prima::Const" and Prima::Classes is a minimal set of perl modules needed for the toolkit. Since the module provides bindings for the core constants, it is required to be included in every Prima-related module and program.The constants are assembled under the top-level package names, with no "Prima::" prefix. This violates the perl guidelines about package naming, however, it was considered way too inconvenient to prefix every constant with "Prima::" string. This document provides description of all core-coded constants. The constants are also described in the articles together with the corresponding methods and properties. For example, "nt" constants are also described in "Flow" in Prima::Object article. APIam:: - Prima::Icon auto maskingSee also "autoMasking" in Prima::Imageam::None - no mask update performed am::MaskColor - mask update based on Prima::Icon::maskColor property am::MaskIndex - mask update based on Prima::Icon::maskIndex property am::Auto - mask update based on corner pixel values apc:: - OS typeSee "get_system_info" in Prima::Applicationapc::Win32 apc::Unix bi:: - border iconsSee "borderIcons" in Prima::Windowbi::SystemMenu - system menu button and/or close button ( usually with icon ) is shown bi::Minimize - minimize button bi::Maximize - maximize ( and eventual restore ) bi::TitleBar - window title bi::All - all of the above bs:: - border stylesSee "borderStyle" in Prima::Windowbs::None - no border bs::Single - thin border bs::Dialog - thick border bs::Sizeable - thick border with interactive resize capabilities ci:: - color indicesSee "colorIndex" in Prima::Widgetci::NormalText or ci::Fore ci::Normal or ci::Back ci::HiliteText ci::Hilite ci::DisabledText ci::Disabled ci::Light3DColor ci::Dark3DColor ci::MaxId cl:: - colorsSee "colorIndex" in Prima::Widget
cm:: - commands
cr:: - pointer cursor resourcesSee "pointerType" in Prima::Widgetcr::Default same pointer type as owner's cr::Arrow arrow pointer cr::Text text entry cursor-like pointer cr::Wait hourglass cr::Size general size action pointer cr::Move general move action pointer cr::SizeWest, cr::SizeW right-move action pointer cr::SizeEast, cr::SizeE left-move action pointer cr::SizeWE general horizontal-move action pointer cr::SizeNorth, cr::SizeN up-move action pointer cr::SizeSouth, cr::SizeS down-move action pointer cr::SizeNS general vertical-move action pointer cr::SizeNW up-right move action pointer cr::SizeSE down-left move action pointer cr::SizeNE up-left move action pointer cr::SizeSW down-right move action pointer cr::Invalid invalid action pointer cr::DragNone pointer for an invalid dragging target cr::DragCopy pointer to indicate that a dnd::Copy action can be accepted cr::DragMove pointer to indicate that a dnd::Move action can be accepted cr::DragLink pointer to indicate that a dnd::Link action can be accepted cr::User user-defined icon dbt:: - device bitmap typesdbt::Bitmap monochrome 1 bit bitmap dbt::Pixmap bitmap compatible with display format dbt::Layered bitmap compatible with display format with alpha channel dnd:: - drag and drop action constants and functionsdnd::None no DND action was selected or performed dnd::Copy copy action dnd::Move move action dnd::Link link action dnd::Mask combination of all valid actions
dt:: - drive typesSee "query_drive_type" in Prima::Utilsdt::None dt::Unknown dt::Floppy dt::HDD dt::Network dt::CDROM dt::Memory dt:: - Prima::Drawable::draw_text constantsdt::Left - text is aligned to the left boundary dt::Right - text is aligned to the right boundary dt::Center - text is aligned horizontally in center dt::Top - text is aligned to the upper boundary dt::Bottom - text is aligned to the lower boundary dt::VCenter - text is aligned vertically in center dt::DrawMnemonic - tilde-escapement and underlining is used dt::DrawSingleChar - sets tw::BreakSingle option to Prima::Drawable::text_wrap call dt::NewLineBreak - sets tw::NewLineBreak option to Prima::Drawable::text_wrap call dt::SpaceBreak - sets tw::SpaceBreak option to Prima::Drawable::text_wrap call dt::WordBreak - sets tw::WordBreak option to Prima::Drawable::text_wrap call dt::ExpandTabs - performs tab character ( \t ) expansion dt::DrawPartial - draws the last line, if it is visible partially dt::UseExternalLeading- text lines positioned vertically with respect to the font external leading dt::UseClip - assign ::clipRect property to the boundary rectangle dt::QueryLinesDrawn - calculates and returns number of lines drawn ( contrary to dt::QueryHeight ) dt::QueryHeight - if set, calculates and returns vertical extension of the lines drawn dt::NoWordWrap - performs no word wrapping by the width of the boundaries dt::WordWrap - performs word wrapping by the width of the boundaries dt::Default - dt::NewLineBreak|dt::WordBreak|dt::ExpandTabs| dt::UseExternalLeading fdo:: - find / replace dialog optionsSee Prima::FindDialogfdo::MatchCase fdo::WordsOnly fdo::RegularExpression fdo::BackwardSearch fdo::ReplacePrompt fds:: - find / replace dialog scope typeSee Prima::FindDialogfds::Cursor fds::Top fds::Bottom fe:: - file events constantsSee Prima::Filefe::Read fe::Write fe::Exception fm:: - fill modesSee "fillMode" in Prima::Drawablefp::Alternate fp::Winding fp::Overlay fp:: - standard fill pattern indicesSee "fillPattern" in Prima::Drawablefp::Empty fp::Solid fp::Line fp::LtSlash fp::Slash fp::BkSlash fp::LtBkSlash fp::Hatch fp::XHatch fp::Interleave fp::WideDot fp::CloseDot fp::SimpleDots fp::Borland fp::Parquet fp:: - font pitchesSee "pitch" in Prima::Drawablefp::Default fp::Fixed fp::Variable fr:: - fetch resource constantsSee "fetch_resource" in Prima::Widgetfr::Color fr::Font fs::String fs:: - font stylesSee "style" in Prima::Drawablefs::Normal fs::Bold fs::Thin fs::Italic fs::Underlined fs::StruckOut fs::Outline fw:: - font weightsSee "weight" in Prima::Drawablefw::UltraLight fw::ExtraLight fw::Light fw::SemiLight fw::Medium fw::SemiBold fw::Bold fw::ExtraBold fw::UltraBold ggo:: - glyph outline commandsggo::Move ggo::Line ggo::Conic ggo::Cubic See also "render_glyph" in Prima::Drawable gm:: - grow modesSee "growMode" in Prima::Widget
gui:: - GUI typesSee "get_system_info" in Prima::Applicationgui::Default gui::PM gui::Windows gui::XLib gui::GTK le:: - line end stylesSee "lineEnd" in Prima::Drawablele::Flat le::Square le::Round lj:: - line join stylesSee "lineJoin" in Prima::Drawablelj::Round lj::Bevel lj::Miter lp:: - predefined line pattern stylesSee "linePattern" in Prima::Drawablelp::Null # "" /* */ lp::Solid # "\1" /* ___________ */ lp::Dash # "\x9\3" /* __ __ __ __ */ lp::LongDash # "\x16\6" /* _____ _____ */ lp::ShortDash # "\3\3" /* _ _ _ _ _ _ */ lp::Dot # "\1\3" /* . . . . . . */ lp::DotDot # "\1\1" /* ............ */ lp::DashDot # "\x9\6\1\3" /* _._._._._._ */ lp::DashDotDot # "\x9\3\1\3\1\3" /* _.._.._.._.. */ im:: - image typesSee "type" in Prima::Image.
ict:: - image conversion typesSee "conversion" in Prima::Image.ict::None - no dithering, with static palette or palette optimized by source palette ict::Posterization - no dithering, with optimized palette by source pixels ict::Ordered - 8x8 ordered halftone dithering ict::ErrorDiffusion - error diffusion dithering with static palette ict::Optimized - error diffusion dithering with optimized palette Their values are combinations of "ictp::" and "ictd::" constants, see below. ictd:: - image conversion types, ditheringThese constants select color correction (dithering) algorithm when downsampling an imageictd::None - no dithering, pure colors only ictd::Ordered - 8x8 ordered halftone dithering (checkerboard) ictd::ErrorDiffusion - error diffusion dithering (2/5 down, 2/5 right, 1/5 down/right) ictp:: - image conversion types, palette optimizationThese constants select how the target palette is made up when downsampling an image.ictp::Unoptimized - use whatever color mapping method is fastest, image quality can be severely compromized ictp::Cubic - use static cubic palette; a bit slower, guaranteed mediocre quality ictp::Optimized - collect available colors in the image; slowest, gives best results Not all combination of ictp and ictd constants are valid is:: - image statistics indicesSee "stats" in Prima::Image.is::RangeLo - minimum pixel value is::RangeHi - maximum pixel value is::Mean - mean value is::Variance - variance is::StdDev - standard deviation is::Sum - sum of pixel values is::Sum2 - sum of squares of pixel values ist:: - image scaling typesist::None - image stripped or padded with zeros ist::Box - image will be scaled using simple box transform ist::BoxX - columns behave as ist::None, rows as ist::Box ist::BoxY - rows behave as in ist::None, columns as ist::Box ist::AND - shrunken pixels AND-end together (black on white) ist::OR - shrunken pixels OR-end together (white on black) ist::Triangle - bilinear interpolation ist::Quadratic - 2rd order (quadratic) B-Spline approximation of Gaussian ist::Sinc - sine function ist::Hermite - B-Spline interpolation ist::Cubic - 3rd order (cubic) B-Spline approximation of Gaussian ist::Gaussian - Gaussian transform with gamma=0.5 See "scaling" in Prima::Image. kb:: - keyboard virtual codesSee also "KeyDown" in Prima::Widget.
km:: - keyboard modifiersSee also "KeyDown" in Prima::Widget.km::Shift km::Ctrl km::Alt km::KeyPad km::DeadKey km::Unicode mt:: - modality typesSee "get_modal" in Prima::Window, "get_modal_window" in Prima::Windowmt::None mt::Shared mt::Exclusive nt:: - notification typesUsed in "Prima::Component::notification_types" to describe event flow.See also "Flow" in Prima::Object.
mb:: - mouse buttonsSee also "MouseDown" in Prima::Widget.mb::b1 or mb::Left mb::b2 or mb::Middle mb::b3 or mb::Right mb::b4 mb::b5 mb::b6 mb::b7 mb::b8 mb:: - message box constants
ps:: - paint statesps::Disabled - can neither draw, nor get/set graphical properties on an object ps::Enabled - can both draw and get/set graphical properties on an object ps::Information - can only get/set graphical properties on an object For brevity, ps::Disabled is equal to 0 so this allows for simple boolean testing whether one can get/set graphical properties on an object. See "get_paint_state" in Drawable. rgn:: - result of Prima::Region.rect_insidergn::Inside rgn::Outside - rectangle is fully outside the region rgn::Partially rgnop:: - Prima::Region.combine set operationsrgnop::Copy rgnop::Intersect rgnop::Union rgnop::Xor rgnop::Diff rop:: - raster operation codesSee "Raster operations" in Prima::Drawablerop::Blackness # = 0 rop::NotOr # = !(src | dest) rop::NotSrcAnd # &= !src rop::NotPut # = !src rop::NotDestAnd # = !dest & src rop::Invert # = !dest rop::XorPut # ^= src rop::NotAnd # = !(src & dest) rop::AndPut # &= src rop::NotXor # = !(src ^ dest) rop::NotSrcXor # alias for rop::NotXor rop::NotDestXor # alias for rop::NotXor rop::NoOper # = dest rop::NotSrcOr # |= !src rop::CopyPut # = src rop::NotDestOr # = !dest | src rop::OrPut # |= src rop::Whiteness # = 1 12 Porter-Duff operators rop::Clear # = 0 rop::Xor # = src ( 1 - dstA ) + dst ( 1 - srcA ) rop::SrcOver # = src + dst (1 - srcA) rop::DstOver # = dst + src (1 - dstA) rop::SrcCopy # = src rop::DstCopy # = dst rop::SrcIn # = src dstA rop::DstIn # = dst srcA rop::SrcOut # = src ( 1 - dstA ) rop::DstOut # = dst ( 1 - srcA ) rop::SrcAtop # = src dstA + dst ( 1 - srcA ) rop::DstAtop # = dst srcA + src ( 1 - dstA ) rop::PorterDuffMask - masks out all bits but the constants above Photoshop operators rop::Add rop::Multiply rop::Screen rop::Overlay rop::Darken rop::Lighten rop::ColorDodge rop::ColorBurn rop::HardLight rop::SoftLight rop::Difference rop::Exclusion Constant alpha flags rop::SrcAlpha rop::SrcAlphaShift rop::DstAlpha rop::DstAlphaShift rop::ConstantAlpha Others rop::AlphaCopy sbmp:: - system bitmaps indicesSee also Prima::StdBitmap.sbmp::Logo sbmp::CheckBoxChecked sbmp::CheckBoxCheckedPressed sbmp::CheckBoxUnchecked sbmp::CheckBoxUncheckedPressed sbmp::RadioChecked sbmp::RadioCheckedPressed sbmp::RadioUnchecked sbmp::RadioUncheckedPressed sbmp::Warning sbmp::Information sbmp::Question sbmp::OutlineCollapse sbmp::OutlineExpand sbmp::Error sbmp::SysMenu sbmp::SysMenuPressed sbmp::Max sbmp::MaxPressed sbmp::Min sbmp::MinPressed sbmp::Restore sbmp::RestorePressed sbmp::Close sbmp::ClosePressed sbmp::Hide sbmp::HidePressed sbmp::DriveUnknown sbmp::DriveFloppy sbmp::DriveHDD sbmp::DriveNetwork sbmp::DriveCDROM sbmp::DriveMemory sbmp::GlyphOK sbmp::GlyphCancel sbmp::SFolderOpened sbmp::SFolderClosed sbmp::Last scr:: - scroll exposure results"Widget::scroll" returns one of these.scr::Error - failure scr::NoExpose - call resulted in no new exposed areas scr::Expose - call resulted in new exposed areas, expect a repaint sv:: - system value indicesSee also "get_system_value" in Prima::Applicationsv::YMenu - height of menu bar in top-level windows sv::YTitleBar - height of title bar in top-level windows sv::XIcon - width and height of main icon dimensions, sv::YIcon acceptable by the system sv::XSmallIcon - width and height of alternate icon dimensions, sv::YSmallIcon acceptable by the system sv::XPointer - width and height of mouse pointer icon sv::YPointer acceptable by the system sv::XScrollbar - width of the default vertical scrollbar sv::YScrollbar - height of the default horizontal scrollbar sv::XCursor - width of the system cursor sv::AutoScrollFirst - the initial and the repetitive sv::AutoScrollNext scroll timeouts sv::InsertMode - the system insert mode sv::XbsNone - widths and heights of the top-level window sv::YbsNone decorations, correspondingly, with borderStyle sv::XbsSizeable bs::None, bs::Sizeable, bs::Single, and sv::YbsSizeable bs::Dialog. sv::XbsSingle sv::YbsSingle sv::XbsDialog sv::YbsDialog sv::MousePresent - 1 if the mouse is present, 0 otherwise sv::MouseButtons - number of the mouse buttons sv::WheelPresent - 1 if the mouse wheel is present, 0 otherwise sv::SubmenuDelay - timeout ( in ms ) before a sub-menu shows on an implicit selection sv::FullDrag - 1 if the top-level windows are dragged dynamically, 0 - with marquee mode sv::DblClickDelay - mouse double-click timeout in milliseconds sv::ShapeExtension - 1 if Prima::Widget::shape functionality is supported, 0 otherwise sv::ColorPointer - 1 if system accepts color pointer icons. sv::CanUTF8_Input - 1 if system can generate key codes in unicode sv::CanUTF8_Output - 1 if system can output utf8 text sv::CompositeDisplay - 1 if system uses double-buffering and alpha composition for the desktop, 0 if it doesn't, -1 if unknown sv::LayeredWidgets - 1 if system supports layering sv::FixedPointerSize - 0 if system doesn't support arbitrary sized pointers and will resize custom icons to the system size sv::MenuCheckSize - width and height of default menu check icon sv::FriBidi - 1 if Prima is compiled with libfribidi and full bidi unicode support is available sv::Antialias - 1 if system supports antialiasing and alpha layer for primitives ta:: - alignment constantsUsed in: Prima::InputLine, Prima::ImageViewer, Prima::Label.ta::Left ta::Right ta::Center ta::Top ta::Bottom ta::Middle to:: - text output constantsThese constants are used in various text and glyph related functions, and form a somewhat vague group of bit values that may or may not be used together depending on the functionto::Plain - default value, 0 to::AddOverhangs - used in C<get_text_width> and C<get_text_shape_width> to request text overhangs to be included in the returned text width to::Glyphs - used in C<get_font_abc> and C<get_font_def> to select extension of glyph indexes rather than text codepoints to::Unicode - used in C<get_font_abc> and C<get_font_def> to select extension of unicode rather than ascii text codepoints to::RTL - used in C<get_text_shape_width> to request RTL bidi direction. Also used in C<Prima::Drawable::Glyphs::indexes> values to mark RTL characters. tw:: - text wrapping constantsSee "text_wrap" in Prima::Drawabletw::CalcMnemonic - calculates tilde underline position tw::CollapseTilde - removes escaping tilde from text tw::CalcTabs - wraps text with respect to tab expansion tw::ExpandTabs - expands tab characters tw::BreakSingle - determines if text is broken to single characters when text cannot be fit tw::NewLineBreak - breaks line on newline characters tw::SpaceBreak - breaks line on space or tab characters tw::ReturnChunks - returns wrapped text chunks tw::ReturnLines - returns positions and lengths of wrapped text chunks tw::WordBreak - defines if text break by width goes by the characters or by the words tw::ReturnFirstLineLength - returns length of the first wrapped line tw::Default - tw::NewLineBreak | tw::CalcTabs | tw::ExpandTabs | tw::ReturnLines | tw::WordBreak wc:: - widget classesSee "widgetClass" in Prima::Widgetwc::Undef wc::Button wc::CheckBox wc::Combo wc::Dialog wc::Edit wc::InputLine wc::Label wc::ListBox wc::Menu wc::Popup wc::Radio wc::ScrollBar wc::Slider wc::Widget, wc::Custom wc::Window wc::Application ws:: - window statesSee "windowState" in Prima::Windowws::Normal ws::Minimized ws::Maximized AUTHORDmitry Karasik, <dmitry@karasik.eu.org>.SEE ALSOPrima, Prima::Classes
Visit the GSP FreeBSD Man Page Interface. |