Wiki
Clone wikiVW DLibrary / 2015 / api / dialog_custom
NAME
dlibrary.dialog_custom - Used for all custom dialog stuff. Most of it is internal business.
CLASSES
builtins.object AbstractDataContext AbstractControl AbstractFieldControl EditText PullDownMenu AbstractGroupControl GroupBox TabPane AbstractListControl ListBox ListBrowser Button Separator StaticText TabControl Dialog AlignEdgeEnum AlignFactory AlignMode Column ControlFactory ControlTypeEnum DisplayTypeEnum Layout TextAlignEnum TextStyleEnum dlibrary.utility.AbstractPropertyClassDecorator(builtins.object) Align dlibrary.utility.AbstractXmlFile(builtins.object) AbstractActivePlugInDialogXmlFile
class AbstractActivePlugInDialogXmlFile
descriptors
path
methods
def __init__(self, dialog_name: str, active_plugin_type: str):
:type active_plugin_type: ActivePlugInType(Enum)
def load = load_with_lists(args, *kwargs):
def save(self, content: dict):
class AbstractControl
descriptors
control_id
data_context_changed
methods
def __init__(self, dialog_id: int, control_id: int, help_text: str, data_parent: AbstractDataContext, data_context: str, data_disabled: str=''):
def getattr(self, name: str, default: object=None) -> object:
Overridden from AbstractDataContext, as this is never the topmost one!
def setup(self, register_event_handler: <built-in function callable>):
class AbstractDataContext
descriptors
data_context_changed
methods
def __init__(self, data_context: object):
def 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
descriptors
control_id
data_context_changed
methods
def __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):
def getattr(self, name: str, default: object=None) -> object:
Overridden from AbstractDataContext, as this is never the topmost one!
def setup(self, register_event_handler: <built-in function callable>):
class AbstractGroupControl
descriptors
control_id
data_context_changed
methods
def __init__(self, dialog_id: int, control_id: int, help_text: str, data_parent: AbstractDataContext, data_context: str, data_disabled: str):
def add_controls(self, controls: tuple, layout: int):
def getattr(self, name: str, default: object=None) -> object:
Overridden from AbstractDataContext, as this is never the topmost one!
def setup(self, register_event_handler: <built-in function callable>):
class AbstractListControl
descriptors
control_id
data_context_changed
methods
def __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):
def getattr(self, name: str, default: object=None) -> object:
Overridden from AbstractDataContext, as this is never the topmost one!
def setup(self, register_event_handler: <built-in function callable>):
class Align
Decorator to set how a control will be aligned.
methods
def __call__(self, cls):
def __init__(self, mode):
:type mode: AlignMode(Enum) || {Layout(Enum): AlignMode(Enum)}
def get_alignment(cls, control: object, layout: int) -> int:
:type layout: Layout(Enum) :rtype: AlignMode(Enum)
def has_alignment(cls, control: object, layout: int) -> bool:
:type layout: Layout(Enum)
def has_decorator(cls, obj: object):
AlignEdgeEnum
AlignEdgeEnum = <class 'dlibrary.dialog_custom.AlignEdgeEnum'>
class AlignFactory
methods
def __init__(self):
def generate_align_id(self) -> int:
AlignMode
AlignMode = <class 'dlibrary.dialog_custom.AlignMode'>
class Button
descriptors
at_align
control_id
data_context_changed
methods
def __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.
def getattr(self, name: str, default: object=None) -> object:
Overridden from AbstractDataContext, as this is never the topmost one!
def setup(self, register_event_handler: <built-in function callable>):
class Column
descriptors
control_type
data_value
display_type
header
text_align
width
methods
def __init__(self, header: str, width: int, control_type: int, display_type: int, text_align: int, data_value: str):
class ControlFactory
methods
def __init__(self):
def create_control(self, dialog_id: int, name: str, data: dict, data_parent: AbstractDataContext) -> AbstractControl:
def create_controls(self, dialog_id: int, controls: list, data_parent: AbstractDataContext) -> tuple:
ControlTypeEnum
ControlTypeEnum = <class 'dlibrary.dialog_custom.ControlTypeEnum'>
class Dialog
descriptors
data_context_changed
methods
def __init__(self, dialog_file: AbstractActivePlugInDialogXmlFile, data_context: object):
def 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.
def show(self) -> bool:
DisplayTypeEnum
DisplayTypeEnum = <class 'dlibrary.dialog_custom.DisplayTypeEnum'>
class EditText
descriptors
at_align
control_id
data_context_changed
methods
def __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):
def getattr(self, name: str, default: object=None) -> object:
Overridden from AbstractDataContext, as this is never the topmost one!
def setup(self, register_event_handler: <built-in function callable>):
class GroupBox
descriptors
at_align
control_id
data_context_changed
methods
def __init__(self, dialog_id: int, control_id: int, help_text: str, data_parent: AbstractDataContext, data_context: str, data_disabled: str, header: str, border: bool):
def add_controls(self, controls: tuple, layout: int):
def getattr(self, name: str, default: object=None) -> object:
Overridden from AbstractDataContext, as this is never the topmost one!
def setup(self, register_event_handler: <built-in function callable>):
Layout
Layout = <class 'dlibrary.dialog_custom.Layout'>
class ListBox
descriptors
at_align
control_id
data_context_changed
methods
def __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):
def getattr(self, name: str, default: object=None) -> object:
Overridden from AbstractDataContext, as this is never the topmost one!
def setup(self, register_event_handler: <built-in function callable>):
class ListBrowser
descriptors
at_align
control_id
data_context_changed
methods
def __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):
def getattr(self, name: str, default: object=None) -> object:
Overridden from AbstractDataContext, as this is never the topmost one!
def setup(self, register_event_handler: <built-in function callable>):
class PullDownMenu
descriptors
at_align
control_id
data_context_changed
methods
def __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):
def getattr(self, name: str, default: object=None) -> object:
Overridden from AbstractDataContext, as this is never the topmost one!
def setup(self, register_event_handler: <built-in function callable>):
class Separator
descriptors
control_id
data_context_changed
methods
def __init__(self, dialog_id: int, control_id: int, help_text: str, data_parent: AbstractDataContext, data_context: str):
def getattr(self, name: str, default: object=None) -> object:
Overridden from AbstractDataContext, as this is never the topmost one!
def setup(self, register_event_handler: <built-in function callable>):
class StaticText
descriptors
at_align
control_id
data_context_changed
methods
def __init__(self, dialog_id: int, control_id: int, help_text: str, data_parent: AbstractDataContext, data_context: str, text: str, width: int, style: int):
def getattr(self, name: str, default: object=None) -> object:
Overridden from AbstractDataContext, as this is never the topmost one!
def setup(self, register_event_handler: <built-in function callable>):
class TabControl
descriptors
at_align
control_id
data_context_changed
methods
def __init__(self, dialog_id: int, control_id: int, help_text: str, data_parent: AbstractDataContext, data_context: str, data_disabled):
def add_tab_panes(self, tab_panes: tuple):
def getattr(self, name: str, default: object=None) -> object:
Overridden from AbstractDataContext, as this is never the topmost one!
def setup(self, register_event_handler: <built-in function callable>):
class TabPane
descriptors
control_id
data_context_changed
methods
def __init__(self, dialog_id: int, control_id: int, help_text: str, data_parent: AbstractControl, data_context: str, data_disabled: str, header: str):
def add_controls(self, controls: tuple, layout: int):
def getattr(self, name: str, default: object=None) -> object:
Overridden from AbstractDataContext, as this is never the topmost one!
def setup(self, register_event_handler: <built-in function callable>):
TextAlignEnum
TextAlignEnum = <class 'dlibrary.dialog_custom.TextAlignEnum'>
TextStyleEnum
TextStyleEnum = <class 'dlibrary.dialog_custom.TextStyleEnum'>
FILE
d:\development\vw libraries\dlibrary\dlibrary\dialog_custom.py
Updated