ScripterNG/Development/PortingOldScripter gsoc2011: Difference between revisions

From Scribus Wiki
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
==Document related commands==
[[Category:Scribus]] ==Document related commands== filename : cmddoc.h, cmddoc.cpp reference : http://docs.scribus.net/index.php?lang=en&page=scripterapi-doc {| class="wikitable" |- ! Command in old scripter !! Speculated 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 || 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  {| class="wikitable"  |-  ! Command in old scripter !! Speculated 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(...) ||  ||  || || |}
filename : cmddoc.h, cmddoc.cpp
 
reference : http://docs.scribus.net/index.php?lang=en&page=scripterapi-doc
{| class="wikitable"
|-
! Command in old scripter !! Speculated 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 || 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
|}

Revision as of 07:51, 17 May 2011

==Document related commands==  filename : cmddoc.h, cmddoc.cpp  reference : http://docs.scribus.net/index.php?lang=en&page=scripterapi-doc  {| class="wikitable"  |-  ! Command in old scripter !! Speculated 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 || 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  {| class="wikitable"  |-  ! Command in old scripter !! Speculated 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(...) ||  ||  || || |}