| code | html | diff |
|---|
| defineColor | defineColor | - defineColor("name", c, m, y, k) Defines a new color "name". The color Value is defined via four components: c = Cyan, m = Magenta, y = Yello and k = Black. Color components should be in the range from 0 to 255. May raise ValueError if an invalid color name is specified.
+ defineColor("name", c, m, y, k) Defines a new color "name". The color Value is defined via four components: c = Cyan, m = Magenta, y = Yellow and k = Black. Color components should be in the range from 0 to 255. May raise ValueError if an invalid color name is specified.
? +
|
|---|
| defineColor("name", c, m, y, k) Defines a new color "name". The color Value is defined via four components: c = Cyan, m = Magenta, y = Yello and k = Black. Color components should be in the range from 0 to 255. May raise ValueError if an invalid color name is specified. | defineColor("name", c, m, y, k) Defines a new color "name". The color Value is defined via four components: c = Cyan, m = Magenta, y = Yellow and k = Black. Color components should be in the range from 0 to 255. May raise ValueError if an invalid color name is specified. |
| fileDialog | fileDialog | - fileDialog("caption", ["filter", "defaultname", haspreview, issave, isdir]) -> string with filename Shows a File Open dialog box with the caption "caption". Files are filtered with the filter string "filter". A default filename or file path can also supplied, leave this string empty when you don't want to use it. A value of True for haspreview enables a small preview widget in the FileSelect box. When the issave parameter is set to True the dialog acts like a "Save As" dialog otherwise it acts like a "File Open Dialog". When the isdir parameter is True the dialog shows and returns only directories. The default for all of the opional parameters is False. The filter, if specified, takes the form 'comment (*.type *.type2 ...)'. For example 'Images (*.png *.xpm *.jpg)'. Refer to the Qt-Documentation for QFileDialog for details on filters. Example: fileDialog('Open input', 'CSV files (*.csv)') Example: fileDialog('Save report', defaultname='report.txt', issave=True)
? - -------
+ fileDialog("caption", ["filter", "defaultname",haspreview, issave]) -> string with filename Shows a File Open dialog box with the caption "caption". Files are filtered with the filter string "filter". A default filename or file path can also supplied, leave this string empty when you don't want to use it. A value of True for haspreview enables a small preview widget in the FileSelect box. When the issave parameter is set to True the dialog acts like a "Save As" dialog otherwise it acts like a "File Open Dialog". When the isdir parameter is True the dialog shows and returns only directories. The default for all of the opional parameters is False. The filter, if specified, takes the form 'comment (*.type *.type2 ...)'. For example 'Images (*.png *.xpm *.jpg)'. Refer to the Qt-Documentation for QFileDialog for details on filters. Example: fileDialog('Open input', 'CSV files (*.csv)') Example: fileDialog('Save report', defaultname='report.txt', issave=True) |
|---|
| fileDialog("caption", ["filter", "defaultname", haspreview, issave, isdir]) -> string with filename Shows a File Open dialog box with the caption "caption". Files are filtered with the filter string "filter". A default filename or file path can also supplied, leave this string empty when you don't want to use it. A value of True for haspreview enables a small preview widget in the FileSelect box. When the issave parameter is set to True the dialog acts like a "Save As" dialog otherwise it acts like a "File Open Dialog". When the isdir parameter is True the dialog shows and returns only directories. The default for all of the opional parameters is False. The filter, if specified, takes the form 'comment (*.type *.type2 ...)'. For example 'Images (*.png *.xpm *.jpg)'. Refer to the Qt-Documentation for QFileDialog for details on filters. Example: fileDialog('Open input', 'CSV files (*.csv)') Example: fileDialog('Save report', defaultname='report.txt', issave=True) | fileDialog("caption", ["filter", "defaultname",haspreview, issave]) -> string with filename Shows a File Open dialog box with the caption "caption". Files are filtered with the filter string "filter". A default filename or file path can also supplied, leave this string empty when you don't want to use it. A value of True for haspreview enables a small preview widget in the FileSelect box. When the issave parameter is set to True the dialog acts like a "Save As" dialog otherwise it acts like a "File Open Dialog". When the isdir parameter is True the dialog shows and returns only directories. The default for all of the opional parameters is False. The filter, if specified, takes the form 'comment (*.type *.type2 ...)'. For example 'Images (*.png *.xpm *.jpg)'. Refer to the Qt-Documentation for QFileDialog for details on filters. Example: fileDialog('Open input', 'CSV files (*.csv)') Example: fileDialog('Save report', defaultname='report.txt', issave=True) |
| getCornerRadius | getCornerRadius | - getCornerRadius(["name"]) -> integer Returns the corner radius of the object "name". The radius isexpressed in points. If "name" is not given the currentlyselected item is used.
+ getCornerRadius(["name"]) -> integer Returns the corner radius of the object "name". The radius is expressed in points. If "name" is not given the currently selected item is used.
? + +
|
|---|
| getCornerRadius(["name"]) -> integer Returns the corner radius of the object "name". The radius isexpressed in points. If "name" is not given the currentlyselected item is used. | getCornerRadius(["name"]) -> integer Returns the corner radius of the object "name". The radius is expressed in points. If "name" is not given the currently selected item is used. |
| pageDimension | pageDimension | - getPageSize() -> tuple Returns a tuple with page dimensions measured in the document's current units. See UNIT_<type> constants and getPageMargins()
+ getPageSize() -> tuple Alias. Returns a tuple with page dimensions measured in the document's current units. See UNIT_<type> constants and getPageMargins()
? +++++++
|
|---|
| getPageSize() -> tuple Returns a tuple with page dimensions measured in the document's current units. See UNIT_<type> constants and getPageMargins() | getPageSize() -> tuple Alias. Returns a tuple with page dimensions measured in the document's current units. See UNIT_<type> constants and getPageMargins() |
| getPosition | getPosition | - getPosition(["name"]) -> (x,y) Returns a (x, y) tuple with the position of the object "name". If "name" is not given the currently selected item is used.The position is expressed in the actual measurement unit of the document - see UNIT_<type> for reference.
+ getPosition(["name"]) -> (x,y) Returns a (x, y) tuple with the position of the object "name". If "name" is not given the currently selected item is used. The position is expressed in the actual measurement unit of the document - see UNIT_<type> for reference.
? +
|
|---|
| getPosition(["name"]) -> (x,y) Returns a (x, y) tuple with the position of the object "name". If "name" is not given the currently selected item is used.The position is expressed in the actual measurement unit of the document - see UNIT_<type> for reference. | getPosition(["name"]) -> (x,y) Returns a (x, y) tuple with the position of the object "name". If "name" is not given the currently selected item is used. The position is expressed in the actual measurement unit of the document - see UNIT_<type> for reference. |
| insertText | insertText | - insertText("text", pos, ["name"]) Inserts the text "text" at the position "pos" into the text frame "name". Text must be UTF encoded (see setText() as reference) The first character has an index of 0. Inserting at position -1 appends text to the frame. If "name" is not given the currently selected Item is used. May throw IndexError for an insertion out of bounds.
? ------- ^^^^^^^^^^^^^^^^^^
+ insertText("text", pos, ["name"]) Inserts the text "text" at the position "pos" into the text frame. Text must be UTF encoded (see setText() as reference) The first character has an index of 0. Inserting text at position -1 appends it to the frame. "name" If "name" is not given the currently selected Item is used. May throw IndexError for an insertion out of bounds.
? +++++ ^^^^^^^^^^^^^^^^^^^^^^^
|
|---|
| insertText("text", pos, ["name"]) Inserts the text "text" at the position "pos" into the text frame "name". Text must be UTF encoded (see setText() as reference) The first character has an index of 0. Inserting at position -1 appends text to the frame. If "name" is not given the currently selected Item is used. May throw IndexError for an insertion out of bounds. | insertText("text", pos, ["name"]) Inserts the text "text" at the position "pos" into the text frame. Text must be UTF encoded (see setText() as reference) The first character has an index of 0. Inserting text at position -1 appends it to the frame. "name" If "name" is not given the currently selected Item is used. May throw IndexError for an insertion out of bounds. |
| isLayerVisible | isLayerVisible | - isLayerPrintable("layer") -> bool Returns whether the layer "layer" is visible or not, a value of True means that the layer "layer" is visible, a value of False means that the layer "layer" is invisible. May raise NotFoundError if the layer can't be found. May raise ValueError if the layer name isn't acceptable.
? ^^^^^^
+ isLayerVisible("layer") -> bool Returns whether the layer "layer" is visible or not, a value of True means that the layer "layer" is visible, a value of False means that the layer "layer" is invisible. May raise NotFoundError if the layer can't be found. May raise ValueError if the layer name isn't acceptable.
? ^^^^
|
|---|
| isLayerPrintable("layer") -> bool Returns whether the layer "layer" is visible or not, a value of True means that the layer "layer" is visible, a value of False means that the layer "layer" is invisible. May raise NotFoundError if the layer can't be found. May raise ValueError if the layer name isn't acceptable. | isLayerVisible("layer") -> bool Returns whether the layer "layer" is visible or not, a value of True means that the layer "layer" is visible, a value of False means that the layer "layer" is invisible. May raise NotFoundError if the layer can't be found. May raise ValueError if the layer name isn't acceptable. |
| messageBox | messageBox | - messageBox("caption", "message", icon=ICON_NONE, button1=BUTTON_OK|BUTTONOPT_DEFAULT, button2=BUTTON_NONE, button3=BUTTON_NONE) -> integer Displays a message box with the title "caption", the message "message", and an icon "icon" and up to 3 buttons. By default no icon is used and a single button, OK, is displayed. Only the caption and message arguments are required, though setting an icon and appropriate button(s) is strongly recommended. The message text may contain simple HTML-like markup. Returns the number of the button the user pressed. Button numbers start at 1. For the icon and the button parameters there are predefined constants available with the same names as in the Qt Documentation. These are the BUTTON_* and ICON_* constants defined in the module. There are also two extra constants that can be binary-ORed with button constants: BUTTONOPT_DEFAULT Pressing enter presses this button. BUTTONOPT_ESCAPE Pressing escape presses this button. Usage examples: result = messageBox('Script failed', 'This script only works when you have a text frame selected.', ICON_ERROR) result = messageBox('Monkeys!', 'Something went ook! <i>Was it a monkey?</i>', ICON_WARNING, BUTTON_YES|BUTTONOPT_DEFAULT, BUTTON_NO, BUTTON_IGNORE|BUTTONOPT_ESCAPE) Defined button and icon constants: BUTTON_NONE, BUTTON_ABORT, BUTTON_CANCEL, BUTTON_IGNORE, BUTTON_NO, BUTTON_NOALL, BUTTON_OK, BUTTON_RETRY, BUTTON_YES, BUTTON_YESALL, ICON_NONE, ICON_INFORMATION, ICON_WARNING, ICON_CRITICAL.
? -- ^^ ^^^^^^ ^^ ^^ ^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^ ^^ ^^ ^^ - ^^ -- ^^ ---------- ---------- ---------- ---------- ^^
+ messageBox("caption", "message", icon=ICON_NONE, bucodeon1=BUTTON_OK|BUTTONOPT_DEFAULT, bucodeon2=BUTTON_NONE, bucodeon3=BUTTON_NONE) -> integer Displays a message box with the title "caption", the message "message", and an icon "icon" and up to 3 bucodeons. By default no icon is used and a single bucodeon, OK, is displayed. Only the caption and message arguments are required, though secodeing an icon and appropriate bucodeon(s) is strongly recommended. The message text may contain simple HTML-like markup. Returns the number of the bucodeon the user pressed. Bucodeon numbers start at 1. For the icon and the bucodeon parameters there are predefined constants available with the same names as in the Qt Documentation. These are the BUTTON_* and ICON_* constants defined in the module. There are also two extra constants that can be binary-ORed with bucodeon constants: BUTTONOPT_DEFAULT - Pressing enter presses this bucodeon. BUTTONOPT_ESCAPE - Pressing escape presses this bucodeon. Usage examples: result = messageBox('Script failed', 'This script only works when you have a text frame selected.', ICON_ERROR) result = messageBox('Monkeys!', 'Something went ook! <i>Was it a monkey?</i>', ICON_WARNING, BUTTON_YES|BUTTONOPT_DEFAULT, BUTTON_NO, BUTTON_IGNORE|BUTTONOPT_ESCAPE) Defined bucodeon and icon constants: BUTTON_NONE, BUTTON_ABORT, BUTTON_CANCEL, BUTTON_IGNORE, BUTTON_NO, BUTTON_NOALL, BUTTON_OK, BUTTON_RETRY, BUTTON_YES, BUTTON_YESALL, ICON_NONE, ICON_INFORMATION, ICON_WARNING, ICON_CRITICAL.
? ^^^^ ^^^^^^ ^^^^ ^^^^ ^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^ ^^^^ ^^^^ ^^^^ + ^^^^ + ^^^^ + + + ^^^^
|
|---|
| messageBox("caption", "message", icon=ICON_NONE, button1=BUTTON_OK|BUTTONOPT_DEFAULT, button2=BUTTON_NONE, button3=BUTTON_NONE) -> integer Displays a message box with the title "caption", the message "message", and an icon "icon" and up to 3 buttons. By default no icon is used and a single button, OK, is displayed. Only the caption and message arguments are required, though setting an icon and appropriate button(s) is strongly recommended. The message text may contain simple HTML-like markup. Returns the number of the button the user pressed. Button numbers start at 1. For the icon and the button parameters there are predefined constants available with the same names as in the Qt Documentation. These are the BUTTON_* and ICON_* constants defined in the module. There are also two extra constants that can be binary-ORed with button constants: BUTTONOPT_DEFAULT Pressing enter presses this button. BUTTONOPT_ESCAPE Pressing escape presses this button. Usage examples: result = messageBox('Script failed', 'This script only works when you have a text frame selected.', ICON_ERROR) result = messageBox('Monkeys!', 'Something went ook! <i>Was it a monkey?</i>', ICON_WARNING, BUTTON_YES|BUTTONOPT_DEFAULT, BUTTON_NO, BUTTON_IGNORE|BUTTONOPT_ESCAPE) Defined button and icon constants: BUTTON_NONE, BUTTON_ABORT, BUTTON_CANCEL, BUTTON_IGNORE, BUTTON_NO, BUTTON_NOALL, BUTTON_OK, BUTTON_RETRY, BUTTON_YES, BUTTON_YESALL, ICON_NONE, ICON_INFORMATION, ICON_WARNING, ICON_CRITICAL. | messageBox("caption", "message", icon=ICON_NONE, bucodeon1=BUTTON_OK|BUTTONOPT_DEFAULT, bucodeon2=BUTTON_NONE, bucodeon3=BUTTON_NONE) -> integer Displays a message box with the title "caption", the message "message", and an icon "icon" and up to 3 bucodeons. By default no icon is used and a single bucodeon, OK, is displayed. Only the caption and message arguments are required, though secodeing an icon and appropriate bucodeon(s) is strongly recommended. The message text may contain simple HTML-like markup. Returns the number of the bucodeon the user pressed. Bucodeon numbers start at 1. For the icon and the bucodeon parameters there are predefined constants available with the same names as in the Qt Documentation. These are the BUTTON_* and ICON_* constants defined in the module. There are also two extra constants that can be binary-ORed with bucodeon constants: BUTTONOPT_DEFAULT - Pressing enter presses this bucodeon. BUTTONOPT_ESCAPE - Pressing escape presses this bucodeon. Usage examples: result = messageBox('Script failed', 'This script only works when you have a text frame selected.', ICON_ERROR) result = messageBox('Monkeys!', 'Something went ook! <i>Was it a monkey?</i>', ICON_WARNING, BUTTON_YES|BUTTONOPT_DEFAULT, BUTTON_NO, BUTTON_IGNORE|BUTTONOPT_ESCAPE) Defined bucodeon and icon constants: BUTTON_NONE, BUTTON_ABORT, BUTTON_CANCEL, BUTTON_IGNORE, BUTTON_NO, BUTTON_NOALL, BUTTON_OK, BUTTON_RETRY, BUTTON_YES, BUTTON_YESALL, ICON_NONE, ICON_INFORMATION, ICON_WARNING, ICON_CRITICAL. |
| newDoc | newDoc | - newDoc(size, margins, orientation, firstPageNumber, unit, facingPages, firstSideLeft) -> bool WARNING: Obsolete procedure! Use newDocument instead. Creates a new document and returns true if successful. The parameters have the following meaning: size = A tuple (width, height) describing the size of the document. You can use predefined constants named PAPER_<paper_type> e.g. PAPER_A4 etc. margins = A tuple (left, right, top, bottom) describing the document margins orientation = the page orientation - constants PORTRAIT, LANDSCAPE firstPageNumer = is the number of the first page in the document used for pagenumbering. While you'll usually want 1, it's useful to have higher numbers if you're creating a document in several parts. unit: this value sets the measurement units used by the document. Use a predefined constant for this, one of: UNIT_INCHES, UNIT_MILLIMETERS, UNIT_PICAS, UNIT_POINTS. facingPages = FACINGPAGES, NOFACINGPAGES firstSideLeft = FIRSTPAGELEFT, FIRSTPAGERIGHT The values for width, height and the margins are expressed in the given unit for the document. PAPER_* constants are expressed in points. If your document is not in points, make sure to account for this. example: newDoc(PAPER_A4, (10, 10, 20, 20), LANDSCAPE, 1, UNIT_POINTS, FACINGPAGES, FIRSTPAGERIGHT)
? --------- ^^^^^^^ ------------------------------------------------------------------------------------------------------------------------------------------------ -- -- ^^^^^^^^^^^ ^^^^^^^^^^^^^^ ^^^^^^ -- -- -- -- -- -- --------
+ newDoc(size, margins, orientation, firstPageNumber, unit, facingPages, firstSideLeft) -> bool Creates a new document and returns true if successful. The parameters have the following meaning: size = A tuple (width, height) describing the size of the document. You can use predefined constants named PAPER_<paper_type> e.g. PAPER_A4 etc. margins = A tuple (left, right, top, bottom) describing the document margins orientation = the page orientation - constants PORTRAIT, LANDSCAPE firstPageNumber = is the number of the first page in the document used for page numbering. While you'll usually want 1, it's useful to have higher numbers if you're creating a document in several parts. unit: this value sets the measurement units used by the document. Use a predefined constant for this, one of: UNIT_INCHES, UNIT_MILLIMETERS, UNIT_PICAS, UNIT_POINTS. facingPages = FACINGPAGES, NOFACINGPAGES firstSideLeft = FIRSTPAGELEFT, FIRSTPAGERIGHT The values for width, height and the margins are expressed in the given unit for the document. PAPER_* constants are expressed in points. If your document is not in points, make sure to account for this. example: newDoc(PAPER_A4, (10, 10, 20, 20), LANDSCAPE, 1, UNIT_POINTS, FACINGPAGES, FIRSTPAGERIGHT)
? ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^ ^^^^^^^^^^^^^ ^^^^^ +
|
|---|
| newDoc(size, margins, orientation, firstPageNumber, unit, facingPages, firstSideLeft) -> bool WARNING: Obsolete procedure! Use newDocument instead. Creates a new document and returns true if successful. The parameters have the following meaning: size = A tuple (width, height) describing the size of the document. You can use predefined constants named PAPER_<paper_type> e.g. PAPER_A4 etc. margins = A tuple (left, right, top, bottom) describing the document margins orientation = the page orientation - constants PORTRAIT, LANDSCAPE firstPageNumer = is the number of the first page in the document used for pagenumbering. While you'll usually want 1, it's useful to have higher numbers if you're creating a document in several parts. unit: this value sets the measurement units used by the document. Use a predefined constant for this, one of: UNIT_INCHES, UNIT_MILLIMETERS, UNIT_PICAS, UNIT_POINTS. facingPages = FACINGPAGES, NOFACINGPAGES firstSideLeft = FIRSTPAGELEFT, FIRSTPAGERIGHT The values for width, height and the margins are expressed in the given unit for the document. PAPER_* constants are expressed in points. If your document is not in points, make sure to account for this. example: newDoc(PAPER_A4, (10, 10, 20, 20), LANDSCAPE, 1, UNIT_POINTS, FACINGPAGES, FIRSTPAGERIGHT) | newDoc(size, margins, orientation, firstPageNumber, unit, facingPages, firstSideLeft) -> bool Creates a new document and returns true if successful. The parameters have the following meaning: size = A tuple (width, height) describing the size of the document. You can use predefined constants named PAPER_<paper_type> e.g. PAPER_A4 etc. margins = A tuple (left, right, top, bottom) describing the document margins orientation = the page orientation - constants PORTRAIT, LANDSCAPE firstPageNumber = is the number of the first page in the document used for page numbering. While you'll usually want 1, it's useful to have higher numbers if you're creating a document in several parts. unit: this value sets the measurement units used by the document. Use a predefined constant for this, one of: UNIT_INCHES, UNIT_MILLIMETERS, UNIT_PICAS, UNIT_POINTS. facingPages = FACINGPAGES, NOFACINGPAGES firstSideLeft = FIRSTPAGELEFT, FIRSTPAGERIGHT The values for width, height and the margins are expressed in the given unit for the document. PAPER_* constants are expressed in points. If your document is not in points, make sure to account for this. example: newDoc(PAPER_A4, (10, 10, 20, 20), LANDSCAPE, 1, UNIT_POINTS, FACINGPAGES, FIRSTPAGERIGHT) |
| newPage | newPage | - newPage(where [,"masterpage"]) Creates a new page. If "where" is -1 the new Page is appended to the document, otherwise the new page is inserted before "where". Page numbers are counted from 1 upwards, no matter what the displayed first page number of your document is. The optional parameter "masterpage" specifies the name of the master page for the new page. May raise IndexError if the page number is out of range
? ^^^^^^^^^ ^^^^^^^^^ ^^^^^^
+ newPage(where [,"template"]) Creates a new page. If "where" is -1 the new Page is appended to the document, otherwise the new page is inserted before "where". Page numbers are counted from 1 upwards, no matter what the displayed first page number of your document is. The optional parameter "template" specifies the name of the template page for the new page. May raise IndexError if the page number is out of range
? ^^^^^^^ ^^^^^^^ ^^^^^^^^
|
|---|
| newPage(where [,"masterpage"]) Creates a new page. If "where" is -1 the new Page is appended to the document, otherwise the new page is inserted before "where". Page numbers are counted from 1 upwards, no matter what the displayed first page number of your document is. The optional parameter "masterpage" specifies the name of the master page for the new page. May raise IndexError if the page number is out of range | newPage(where [,"template"]) Creates a new page. If "where" is -1 the new Page is appended to the document, otherwise the new page is inserted before "where". Page numbers are counted from 1 upwards, no matter what the displayed first page number of your document is. The optional parameter "template" specifies the name of the template page for the new page. May raise IndexError if the page number is out of range |
| progressReset | progressReset | - progressReset() Cleans up the Scribus progress bar previous settings. It is called before the new progress bar use. See progressSet.
? ^^
+ progressReset() Cleans up the Scribus progress bar previous secodeings. It is called before the new progress bar use. See progressSet.
? ^^^^
|
|---|
| progressReset() Cleans up the Scribus progress bar previous settings. It is called before the new progress bar use. See progressSet. | progressReset() Cleans up the Scribus progress bar previous secodeings. It is called before the new progress bar use. See progressSet. |
| renderFont | renderFont | - renderFont("name", "filename", "sample", size, format="PPM") -> bool Creates an image preview of font "name" with given text "sample" and size. If "filename" is not "", image is saved into "filename". Otherwise image data is returned as a string. The optional "format" argument specifies the image format to generate, and supports any format allowed by QPixmap.save(). Common formats are PPM, JPEG, PNG and XPM. May raise NotFoundError if the specified font can't be found. May raise ValueError if an empty sample or filename is passed.
? - ------------------------- ^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+ rendeFont("name", "filename", "sample", size, format="PPM") -> bool Creates an image preview of font "name" with given text "sample" and size. Image is saved into "filename". Returns true when success. The optional "format" argument specifies the image format to generate, and supports any format allowed by QPixmap.save(). Common formats are PPM, JPEG, PNG and XPM. May raise NotFoundError if the specified font can't be found. May raise ValueError if an empty sample or filename is passed.
? ^^^^^^^^^^^^^^ ^^^^^^^^^
|
|---|
| renderFont("name", "filename", "sample", size, format="PPM") -> bool Creates an image preview of font "name" with given text "sample" and size. If "filename" is not "", image is saved into "filename". Otherwise image data is returned as a string. The optional "format" argument specifies the image format to generate, and supports any format allowed by QPixmap.save(). Common formats are PPM, JPEG, PNG and XPM. May raise NotFoundError if the specified font can't be found. May raise ValueError if an empty sample or filename is passed. | rendeFont("name", "filename", "sample", size, format="PPM") -> bool Creates an image preview of font "name" with given text "sample" and size. Image is saved into "filename". Returns true when success. The optional "format" argument specifies the image format to generate, and supports any format allowed by QPixmap.save(). Common formats are PPM, JPEG, PNG and XPM. May raise NotFoundError if the specified font can't be found. May raise ValueError if an empty sample or filename is passed. |
| rotateObjectAbs | rotateObjectAbs | - rotateObjectAbs(rot [, "name"]) Sets the rotation of the object "name" to "rot". Positve values mean counter clockwise rotation. If "name" is not given the currently selected item is used.
+ rotateObjectAbs(rot [, "name"]) Sets the rotation of the object "name" to "rot". Positive values mean counter clockwise rotation. If "name" is not given the currently selected item is used.
? +
|
|---|
| rotateObjectAbs(rot [, "name"]) Sets the rotation of the object "name" to "rot". Positve values mean counter clockwise rotation. If "name" is not given the currently selected item is used. | rotateObjectAbs(rot [, "name"]) Sets the rotation of the object "name" to "rot". Positive values mean counter clockwise rotation. If "name" is not given the currently selected item is used. |
| setHGuides | setHGuides | - setHGuides(list) Sets horizontal guides. Input parameter must be a list of guide positions measured in the current document units - see UNIT_<type> constants. Example: setHGuides(getHGuides() + [200.0, 210.0] # add new guides without any lost setHGuides([90,250]) # replace current guides entirely
? ----
+ setHGuides(list) Sets horizontal guides. Input parameter must be a list of guide positions measured in the current document units - see UNIT_<type> constants. Example: setHGuides(getHGuides() + [200.0, 210.0] # add new guides without any lost setHGuides([90,250]) # replace current guides entirely |
|---|
| setHGuides(list) Sets horizontal guides. Input parameter must be a list of guide positions measured in the current document units - see UNIT_<type> constants. Example: setHGuides(getHGuides() + [200.0, 210.0] # add new guides without any lost setHGuides([90,250]) # replace current guides entirely | setHGuides(list) Sets horizontal guides. Input parameter must be a list of guide positions measured in the current document units - see UNIT_<type> constants. Example: setHGuides(getHGuides() + [200.0, 210.0] # add new guides without any lost setHGuides([90,250]) # replace current guides entirely |
| setInfo | setInfo | - setInfo("author", "info", "description") -> bool Sets the document information. "Author", "Info", "Description" are strings.
? ^^^^
+ saveDocAs("author", "info", "description") -> bool Sets the document information. "Author", "Info", "Description" are strings.
? ++ ^ +++
|
|---|
| setInfo("author", "info", "description") -> bool Sets the document information. "Author", "Info", "Description" are strings. | saveDocAs("author", "info", "description") -> bool Sets the document information. "Author", "Info", "Description" are strings. |
| setLayerPrintable | setLayerPrintable | - setLayerPrintable("layer", printable) Sets the layer "layer" to be printable or not. If printable is set to false the layer won't be printed. May raise NotFoundError if the layer can't be found. May raise ValueError if the layer name isn't acceptable.
? ^^^^^^^^^^^^
+ setLayerPrintable("layer", printable) Sets the layer "layer" to be printable or not. If is the printable set to false the layer won't be printed. May raise NotFoundError if the layer can't be found. May raise ValueError if the layer name isn't acceptable.
? ^^^^^^^^^^^^^^^^
|
|---|
| setLayerPrintable("layer", printable) Sets the layer "layer" to be printable or not. If printable is set to false the layer won't be printed. May raise NotFoundError if the layer can't be found. May raise ValueError if the layer name isn't acceptable. | setLayerPrintable("layer", printable) Sets the layer "layer" to be printable or not. If is the printable set to false the layer won't be printed. May raise NotFoundError if the layer can't be found. May raise ValueError if the layer name isn't acceptable. |