.. include:: headings.inc .. module:: tools.XRCed.params .. currentmodule:: tools.XRCed.params .. highlight:: python .. _tools.XRCed.params: ========================================================================================================================================== |phoenix_title| **params** ========================================================================================================================================== Visual `Param*` classes for populating `AtrtibutePanel` with attribute editing blocks. |function_summary| Functions Summary ==================================== ================================================================================ ================================================================================ :func:`~tools.XRCed.params.InitParams` Set pixel common size based on parent window. :func:`~tools.XRCed.params.MetaParamInt` Create ParamInt class with default value. :func:`~tools.XRCed.params.MetaParamText` Return a :class:`~tools.XRCed.params.ParamText` class with specified width and proportion. :func:`~tools.XRCed.params.ReverseMap` ================================================================================ ================================================================================ | |class_summary| Classes Summary =============================== ================================================================================ ================================================================================ :ref:`tools.XRCed.params.CheckBox` :ref:`tools.XRCed.params.CheckListBoxComboPopup` :ref:`tools.XRCed.params.ContentCheckListDialog` Dialog for editing content checklist attributes. :ref:`tools.XRCed.params.ContentDialog` Dialog for editing content attributes. :ref:`tools.XRCed.params.ContentHelpListDialog` Dialog for editing content attributes with help text. :ref:`tools.XRCed.params.IntListDialog` Dialog for editing integer lists. :ref:`tools.XRCed.params.ParamBinaryOr` Editing binary flag attributes defined by a string separated by '|'. :ref:`tools.XRCed.params.ParamBitmap` :ref:`tools.XRCed.params.ParamBool` Editing on/off attributes. :ref:`tools.XRCed.params.ParamColour` Color attribute editing. :ref:`tools.XRCed.params.ParamCombo` :ref:`tools.XRCed.params.ParamComment` Comment node editing. :ref:`tools.XRCed.params.ParamContent` Editing of content attribute. :ref:`tools.XRCed.params.ParamContentCheckList` Editing of content check list attribute. :ref:`tools.XRCed.params.ParamContentHelpList` Editing of content attribute with help text. :ref:`tools.XRCed.params.ParamEncoding` Editing encoding attribute of the XML root node. :ref:`tools.XRCed.params.ParamFlag` Sizer flag editing. :ref:`tools.XRCed.params.ParamFont` Font attribute editing. :ref:`tools.XRCed.params.ParamImage` Image selector. :ref:`tools.XRCed.params.ParamInt` TextCtrl with SpinButton for integer parameters. :ref:`tools.XRCed.params.ParamIntList` Editing integer list attribute. :ref:`tools.XRCed.params.ParamInverseBool` like :class:`~tools.XRCed.params.ParamBool` but defined if unchecked :ref:`tools.XRCed.params.ParamMultilineText` Multiline text editing. :ref:`tools.XRCed.params.ParamOrient` Orientation attribute editing for sizers. :ref:`tools.XRCed.params.ParamOrientation` Orientaiton attribute editing for :class:`SplitterWindow`. :ref:`tools.XRCed.params.ParamText` Text attribute. :ref:`tools.XRCed.params.ParamUnit` Similar to :class:`~tools.XRCed.params.ParamInt`, 'd' can be appended to the value to specify :ref:`tools.XRCed.params.PPanel` Abstract base class creating an empty :class:`Panel`. :ref:`tools.XRCed.params.RadioBox` :ref:`tools.XRCed.params.StylePanel` Style panel. ================================================================================ ================================================================================ | .. toctree:: :maxdepth: 1 :hidden: tools.XRCed.params.CheckBox tools.XRCed.params.CheckListBoxComboPopup tools.XRCed.params.ContentCheckListDialog tools.XRCed.params.ContentDialog tools.XRCed.params.ContentHelpListDialog tools.XRCed.params.IntListDialog tools.XRCed.params.ParamBinaryOr tools.XRCed.params.ParamBitmap tools.XRCed.params.ParamBool tools.XRCed.params.ParamColour tools.XRCed.params.ParamCombo tools.XRCed.params.ParamComment tools.XRCed.params.ParamContent tools.XRCed.params.ParamContentCheckList tools.XRCed.params.ParamContentHelpList tools.XRCed.params.ParamEncoding tools.XRCed.params.ParamFlag tools.XRCed.params.ParamFont tools.XRCed.params.ParamImage tools.XRCed.params.ParamInt tools.XRCed.params.ParamIntList tools.XRCed.params.ParamInverseBool tools.XRCed.params.ParamMultilineText tools.XRCed.params.ParamOrient tools.XRCed.params.ParamOrientation tools.XRCed.params.ParamText tools.XRCed.params.ParamUnit tools.XRCed.params.PPanel tools.XRCed.params.RadioBox tools.XRCed.params.StylePanel Functions ------------ .. function:: InitParams(panel) Set pixel common size based on parent window. .. function:: MetaParamInt(\*\*kargs) Create ParamInt class with default value. .. function:: MetaParamText(textWidth, proportion=0) Return a :class:`~tools.XRCed.params.ParamText` class with specified width and proportion. .. function:: ReverseMap(m)