ScripterNG/Development/PortingOldScripter gsoc2011: Difference between revisions

From Scribus Wiki
Jump to navigation Jump to search
 
(14 intermediate revisions by 2 users not shown)
Line 1: Line 1:
==Document API==
[[Category:GSOC 2011]]
Object name : Scripter.activeDocument
==Document related commands==


{| class="wikitable"
filename : cmddoc.h, cmddoc.cpp
|-
! Old Scripter Func/Prop Name !! Filename (in old scripter) !! Scripter2
|-
| closedoc || cmddoc.cpp || Scripter.activeDocument.close()
|-
| havedoc || cmddoc.cpp || Scripter.activeDocument.available()
|-
| setmargins || cmddoc.cpp || Scripter.activeDocument.margins.set(..)
|-
| selcount || cmdmani.cpp || Scripter.activeDocument.selection
|-
| pagedimension || cmdpage.cpp || Scripter.activeDocument.dimensions
|-
| getpagemargins || cmdpage.cpp || Scripter.activeDocument.margins
|-


| getpageitems || cmdpage.cpp || Scripter.activeDocument.items
reference : http://docs.scribus.net/index.php?lang=en&page=scripterapi-doc 
|-
{| class="wikitable" 
|- 
! Command in old scripter !! Proposed method/property in Scripter2 !! Proposed API !! Status 
|- 
| closeDoc(...) || Scripter.activeDocument.close() || Document || done 
|- 
| docChanged(...) || Scripter.activeDocument.setModified(bool) || Document || done 
|- 
| getUnit(...) || Scripter.activeDocument.getUnit || Document || not done 
|- 
| haveDoc(...) || Scripter.activeDocument.available<br>''a.l.e:not sure about it; IMO it should be at the same place as newDocument()''|| Document || done 
|- 
| loadStylesFromFile(...) || Scripter.activeDocument.loadStylesFromFile(...) || Document || not done 
|- 
| masterPageNames(...) || Scripter.activeDocument.masterPageNames || Document || not done 
|- 
| newDocument(...) || Scripter.newDocument(...) || ScripterImpl || done 
|- 
| openDoc(...) || Scripter.openDocument(...) || ScripterImpl || done 
|- 
| placeEPS(...) || Scripter.activeDocument.activePage.placeEPS(...) || Page || done 
|- 
| placeODG(...) || Scripter.activeDocument.activePage.placeODG(...) || Page || done 
|- 
| placeSVG(...) || Scripter.activeDocument.activePage.placeSVG(...) || Page || done 
|- 
| placeSXD(...) || Scripter.activeDocument.activePage.placeSXD(...) || Page || done 
|- 
| saveDoc() || Scripter.activeDocument.saveDocument() || Document || not done 
|- 
| saveDocumentAs(...) || Scripter.activeDocument.saveDocumentAs(...) || Document || not done 
|- 
| setInfo(...) || Scripter.activeDocument.setInformation(...) || Document || not done 
|- 
| setMargins(...) || Scripter.activeDocument.margins.set(...) || Document || done 
|- 
| setDocType(...) || Scripter.activeDocument.setDocType(...) || Document || not done 
|-
| setUnit(...) || Scripter.activeDocument.setUnit(...) || Document || not done 
|- 
| setBaseLine(...) || Scripter.activeDocument.setBaseLine(...) || Document || not done 
|- 
| scrollDocument(...) || Scripter.activeWindow.scroll(...) || Window || done 
|- 
| zoomDocument(...) || Scripter.activeWindow.setZoom(...) || Window || done 
|}


| docchanged || guiapp.cpp || Scripter.activeDocument.modified
==Page related commands== 
|-
 
| getallobj || cmdgetprop.cpp || Scripter.activeDocument.items
filename: cmdpage.h, cmdpage.cpp 
 
reference: http://docs.scribus.net/index.php?lang=en&page=scripterapi-page 
 
{| class="wikitable" 
|- 
! Command in old scripter !! Proposed method/property in Scripter2 !! Proposed API !! Status !! Notes 
|- 
| closeMasterPage(...) || Scripter.activeDocument.closeMasterPage() || Document || not done || 
|-
| createMasterPage(...) || Scripter.activeDocument.createMasterPage() || Document || not done || 
|- 
| currentPage(...) || Scripter.activeDocument.activePage.pageNumber || Page || not done || ''in old scripter, this return number of current working page. should this do the same in Scripter2 ?'' 
|- 
| deleteMasterPage(...) ||  ||  || ||
|- 
| deletePage(...) ||  ||  || ||
|- 
| editMasterPage(...) ||  ||  || ||
|- 
| getHGuides(...) ||  ||  || ||
|- 
| getPageType(...) ||  ||  || ||
|- 
| getVGuides(...) ||  ||  || ||
|- 
| getPageItems() ||  ||  || ||
|- 
| getPageMargins(...) ||  ||  || ||
|- 
| getPageNMargins(...) ||  ||  || ||
|- 
| getPageSize(...) ||  ||  || ||
|- 
| getPageNSize(...) ||  ||  || ||
|- 
| gotoPage(...) ||  ||  || ||
|- 
| importPage(...) ||  ||  || ||
|- 
| newPage(...) ||  ||  || ||
|- 
| pageCount(...) ||  ||  || ||
|- 
| redrawAll(...) ||  ||  || ||
|- 
| savePageAsEPS(...) ||  ||  || ||
|- 
| setHGuides(...) ||  ||  || ||
|- 
| setRedraw(...) ||  ||  || ||
|- 
| setVGuides(...) ||  ||  || ||
|}
|}

Latest revision as of 02:47, 30 December 2013

Document related commands

filename : cmddoc.h, cmddoc.cpp

reference : http://docs.scribus.net/index.php?lang=en&page=scripterapi-doc

Command in old scripter Proposed method/property in Scripter2 Proposed API Status
closeDoc(...) Scripter.activeDocument.close() Document done
docChanged(...) Scripter.activeDocument.setModified(bool) Document done
getUnit(...) Scripter.activeDocument.getUnit Document not done
haveDoc(...) Scripter.activeDocument.available
a.l.e:not sure about it; IMO it should be at the same place as newDocument()		 Document done
loadStylesFromFile(...) Scripter.activeDocument.loadStylesFromFile(...) Document not done
masterPageNames(...) Scripter.activeDocument.masterPageNames Document not done
newDocument(...) Scripter.newDocument(...) ScripterImpl done
openDoc(...) Scripter.openDocument(...) ScripterImpl done
placeEPS(...) Scripter.activeDocument.activePage.placeEPS(...) Page done
placeODG(...) Scripter.activeDocument.activePage.placeODG(...) Page done
placeSVG(...) Scripter.activeDocument.activePage.placeSVG(...) Page done
placeSXD(...) Scripter.activeDocument.activePage.placeSXD(...) Page done
saveDoc() Scripter.activeDocument.saveDocument() Document not done
saveDocumentAs(...) Scripter.activeDocument.saveDocumentAs(...) Document not done
setInfo(...) Scripter.activeDocument.setInformation(...) Document not done
setMargins(...) Scripter.activeDocument.margins.set(...) Document done
setDocType(...) Scripter.activeDocument.setDocType(...) Document not done
setUnit(...) Scripter.activeDocument.setUnit(...) Document not done
setBaseLine(...) Scripter.activeDocument.setBaseLine(...) Document not done
scrollDocument(...) Scripter.activeWindow.scroll(...) Window done
zoomDocument(...) Scripter.activeWindow.setZoom(...) Window done

Page related commands

filename: cmdpage.h, cmdpage.cpp

reference: http://docs.scribus.net/index.php?lang=en&page=scripterapi-page

Command in old scripter Proposed method/property in Scripter2 Proposed API Status Notes
closeMasterPage(...) Scripter.activeDocument.closeMasterPage() Document not done
createMasterPage(...) Scripter.activeDocument.createMasterPage() Document not done
currentPage(...) Scripter.activeDocument.activePage.pageNumber Page not done in old scripter, this return number of current working page. should this do the same in Scripter2 ?
deleteMasterPage(...)
deletePage(...)
editMasterPage(...)
getHGuides(...)
getPageType(...)
getVGuides(...)
getPageItems()
getPageMargins(...)
getPageNMargins(...)
getPageSize(...)
getPageNSize(...)
gotoPage(...)
importPage(...)
newPage(...)
pageCount(...)
redrawAll(...)
savePageAsEPS(...)
setHGuides(...)
setRedraw(...)
setVGuides(...)
Retrieved from "https://wiki.scribus.net/wiki/index.php?title=ScripterNG/Development/PortingOldScripter_gsoc2011&oldid=29349"