Difference between revisions of "Discovering an Item's Properties"

From Scribus Wiki
Jump to: navigation, search
Line 11: Line 11:
 
* [[Image Wizard: Scale and Align an Image]]
 
* [[Image Wizard: Scale and Align an Image]]
  
This script has been tested in Scribus 1.3.3.9 and 1.3.4.
+
This script has been updated for Scribus 1.4.0.
  
 
Save this script as ItemProperties.py, for example.
 
Save this script as ItemProperties.py, for example.
Line 20: Line 20:
 
     nbrSelected = selectionCount()
 
     nbrSelected = selectionCount()
  
objList = []
+
    objList = []
  
for i in range(nbrSelected):
+
    for i in range(nbrSelected):
    objList.append(getSelectedObject(i))
+
        objList.append(getSelectedObject(i))
+
       
for i in range(nbrSelected):
+
    for i in range(nbrSelected):
    try:
+
        try:
        obj = objList[i]
+
            obj = objList[i]
        props = ""
+
            props = ""
        propList = getPropertyNames(obj)
+
            propList = getPropertyNames(obj)
        for p in propList:
+
            for p in propList:
            props = props + p + " (" + str(getPropertyCType(obj, p) + "): " + str(getProperty(obj, p))) + "\n"
+
                try:
        messageBox("Property Info for " + obj, "Below is a property list for the selected object named " + obj + "\n" + props, ICON_INFORMATION)
+
                    props = props + p + " (" + str(getPropertyCType(obj, p)) + "): "
    except WrongFrameTypeError:
+
                    props = props + str(getProperty(obj, p))
    nothing = "nothing"
+
                except:
 +
                    nothing = "nothing"
 +
                props = props + "\n"
 +
            messageBox("Property Info for " + obj, "Below is a property list for the selected object named " + obj + "\n" + props, ICON_INFORMATION)
 +
        except WrongFrameTypeError:
 +
            nothing = "nothing"
 
</nowiki></pre>
 
</nowiki></pre>

Revision as of 22:52, 25 March 2012

This article is part of the Scripts series.

By selecting a Scribus object (image, line, textbox, etc.) and running this script, you can see the item's properties that are available to your script. This saves you having to dig through the C++ code, if you're not into that kind of thing.

Once you know what properties are available, you can try accessing them in your script by using the getProperty(objectName, propertyName) and setProperty(objectName, propertyName, propertyValue) functions. This lets you change quite a few more object properties than are exposed through the other Scripter API functions.

Please note that using the setProperty() function may not always have the effect your are looking for. Changing a value using setProperty() doesn't trigger any other effects that might happen when change the value in Scribus using the GUI. However, some things do work, as you can see by running these scripts:

This script has been updated for Scribus 1.4.0.

Save this script as ItemProperties.py, for example.

from scribus import *

if haveDoc():
    nbrSelected = selectionCount()

    objList = []

    for i in range(nbrSelected):
        objList.append(getSelectedObject(i))
        
    for i in range(nbrSelected):
        try:
            obj = objList[i]
            props = ""
            propList = getPropertyNames(obj)
            for p in propList:
                try:
                    props = props + p + " (" + str(getPropertyCType(obj, p)) + "): "
                    props = props + str(getProperty(obj, p))
                except:
                    nothing = "nothing"
                props = props + "\n"
            messageBox("Property Info for " + obj, "Below is a property list for the selected object named " + obj + "\n" + props, ICON_INFORMATION)
        except WrongFrameTypeError:
            nothing = "nothing"