Public Member Functions | |
| def | __init__ |
| def | add_band_item |
| def | add_block_item |
| def | add_snap_item |
| def | has_band_item |
| def | has_block_item |
| def | has_snap_item |
| def | register_adapter |
| def | remove_band_item |
| def | remove_block_item |
| def | remove_snap_item |
| def | set_band_item_attributes |
| def | set_band_item_settings |
| def | set_block_item_attributes |
| def | set_block_item_settings |
| def | set_snap_item_attributes |
| def | set_snap_item_settings |
| def | update_view |
Public Attributes | |
| adapter | |
Interface definations provided by the View for use by the Adapter. NOTE: There should be no Qt specific code here!
| def diarc::diarc::view::View::__init__ | ( | self | ) |
| def diarc::diarc::view::View::add_band_item | ( | self, | |
| altitude, | |||
| rank | |||
| ) |
Create a new drawable BandItem object inside the View. This is intended to be used to create drawable objects that correspond with a band of the same altitude and rank values. :param int altitude: vertical position of the BandItem :param int rank: initial drawing order of the BandItem :raises: DuplicateItemExistsError
| def diarc::diarc::view::View::add_block_item | ( | self, | |
| index | |||
| ) |
| def diarc::diarc::view::View::add_snap_item | ( | self, | |
| snapkey | |||
| ) |
| def diarc::diarc::view::View::has_band_item | ( | self, | |
| altitude | |||
| ) |
| def diarc::diarc::view::View::has_block_item | ( | self, | |
| index | |||
| ) |
| def diarc::diarc::view::View::has_snap_item | ( | self, | |
| snapkey | |||
| ) |
| def diarc::diarc::view::View::register_adapter | ( | self, | |
| adapter | |||
| ) |
| def diarc::diarc::view::View::remove_band_item | ( | self, | |
| altitude | |||
| ) |
| def diarc::diarc::view::View::remove_block_item | ( | self, | |
| index | |||
| ) |
| def diarc::diarc::view::View::remove_snap_item | ( | self, | |
| snapkey | |||
| ) |
| def diarc::diarc::view::View::set_band_item_attributes | ( | self, | |
| index, | |||
| attributes | |||
| ) |
Copy settings from a BandItemViewAttributes object to a BandItem For more information about attributes that can be set, see BandItemViewAttributes. :param int index: index of the target BandItem :param BandItemViewAttributes attributes: class containing the desired settings :raises: ItemDoesNotExistError
| def diarc::diarc::view::View::set_band_item_settings | ( | self, | |
| altitude, | |||
| rank, | |||
| top_band_alt, | |||
| bot_band_alt, | |||
| leftmost_snapkey, | |||
| rightmost_snapkey | |||
| ) |
Sets the relative position and size of the BandItem. The two BandItems corresponding to top_band_alt and bot_band_alt, as well as the two SnapItems corresponding to leftmost_snapkey and rightmost_snapkey must exist before this can be called. 'None' may be specified in place of an int for top_band_alt or bot_band_alt if no BandItem exists to the top/bottom of the target band. This could either be because it is the topmost or bottommost BandItem, or because it is adjacent to the line of BlockItems. :param int altitude: altitude of the target BandItem :param int rank: the drawing order of the BandItem, higher numbers are drawn above lower numbers :param int top_band_alt: the altitude of the BandItem directly above the target :param int bot_band_alt: the altitude of the BandItem directly below the target :param str leftmost_snapkey: the snapkey of the leftmost SnapItem touched by this band. For positive BandItems this must be a source, for negative bandItems this must be a sink. :param str rightmost_snapkey: the snapkey of the rightmost SnapItem touched by this band. For positive BandItems this must be a sink, for negative bandItems this must be a source. :raises: ItemDoesNotExistError
| def diarc::diarc::view::View::set_block_item_attributes | ( | self, | |
| index, | |||
| attributes | |||
| ) |
Copy settings from a BlockItemViewAttributes object to a BlockItem. For more information about attributes that can be set, see BlockItemViewAttributes. :param int index: index of the target BlockItem :param BlockItemViewAttributes attributes: class containing the desired settings :raises: ItemDoesNotExistError
| def diarc::diarc::view::View::set_block_item_settings | ( | self, | |
| index, | |||
| left_index, | |||
| right_index | |||
| ) |
Sets the relative position of the BlockItem at index. All three BlockItems must exist before this can be called. 'None' may be specified in place of an int for left_index if no BlockItem exists to the left/right of the target (because it is the leftmost or rightmost BlockItem). :param int index: index of target BlockItem to set position of :param int left_index: the index of the BlockItem directly to the left of the target :param int right_index: the index of the BlockItem directly to the right of the target :raises: ItemDoesNotExistError
| def diarc::diarc::view::View::set_snap_item_attributes | ( | self, | |
| snapkey, | |||
| attributes | |||
| ) |
Copy settings from a SnapItemViewAttributes object to a SnapItem For more information about attributes that can be set, see SnapItemViewAttributes. :param str snapkey: snapkey of the target SnapItem :param SnapItemViewAttributes attributes: class containing the desired settings :raises: ItemDoesNotExistError
| def diarc::diarc::view::View::set_snap_item_settings | ( | self, | |
| snapkey, | |||
| left_order, | |||
| right_order, | |||
| pos_band_alt, | |||
| neg_band_alt | |||
| ) |
Sets the relative position of the target SnapItem specified by snapkey with respect to other SnapItems in the same container of the same Block. The SnapItems corresponding to the target, left_order, and right_order, as well as the BandItems corresponding to pos_band_alt and neg_band_alt must all exist before this can be called. 'None' may be specified in place of an int for left_order or right_order if no SnapItem exists to the left/right of the target SnapItem. This could either be because it is the leftmost or rightmost SnapItem in the container. It could also be used for pos_band_alt or neg_band_alt. :param str snapkey: snapkey of the target SnapItem :param int left_order: the order of the SnapItem directly to the left of the target :param int right_order: the order of the SnapItem directly to the right of the target :param int pos_band_alt: the altitude of the positive BandItem attached to the target, if any :param int neg_band_alt: the altitude of the negative BandItem attached to the target, if any :raises: ItemDoesNotExistError
| def diarc::diarc::view::View::update_view | ( | self | ) |