Wiki
Clone wikiVW DLibrary / 2016 / api / dialog_custom
MODULE dlibrary.dialog_custom
Used for all custom dialog stuff. Most of it is internal business.
CLASSES
builtins.object
........AbstractDataContext(builtins.object)
................AbstractControl(AbstractDataContext)
........................AbstractFieldControl(AbstractControl)
................................AbstractChoiceControl(AbstractFieldControl)
........................................PullDownMenu(AbstractChoiceControl)
........................................ResourcePullDownMenu(AbstractChoiceControl)
................................CheckBox(AbstractFieldControl)
................................EditText(AbstractFieldControl)
........................AbstractGroupControl(AbstractControl)
................................GroupBox(AbstractGroupControl)
................................TabPane(AbstractGroupControl)
........................AbstractListControl(AbstractControl)
................................ListBox(AbstractListControl)
................................ListBrowser(AbstractListControl)
........................Button(AbstractControl)
........................Separator(AbstractControl)
........................StaticText(AbstractControl)
........................TabControl(AbstractControl)
................Dialog(AbstractDataContext)
........AlignEdgeEnum(builtins.object)
........AlignFactory(builtins.object)
........AlignMode(builtins.object)
........Column(builtins.object)
........ControlFactory(builtins.object)
........ControlTypeEnum(builtins.object)
........DisplayTypeEnum(builtins.object)
........Layout(builtins.object)
........TextAlignEnum(builtins.object)
........TextStyleEnum(builtins.object)
dlibrary.utility.AbstractPropertyClassDecorator(builtins.object)
........Align(dlibrary.utility.AbstractPropertyClassDecorator)
dlibrary.utility.AbstractXmlFile(builtins.object)
........AbstractActivePlugInDialogXmlFile(dlibrary.utility.AbstractXmlFile)
class AbstractActivePlugInDialogXmlFile(dlibrary.utility.AbstractXmlFile)
> dlibrary.utility.AbstractXmlFile > builtins.object
__init__(self, dialog_name: str, active_plugin_type: str)
:type active_plugin_type: ActivePlugInType(Enum)
load = load_with_lists(args, *kwargs)
path GET
``
save(self, content: dict)
class AbstractChoiceControl(AbstractFieldControl)
> AbstractFieldControl > AbstractControl > AbstractDataContext > builtins.object
__init__(self, dialog_id: int, control_id: int, help_text: str, data_parent: AbstractDataContext, data_context: str, data_disabled: str, data_available_items: str, data_value: str, data_items: str)
control_id GET
``
data_context_changed GET
``
getattr(self, name: str, default: object=None) -> object
Overridden from AbstractDataContext, as this is never the topmost one!
setup(self, register_event_handler: <built-in function callable>)
class AbstractControl(AbstractDataContext)
> AbstractDataContext > builtins.object
__init__(self, dialog_id: int, control_id: int, help_text: str, data_parent: AbstractDataContext, data_context: str, data_disabled: str='')
control_id GET
``
data_context_changed GET
``
getattr(self, name: str, default: object=None) -> object
Overridden from AbstractDataContext, as this is never the topmost one!
setup(self, register_event_handler: <built-in function callable>)
class AbstractDataContext(builtins.object)
__init__(self, data_context: object)
data_context_changed GET
``
getattr(self, name: str, default: object=None) -> object
Will be used only by the topmost one, the Dialog, as all the rest are AbstractControl objects.
That's why we use the default to have no error thrown, and an attr should be found if it was declared.
class AbstractFieldControl(AbstractControl)
> AbstractControl > AbstractDataContext > builtins.object
__init__(self, dialog_id: int, control_id: int, help_text: str, data_parent: AbstractDataContext, data_context: str, data_disabled: str, data_value: str, data_items: str)
control_id GET
``
data_context_changed GET
``
getattr(self, name: str, default: object=None) -> object
Overridden from AbstractDataContext, as this is never the topmost one!
setup(self, register_event_handler: <built-in function callable>)
class AbstractGroupControl(AbstractControl)
> AbstractControl > AbstractDataContext > builtins.object
__init__(self, dialog_id: int, control_id: int, help_text: str, data_parent: AbstractDataContext, data_context: str, data_disabled: str)
add_controls(self, controls: tuple, layout: int)
control_id GET
``
data_context_changed GET
``
getattr(self, name: str, default: object=None) -> object
Overridden from AbstractDataContext, as this is never the topmost one!
setup(self, register_event_handler: <built-in function callable>)
class AbstractListControl(AbstractControl)
> AbstractControl > AbstractDataContext > builtins.object
__init__(self, dialog_id: int, control_id: int, help_text: str, data_parent: AbstractDataContext, data_context: str, data_disabled: str, data_items: str, data_selected_items: str, data_values: tuple)
control_id GET
``
data_context_changed GET
``
getattr(self, name: str, default: object=None) -> object
Overridden from AbstractDataContext, as this is never the topmost one!
setup(self, register_event_handler: <built-in function callable>)
class Align(dlibrary.utility.AbstractPropertyClassDecorator)
Decorator to set how a control will be aligned.
> dlibrary.utility.AbstractPropertyClassDecorator > builtins.object
__init__(self, mode)
:type mode: AlignMode(Enum) || {Layout(Enum): AlignMode(Enum)}
get_alignment(cls, control: object, layout: int) -> int from abc.ABCMeta
:type layout: Layout(Enum)
:rtype: AlignMode(Enum)
has_alignment(cls, control: object, layout: int) -> bool from abc.ABCMeta
:type layout: Layout(Enum)
has_decorator(cls, obj: object) from abc.ABCMeta
class AlignEdgeEnum(builtins.object)
- BOTTOM = 2
- LEFT = 3
- RIGHT = 1
class AlignFactory(builtins.object)
__init__(self)
generate_align_id(self) -> int
class AlignMode(builtins.object)
- RESIZE = 0
- SHIFT = 1
class Button(AbstractControl)
> AbstractControl > AbstractDataContext > builtins.object
__init__(self, dialog_id: int, control_id: int, help_text: str, data_parent: AbstractDataContext, data_context: str, data_command: str, caption: str)
:param data_command: Must resolve to an ObservableCommand up the data context tree.
:raises ValueError: if data_command is not a string, or an empty string.
:raises ValueError: if caption is not a string, or an empty string.
at_align GET
``
control_id GET
``
data_context_changed GET
``
getattr(self, name: str, default: object=None) -> object
Overridden from AbstractDataContext, as this is never the topmost one!
setup(self, register_event_handler: <built-in function callable>)
class CheckBox(AbstractFieldControl)
> AbstractFieldControl > AbstractControl > AbstractDataContext > builtins.object
__init__(self, dialog_id: int, control_id: int, help_text: str, data_parent: AbstractDataContext, data_context: str, data_disabled: str, data_value: str, data_items: str, label: str)
control_id GET
``
data_context_changed GET
``
getattr(self, name: str, default: object=None) -> object
Overridden from AbstractDataContext, as this is never the topmost one!
setup(self, register_event_handler: <built-in function callable>)
class Column(builtins.object)
__init__(self, header: str, width: int, control_type: int, display_type: int, text_align: int, data_value: str)
control_type GET
``
data_value GET
``
display_type GET
``
header GET
``
text_align GET
``
width GET
``
class ControlFactory(builtins.object)
__init__(self)
create_control(self, dialog_id: int, name: str, data: dict, data_parent: AbstractDataContext) -> AbstractControl
create_controls(self, dialog_id: int, controls: list, data_parent: AbstractDataContext) -> tuple
class ControlTypeEnum(builtins.object)
- MULTI_ICON = 7
- NUMBER = 6
- RADIO_ICON = 2
- STATIC = 1
- STATIC_ICON = 5
- TOGGLE = 3
- TOGGLE_ICON = 4
from_string(value: str) -> int
class Dialog(AbstractDataContext)
> AbstractDataContext > builtins.object
__init__(self, dialog_file: AbstractActivePlugInDialogXmlFile, data_context: object)
data_context_changed GET
``
getattr(self, name: str, default: object=None) -> object
Will be used only by the topmost one, the Dialog, as all the rest are AbstractControl objects.
That's why we use the default to have no error thrown, and an attr should be found if it was declared.
show(self) -> bool
class DisplayTypeEnum(builtins.object)
- ICON_ONLY = 1
- TEXT_AND_ICON = 3
- TEXT_ONLY = 0
from_string(value: str) -> int
class EditText(AbstractFieldControl)
> AbstractFieldControl > AbstractControl > AbstractDataContext > builtins.object
__init__(self, dialog_id: int, control_id: int, help_text: str, data_parent: AbstractDataContext, data_context: str, data_disabled: str, data_value: str, data_items: str, width: int, height: int)
at_align GET
``
control_id GET
``
data_context_changed GET
``
getattr(self, name: str, default: object=None) -> object
Overridden from AbstractDataContext, as this is never the topmost one!
setup(self, register_event_handler: <built-in function callable>)
class GroupBox(AbstractGroupControl)
> AbstractGroupControl > AbstractControl > AbstractDataContext > builtins.object
__init__(self, dialog_id: int, control_id: int, help_text: str, data_parent: AbstractDataContext, data_context: str, data_disabled: str, header: str, border: bool)
add_controls(self, controls: tuple, layout: int)
at_align GET
``
control_id GET
``
data_context_changed GET
``
getattr(self, name: str, default: object=None) -> object
Overridden from AbstractDataContext, as this is never the topmost one!
setup(self, register_event_handler: <built-in function callable>)
class Layout(builtins.object)
- HORIZONTAL = 2
- VERTICAL = 1
from_string(value: str) -> int
class ListBox(AbstractListControl)
> AbstractListControl > AbstractControl > AbstractDataContext > builtins.object
__init__(self, dialog_id: int, control_id: int, help_text: str, data_parent: AbstractDataContext, data_context: str, data_disabled: str, data_items: str, data_selected_items: str, data_value: str, width: int, height: int)
at_align GET
``
control_id GET
``
data_context_changed GET
``
getattr(self, name: str, default: object=None) -> object
Overridden from AbstractDataContext, as this is never the topmost one!
setup(self, register_event_handler: <built-in function callable>)
class ListBrowser(AbstractListControl)
> AbstractListControl > AbstractControl > AbstractDataContext > builtins.object
__init__(self, dialog_id: int, control_id: int, help_text: str, data_parent: AbstractDataContext, data_context: str, data_disabled: str, data_items: str, data_selected_items: str, index: bool, columns: tuple, width: int, height: int)
at_align GET
``
control_id GET
``
data_context_changed GET
``
getattr(self, name: str, default: object=None) -> object
Overridden from AbstractDataContext, as this is never the topmost one!
setup(self, register_event_handler: <built-in function callable>)
class PullDownMenu(AbstractChoiceControl)
> AbstractChoiceControl > AbstractFieldControl > AbstractControl > AbstractDataContext > builtins.object
__init__(self, dialog_id: int, control_id: int, help_text: str, data_parent: AbstractDataContext, data_context: str, data_disabled: str, data_available_items: str, data_value: str, data_items: str, width: int)
at_align GET
``
control_id GET
``
data_context_changed GET
``
getattr(self, name: str, default: object=None) -> object
Overridden from AbstractDataContext, as this is never the topmost one!
setup(self, register_event_handler: <built-in function callable>)
class ResourcePullDownMenu(AbstractChoiceControl)
> AbstractChoiceControl > AbstractFieldControl > AbstractControl > AbstractDataContext > builtins.object
__init__(self, dialog_id: int, control_id: int, help_text: str, data_parent: AbstractDataContext, data_context: str, data_disabled: str, data_available_items: str, data_value: str, data_items: str)
at_align GET
``
control_id GET
``
data_context_changed GET
``
getattr(self, name: str, default: object=None) -> object
Overridden from AbstractDataContext, as this is never the topmost one!
setup(self, register_event_handler: <built-in function callable>)
class Separator(AbstractControl)
> AbstractControl > AbstractDataContext > builtins.object
__init__(self, dialog_id: int, control_id: int, help_text: str, data_parent: AbstractDataContext, data_context: str)
control_id GET
``
data_context_changed GET
``
getattr(self, name: str, default: object=None) -> object
Overridden from AbstractDataContext, as this is never the topmost one!
setup(self, register_event_handler: <built-in function callable>)
class StaticText(AbstractControl)
> AbstractControl > AbstractDataContext > builtins.object
__init__(self, dialog_id: int, control_id: int, help_text: str, data_parent: AbstractDataContext, data_context: str, text: str, width: int, style: int)
at_align GET
``
control_id GET
``
data_context_changed GET
``
getattr(self, name: str, default: object=None) -> object
Overridden from AbstractDataContext, as this is never the topmost one!
setup(self, register_event_handler: <built-in function callable>)
class TabControl(AbstractControl)
> AbstractControl > AbstractDataContext > builtins.object
__init__(self, dialog_id: int, control_id: int, help_text: str, data_parent: AbstractDataContext, data_context: str, data_disabled)
add_tab_panes(self, tab_panes: tuple)
at_align GET
``
control_id GET
``
data_context_changed GET
``
getattr(self, name: str, default: object=None) -> object
Overridden from AbstractDataContext, as this is never the topmost one!
setup(self, register_event_handler: <built-in function callable>)
class TabPane(AbstractGroupControl)
> AbstractGroupControl > AbstractControl > AbstractDataContext > builtins.object
__init__(self, dialog_id: int, control_id: int, help_text: str, data_parent: AbstractControl, data_context: str, data_disabled: str, header: str)
add_controls(self, controls: tuple, layout: int)
control_id GET
``
data_context_changed GET
``
getattr(self, name: str, default: object=None) -> object
Overridden from AbstractDataContext, as this is never the topmost one!
setup(self, register_event_handler: <built-in function callable>)
class TextAlignEnum(builtins.object)
- CENTER = 2
- LEFT = 1
- RIGHT = 3
from_string(value: str) -> int
class TextStyleEnum(builtins.object)
- BOLD = 2
- CAPTION = 1
- REDUCED = 3
- REGULAR = 0
from_string(value: str) -> int
FILE
d:\development\vw libraries\dlibrary\dlibrary\dialog_custom.py
Updated