NAME

dlibrary.vectorworks - Used for all Vectorworks related stuff, like settings, and for plug-in objects and their setup and working.

CLASSES

builtins.object AbstractActivePlugInParameters AbstractResetArgs CreationResetArgs EmptyResetArgs ParameterChangedResetArgs AbstractWidget ParameterWidget ActivePlugIn ActivePlugInEvent ActivePlugInEvents ActivePlugInInfo ActivePlugInSetup ActivePlugInType Platform Security Vectorworks dlibrary.utility.AbstractXmlFile(builtins.object) AbstractActivePlugInDrawingXmlFile AbstractActivePlugInPrefsXmlFile

class AbstractActivePlugInDrawingXmlFile

descriptors

path

methods

def __init__(self):

def load(self, create_if_not_found: bool=False) -> dict:

def save(self, content: dict):

class AbstractActivePlugInParameters

Vectorworks will always give you the initial values of parameters. So when changing them inside your script, you'll still get the initial values. Therefore we'll create some sort of cache to remember the current values.

methods

def __init__(self):

class AbstractActivePlugInPrefsXmlFile

descriptors

path

methods

def __init__(self, active_plugin_type: str):

:type active_plugin_type: ActivePlugInType(Enum)

def load(self, create_if_not_found: bool=False) -> dict:

def save(self, content: dict):

class AbstractResetArgs

class AbstractWidget

methods

def add(self, widget_id: int):

class ActivePlugIn

descriptors

handle

name

parameters

version

methods

def __init__(self):

ActivePlugInEvent

ActivePlugInEvent = <class 'dlibrary.vectorworks.ActivePlugInEvent'>

class ActivePlugInEvents

Decorator to initialize eventing. Basically it's just telling which def has to be called for which event.

methods

def __call__(self, function: <built-in function callable>) -> <built-in function callable>:

def __init__(self, events: dict, with_reset_args: bool=False):

class ActivePlugInInfo

Decorator to initialize the active plugin. This should be used on the main run method of the plugin!

methods

def __call__(self, function: <built-in function callable>) -> <built-in function callable>:

def __init__(self, version: str):

class ActivePlugInSetup

Decorator to setup the active plugin with event-enabled setup things like custom info pallet.

methods

def __call__(self, function: <built-in function callable>) -> <built-in function callable>:

def __init__(self, info_pallet: list=None):

:type info_pallet: list[AbstractWidget]

ActivePlugInType

ActivePlugInType = <class 'dlibrary.vectorworks.ActivePlugInType'>

class CreationResetArgs

class EmptyResetArgs

class ParameterChangedResetArgs

descriptors

name

methods

def __init__(self, index: int):

class ParameterWidget

methods

def __init__(self, parameter: str):

def add(self, widget_id: int) -> bool:

Platform

Platform = <class 'dlibrary.vectorworks.Platform'>

class Security

Decorator to secure a function based on the dongle and VW version running.

methods

def __call__(self, function: <built-in function callable>) -> <built-in function callable>:

def __init__(self, version: str, dongles: set=None):

class Vectorworks

descriptors

dongle

platform

version

methods

def get_file_path_of_active_document(self) -> str:

def get_folder_path_of_active_document(self) -> str:

def get_folder_path_of_plugin_file(self, filename: str) -> str:

FILE

d:\development\vw libraries\dlibrary\dlibrary\vectorworks.py