comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer Class Reference

Inheritance diagram for comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer:

Public Member Functions
	__init__ (self)
	first_page (self)
	flip_page (self)
	get_mergedimage (self, index)
	go_to_page_index (self, index)
	last_page (self)
	load_comic (self, path_to_config)
	next_page (self)
	prev_page (self)
	toggle_spread (self)
	update_left_page (self, index)
	update_right_page (self, index)
	update_single_page (self, index)

Public Attributes
	buttons_layout
	end_shortcut
	first_btn
	first_page
	home_shortcut
	last_btn
	last_page
	left_shortcut
	left_viewer
	next_btn
	next_page
	page_layout
	pageIndex
	path_to_config
	prev_btn
	prev_page
	projecturl
	right_shortcut
	right_viewer
	setupDictionary
	single_viewer
	space_shortcut
	spread
	spread_btn
	toggle_spread

Static Public Attributes
int	pageIndex = 0
bool	spread = True

Detailed Description

Definition at line 78 of file comics_project_page_viewer.py.

Constructor & Destructor Documentation

__init__()

comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.__init__

(

self

)

Definition at line 82 of file comics_project_page_viewer.py.

    def __init__(self):
        super().__init__()
 
        self.setModal(False)
        self.setWindowTitle('Untitled')
        self.setWindowFlags(
            Qt.WindowType.WindowTitleHint |
            Qt.WindowType.WindowMinimizeButtonHint |
            Qt.WindowType.WindowMaximizeButtonHint |
            Qt.WindowType.WindowCloseButtonHint
            )
        self.resize(1024, 768)
        self.setLayout(QVBoxLayout())
 
        self.left_viewer = page_viewer()
        self.left_viewer.align_right()
        self.left_viewer.clicked.connect(self.prev_page)
        self.right_viewer = page_viewer()
        self.right_viewer.align_left()
        self.right_viewer.clicked.connect(self.next_page)
        self.single_viewer = page_viewer()
        self.single_viewer.align_center()
        self.single_viewer.clicked.connect(self.next_page)
        self.single_viewer.hide()
 
        self.page_layout = QHBoxLayout()
        self.layout().addLayout(self.page_layout)
        self.page_layout.addWidget(self.left_viewer)
        self.page_layout.addWidget(self.right_viewer)
        self.page_layout.addWidget(self.single_viewer)
 
        # Keyboard shortcuts
        self.home_shortcut = QShortcut('Home', self)
        self.home_shortcut.activated.connect(self.first_page)
        self.left_shortcut = QShortcut('Left', self)
        self.left_shortcut.activated.connect(self.prev_page)
        self.right_shortcut = QShortcut('Right', self)
        self.right_shortcut.activated.connect(self.next_page)
        self.space_shortcut = QShortcut('Space', self)
        self.space_shortcut.activated.connect(self.next_page)
        self.end_shortcut = QShortcut('End', self)
        self.end_shortcut.activated.connect(self.last_page)
 
        self.first_btn = QPushButton('First')
        self.first_btn.clicked.connect(self.first_page)
        self.prev_btn = QPushButton('Previous')
        self.prev_btn.clicked.connect(self.prev_page)
        self.spread_btn = QPushButton('Single Page')
        self.spread_btn.clicked.connect(self.toggle_spread)
        self.next_btn = QPushButton('Next')
        self.next_btn.clicked.connect(self.next_page)
        self.last_btn = QPushButton('Last')
        self.last_btn.clicked.connect(self.last_page)
 
        self.buttons_layout = QHBoxLayout()
        self.layout().addLayout(self.buttons_layout)
        self.buttons_layout.addWidget(self.first_btn)
        self.buttons_layout.addWidget(self.prev_btn)
        self.buttons_layout.addWidget(self.spread_btn)
        self.buttons_layout.addWidget(self.next_btn)
        self.buttons_layout.addWidget(self.last_btn)
 

References comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.__init__(), KisPipeBrushParasite.dim, KisSpinBoxUnitManager.dim, FlattenSpec.dim, xcfLayer.dim, RecorderExportConfig.resize(), KisRectsGrid.resize(), RecorderExportSettings.resize, KisGLImageF16.resize(), KisTotalRandomColorSource.resize(), KoPatternColorSource.resize(), KisUniformColorSource.resize(), KisOptimizedByteArray.resize(), and Selection.resize().

Member Function Documentation

first_page()

comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.first_page

(

self

)

Definition at line 206 of file comics_project_page_viewer.py.

    def first_page(self):
        self.pageIndex = 0
        self.flip_page()
 

References comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.flip_page(), and comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.pageIndex.

flip_page()

comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.flip_page

(

self

)

Definition at line 234 of file comics_project_page_viewer.py.

    def flip_page(self):
        if self.spread:
            if self.pageIndex % 2 == 0: # Even/Left
                left_page_number = self.pageIndex - 1
                right_page_number = self.pageIndex
            else: # Odd/Right
                left_page_number = self.pageIndex
                right_page_number = self.pageIndex + 1
            self.update_left_page(left_page_number)
            self.update_right_page(right_page_number)
            if left_page_number < 0:
                page_numbers = str(right_page_number + 1)
            elif right_page_number >= len(self.setupDictionary['pages']):
                page_numbers = str(left_page_number + 1)
            else:
                page_numbers = '{left} / {right}'.format(
                    left = str(left_page_number + 1),
                    right = str(right_page_number + 1))
            self.setWindowTitle('{name} - {page_numbers}'.format(
                name = self.setupDictionary['projectName'],
                page_numbers = page_numbers))
        else:
            if self.pageIndex >= len(self.setupDictionary['pages']):
                self.pageIndex = len(self.setupDictionary['pages']) - 1
            if self.pageIndex < 0:
                self.pageIndex = 0
            self.update_single_page(self.pageIndex)
            self.setWindowTitle('{name} - {page_numbers}'.format(
                name = self.setupDictionary['projectName'],
                page_numbers = str(self.pageIndex + 1)))
 
 

References KisPipeBrushParasite.dim, KisSpinBoxUnitManager.dim, FlattenSpec.dim, xcfLayer.dim, comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.pageIndex, comics_project_management_tools.comics_project_manager_docker.comics_project_manager_docker.setupDictionary, comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.setupDictionary, comics_project_management_tools.comics_project_setup_wizard.ComicsProjectSetupWizard.setupDictionary, KoAbstractGradient.spread, KoAbstractGradient.spread(), psd_layer_effects_shadow_base.spread(), comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.spread, comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.update_left_page(), comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.update_right_page(), and comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.update_single_page().

get_mergedimage()

comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.get_mergedimage	(		self,
			index )

Definition at line 266 of file comics_project_page_viewer.py.

    def get_mergedimage(self, index):
        if index < len(self.setupDictionary['pages']) and index > -1:
            image_url = os.path.join(self.projecturl, self.setupDictionary['pages'][index])
            if os.path.exists(image_url):
                page = zipfile.ZipFile(image_url, "r")
                image = QImage.fromData(page.read("mergedimage.png"))
                page.close()
                return image
        image = QImage(QSize(10, 10), QImage.Format.Format_ARGB32)
        image.fill(Qt.GlobalColor.transparent)
        return image
 

References comics_project_management_tools.comics_project_manager_docker.comics_project_manager_docker.projecturl, comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.projecturl, comics_project_management_tools.comics_project_manager_docker.comics_project_manager_docker.setupDictionary, comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.setupDictionary, and comics_project_management_tools.comics_project_setup_wizard.ComicsProjectSetupWizard.setupDictionary.

go_to_page_index()

comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.go_to_page_index	(		self,
			index )

Definition at line 170 of file comics_project_page_viewer.py.

    def go_to_page_index(self, index):
        if index >= 0 and index < len(self.setupDictionary['pages']):
            self.pageIndex = index
        else:
            self.pageIndex = 0
        self.flip_page()
 

References comics_project_management_tools.comics_project_manager_docker.comics_project_manager_docker.setupDictionary, comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.setupDictionary, and comics_project_management_tools.comics_project_setup_wizard.ComicsProjectSetupWizard.setupDictionary.

last_page()

comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.last_page

(

self

)

Definition at line 230 of file comics_project_page_viewer.py.

    def last_page(self):
        self.pageIndex = len(self.setupDictionary['pages']) - 1
        self.flip_page()
 

References comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.flip_page(), comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.pageIndex, comics_project_management_tools.comics_project_manager_docker.comics_project_manager_docker.setupDictionary, comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.setupDictionary, and comics_project_management_tools.comics_project_setup_wizard.ComicsProjectSetupWizard.setupDictionary.

load_comic()

comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.load_comic	(		self,
			path_to_config )

Definition at line 144 of file comics_project_page_viewer.py.

    def load_comic(self, path_to_config):
        self.path_to_config = path_to_config
        configFile = open(self.path_to_config, "r", newline="", encoding="utf-16")
        self.setupDictionary = json.load(configFile)
        self.projecturl = os.path.dirname(str(self.path_to_config))
        if 'readingDirection' in self.setupDictionary:
            if self.setupDictionary['readingDirection'] == "leftToRight":
                self.setLayoutDirection(Qt.LayoutDirection.LeftToRight)
                self.left_shortcut.disconnect()
                self.right_shortcut.disconnect()
                self.left_shortcut.activated.connect(self.prev_page)
                self.right_shortcut.activated.connect(self.next_page)
            else:
                self.left_shortcut.disconnect()
                self.right_shortcut.disconnect()
                self.setLayoutDirection(Qt.LayoutDirection.RightToLeft)
                self.left_shortcut.activated.connect(self.next_page)
                self.right_shortcut.activated.connect(self.prev_page)
        else:
            self.left_shortcut.disconnect()
            self.right_shortcut.disconnect()
            self.setLayoutDirection(Qt.LayoutDirection.LeftToRight)
            self.left_shortcut.activated.connect(self.prev_page)
            self.right_shortcut.activated.connect(self.next_page)
        configFile.close()
 

next_page()

comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.next_page

(

self

)

Definition at line 220 of file comics_project_page_viewer.py.

    def next_page(self):
        if self.pageIndex >= len(self.setupDictionary['pages']) - 1:
            self.pageIndex = 0
        else:
            if self.spread:
                self.pageIndex += 2
            else:
                self.pageIndex += 1
        self.flip_page()
 

References comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.flip_page(), comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.pageIndex, comics_project_management_tools.comics_project_manager_docker.comics_project_manager_docker.setupDictionary, comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.setupDictionary, comics_project_management_tools.comics_project_setup_wizard.ComicsProjectSetupWizard.setupDictionary, KoAbstractGradient.spread, KoAbstractGradient.spread(), psd_layer_effects_shadow_base.spread(), and comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.spread.

prev_page()

comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.prev_page

(

self

)

Definition at line 210 of file comics_project_page_viewer.py.

    def prev_page(self):
        if self.pageIndex <= 0:
            self.pageIndex = len(self.setupDictionary['pages']) - 1
        else:
            if self.spread:
                self.pageIndex -= 2
            else:
                self.pageIndex -= 1
        self.flip_page()
 

References comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.flip_page(), comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.pageIndex, comics_project_management_tools.comics_project_manager_docker.comics_project_manager_docker.setupDictionary, comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.setupDictionary, comics_project_management_tools.comics_project_setup_wizard.ComicsProjectSetupWizard.setupDictionary, KoAbstractGradient.spread, KoAbstractGradient.spread(), psd_layer_effects_shadow_base.spread(), and comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.spread.

toggle_spread()

comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.toggle_spread

(

self

)

Definition at line 177 of file comics_project_page_viewer.py.

    def toggle_spread(self):
        if self.spread:
            self.spread = False
            self.spread_btn.setText('Double Spread')
            self.update_single_page(self.pageIndex)
            self.left_viewer.hide()
            self.right_viewer.hide()
            self.single_viewer.show()
            self.flip_page()
        else:
            self.spread = True
            self.spread_btn.setText('Single Page')
            self.left_viewer.show()
            self.right_viewer.show()
            self.single_viewer.hide()
            self.flip_page()
 

References KoAbstractGradient.spread, KoAbstractGradient.spread(), psd_layer_effects_shadow_base.spread(), and comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.spread.

update_left_page()

comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.update_left_page	(		self,
			index )

Definition at line 198 of file comics_project_page_viewer.py.

    def update_left_page(self, index):
        image = self.get_mergedimage(index)
        self.left_viewer.set_image(image)
 

References comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.get_mergedimage(), and comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.left_viewer.

update_right_page()

comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.update_right_page	(		self,
			index )

Definition at line 202 of file comics_project_page_viewer.py.

    def update_right_page(self, index):
        image = self.get_mergedimage(index)
        self.right_viewer.set_image(image)
 

References comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.get_mergedimage(), and comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.right_viewer.

update_single_page()

comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.update_single_page	(		self,
			index )

Definition at line 194 of file comics_project_page_viewer.py.

    def update_single_page(self, index):
        image = self.get_mergedimage(index)
        self.single_viewer.set_image(image)
 

References comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.get_mergedimage(), and comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.single_viewer.

Member Data Documentation

buttons_layout

comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.buttons_layout

Definition at line 136 of file comics_project_page_viewer.py.

end_shortcut

comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.end_shortcut

Definition at line 122 of file comics_project_page_viewer.py.

first_btn

comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.first_btn

Definition at line 125 of file comics_project_page_viewer.py.

first_page

comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.first_page

Definition at line 115 of file comics_project_page_viewer.py.

home_shortcut

comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.home_shortcut

Definition at line 114 of file comics_project_page_viewer.py.

last_btn

comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.last_btn

Definition at line 133 of file comics_project_page_viewer.py.

last_page

comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.last_page

Definition at line 123 of file comics_project_page_viewer.py.

left_shortcut

comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.left_shortcut

Definition at line 116 of file comics_project_page_viewer.py.

left_viewer

comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.left_viewer

Definition at line 96 of file comics_project_page_viewer.py.

next_btn

comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.next_btn

Definition at line 131 of file comics_project_page_viewer.py.

next_page

comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.next_page

Definition at line 101 of file comics_project_page_viewer.py.

page_layout

comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.page_layout

Definition at line 107 of file comics_project_page_viewer.py.

pageIndex [1/2]

int comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.pageIndex = 0

static

Definition at line 79 of file comics_project_page_viewer.py.

pageIndex [2/2]

comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.pageIndex

Definition at line 172 of file comics_project_page_viewer.py.

path_to_config

comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.path_to_config

Definition at line 145 of file comics_project_page_viewer.py.

prev_btn

comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.prev_btn

Definition at line 127 of file comics_project_page_viewer.py.

prev_page

comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.prev_page

Definition at line 98 of file comics_project_page_viewer.py.

projecturl

comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.projecturl

Definition at line 148 of file comics_project_page_viewer.py.

right_shortcut

comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.right_shortcut

Definition at line 118 of file comics_project_page_viewer.py.

right_viewer

comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.right_viewer

Definition at line 99 of file comics_project_page_viewer.py.

setupDictionary

comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.setupDictionary

Definition at line 147 of file comics_project_page_viewer.py.

single_viewer

comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.single_viewer

Definition at line 102 of file comics_project_page_viewer.py.

space_shortcut

comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.space_shortcut

Definition at line 120 of file comics_project_page_viewer.py.

spread [1/2]

bool comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.spread = True

static

Definition at line 80 of file comics_project_page_viewer.py.

spread [2/2]

comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.spread

Definition at line 179 of file comics_project_page_viewer.py.

spread_btn

comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.spread_btn

Definition at line 129 of file comics_project_page_viewer.py.

toggle_spread

comics_project_management_tools.comics_project_page_viewer.comics_project_page_viewer.toggle_spread

Definition at line 130 of file comics_project_page_viewer.py.

---

The documentation for this class was generated from the following file:

• plugins/python/comics_project_management_tools/comics_project_page_viewer.py