Methods
|
|
|
|
__init__
|
__init__ (
self,
parent=None,
filename=None,
)
Constructor
Arguments
- parent
- parent widget (usually the ui object) (QWidget)
- filename
- optional filename of a project file to open (string)
|
|
addDirectory
|
addDirectory ( self, filter )
Private method used to add all files of a directory to the project.
Arguments
- filter
- filter to be applied (string)
|
|
addFile
|
addFile ( self, filter=None )
Public slot used to add a file to the project.
Arguments
- filter
- filter to be used by the add file dialog (string)
|
|
addLanguage
|
addLanguage ( self )
Public slot used to add a language to the project.
|
|
addPyDir
|
addPyDir ( self )
Public slot to add all python files of a directory to the current project.
|
|
addPyFile
|
addPyFile ( self )
Public slot to add a python file to the current project.
|
|
addRecursiveDirectory
|
addRecursiveDirectory (
self,
filter,
source,
target,
)
Private method used to add all files of a directory tree.
The tree is rooted at source to another one rooted at target. This
method decents down to the lowest subdirectory.
Arguments
- filter
- filter to be applied (string)
- source
- source directory (string)
- target
- target directory (string)
|
|
addSingleDirectory
|
addSingleDirectory (
self,
filter,
source,
target,
quiet=0,
)
Private method used to add all files of a single directory to the project.
Arguments
- filter
- filter to be applied (string)
- source
- source directory (string)
- target
- target directory (string)
- quiet
- flag indicating quiet operations (boolean)
|
|
addUiDir
|
addUiDir ( self )
Public slot to add all forms of a directory to the current project.
|
|
addUiFile
|
addUiFile ( self )
Public slot to add a form to the current project.
|
|
appendFile
|
appendFile ( self, fn )
Public method to append a file to the project.
Arguments
- fn
- filename to be added to the project (string or QString)
|
|
checkDirty
|
checkDirty ( self )
Private method to check dirty status and open a message window.
Returns
flag indicating whether this operation was successful
|
|
checkFilesExist
|
checkFilesExist ( self, index )
Private method to check, if the files in a list exist.
The files in the indicated list are checked for existance in the
filesystem. Non existant files are removed from the list and the
dirty state of the project is changed accordingly.
Arguments
- index
- key of the list to be checked (string)
|
|
closeProject
|
closeProject ( self )
Public slot to close the current project.
|
|
deleteFile
|
deleteFile ( self, fn )
Public slot to delete a file from the project directory.
Arguments
- fn
- filename to be deleted from the project
Returns
flag indicating success
|
|
deleteLanguage
|
deleteLanguage ( self, lang )
Public slot to delete a translation from the project directory.
Arguments
- lang
- the language to be removed (string)
Returns
flag indicating success
|
|
getMainScript
|
getMainScript ( self, normalized=0 )
Public method to return the main script filename.
Arguments
- normalized
- flag indicating a normalized filename is wanted
Returns
filename of the projects main script (string)
|
|
getSources
|
getSources ( self, normalized=0 )
Public method to return the source script files.
Arguments
- normalized
- flag indicating a normalized filename is wanted
Returns
list of the projects scripts (list of string)
|
|
handleClearRecent
|
handleClearRecent ( self )
Private method to clear the recent projects menu.
|
|
handleOpenRecent
|
handleOpenRecent ( self, idx )
Private method to open a project from the list of rencently opened projects.
|
|
handleSearchNewFiles
|
handleSearchNewFiles ( self )
Private slot used to handle the search new files action.
|
|
handleShowRecentMenu
|
handleShowRecentMenu ( self )
Private method to set up the recent projects menu.
|
|
handleShowVCSMenu
|
handleShowVCSMenu ( self )
Private slot called befor the project menu is shown.
|
|
init
|
init ( self )
Private method to initialize the project data part.
|
|
initActions
|
initActions ( self )
Public slot to initialize the project related actions.
|
|
initMenu
|
initMenu ( self )
Public slot to initialize the project menu.
Returns
the menu generated (QPopupMenu)
|
|
initToolbar
|
initToolbar ( self )
Public slot to initialize the project toolbar.
Returns
the toolbar generated (QToolBar)
|
|
initVCS
|
initVCS ( self, vcsSystem=None )
Private method used to instantiate a vcs system.
Arguments
- vcsSystem
- type of VCS to be used
Returns
a reference to the vcs object
|
|
initVCSActions
|
initVCSActions ( self )
Private method to initialize the VCS actions.
|
|
initVCSMenu
|
initVCSMenu ( self )
Private method called to build the project VCS submenu.
Returns
the generated menu (QPopupMenu)
|
|
isDirty
|
isDirty ( self )
Public method to return the dirty state.
Returns
dirty state (boolean)
|
|
isOpen
|
isOpen ( self )
Public method to return the opened state.
Returns
open state (boolean)
|
|
newProject
|
newProject ( self )
Public slot to built a new project.
This method displays the new project dialog and initializes
the project object with the data entered. If version control
support was selected, the relevant structures are initialzed
as well.
|
|
openProject
|
openProject ( self, fn=None )
Public slot to open a project.
Arguments
- fn
- optional filename of the project file to be read
|
|
ossepToToken
|
ossepToToken ( self, filelist )
Private method to ensure OS independance of the project file.
This method converts the pathname separator (os.sep)
to a platform neutral token (%os.sep%).
Arguments
- filelist
- list of filenames to convert (list of strings)
Returns
the converted filelist
|
|
othersAdded
|
othersAdded ( self, fn )
Public slot to be called, if something was added to the OTHERS project data area.
Arguments
- fn
- filename or directory name added (string or QString)
|
|
readProject
|
readProject ( self, fn )
Public method to read in a project (.e3p) file.
Arguments
- fn
- filename of the project file to be read (string or QString)
Returns
flag indicating success
|
|
readSession
|
readSession ( self, quiet=0 )
Private method to read in the project session file (.e3s)
The data read is:
- all open source filenames (fn:)
- the active window (aw:)
- all breakpoints (bp:)
- the commandline (cl:)
- the working directory (wd:)
- the exception reporting flag (er:)
- the list of exception types to be highlighted (ex:)
Arguments
- quiet
- flag indicating quiet operations.
If this flag is true, no errors are reported.
|
|
removeFile
|
removeFile ( self, fn )
Public slot to remove a file from the project.
The file is not deleted from the project directory.
Arguments
- fn
- filename to be removed from the project
|
|
removeLanguage
|
removeLanguage ( self, lang )
Public slot to remove a translation from the project.
The translation file is not deleted from the project directory.
Arguments
- lang
- the language to be removed (string)
|
|
saveAllScripts
|
saveAllScripts ( self )
Public method to save all scripts belonging to the project.
Returns
flag indicating success
|
|
saveProject
|
saveProject ( self )
Public slot to save the current project.
Returns
flag indicating success
|
|
saveProjectAs
|
saveProjectAs ( self )
Public slot to save the current project to a different file.
Returns
flag indicating success
|
|
searchNewFiles
|
searchNewFiles (
self,
AI=1,
onUserDemand=0,
)
Private method to search for new files in the project directory.
If new files were found it shows a dialog listing these files and
gives the user the oportunity to select the ones he wants to
include. If Automatic Inclusion is enabled, the new files are
automatically added to the project.
Arguments
- AI
- flag indicating whether the automatic inclusion should
be honoured
- onUserDemand
- flag indicating whether this method was
requested by the user via a menu action
|
|
setDbgInfo
|
setDbgInfo (
self,
argv,
wd,
excReporting,
excList,
)
Public method to set the debugging information.
Arguments
- argv
- command line arguments to be used (string or QString)
- wd
- working directory (string or QString)
- excReporting
- flag indicating the highlighting of exceptions
- excList
- list of exceptions to be highlighted (list of string)
|
|
setDirty
|
setDirty ( self, b )
Private method to set the dirty state.
It emits the signal dirty(int).
Arguments
- b
- dirty state (boolean)
|
|
showProperties
|
showProperties ( self )
Public slot to display the properties dialog.
|
|
spaceToToken
|
spaceToToken ( self, filelist )
Private method to ensure OS independance of the project file.
This method converts a space to a token (%20).
Arguments
- filelist
- list of filenames to convert (list of strings)
Returns
the converted filelist
|
|
tokenToOssep
|
tokenToOssep ( self, filelist )
Private method to ensure OS independance of the project file.
This method converts the platform neutral separator token
(%os.sep%) to the pathname separator (os.sep).
Arguments
- filelist
- list of filenames to convert (list of strings)
Returns
the converted filelist
|
|
tokenToSpace
|
tokenToSpace ( self, filelist )
Private method to ensure OS independance of the project file.
This method converts the space token (%20) to a space.
Arguments
- filelist
- list of filenames to convert (list of strings)
Returns
the converted filelist
|
|
vcsCheckout
|
vcsCheckout ( self, export=0 )
Private slot used to create a local project from the repository.
Arguments
- export
- flag indicating whether an export or a checkout
should be performed
|
|
vcsCommandOptions
|
vcsCommandOptions ( self )
Private slot to edit the VCS command options.
|
|
vcsCommit
|
vcsCommit ( self )
Private slot used to commit changes to the local project to the repository.
|
|
vcsDiff
|
vcsDiff ( self )
Private slot used to show the difference of the local project to the repository.
|
|
vcsExport
|
vcsExport ( self )
Private slot used to export a project from the repository.
|
|
vcsHistory
|
vcsHistory ( self )
Private slot used to show the history of the local project.
|
|
vcsImport
|
vcsImport ( self )
Private slot used to import the local project into the repository.
NOTE:
This does not make the local project a vcs controlled project.
You have to checkout the project from the repository in order
to accomplish that.
|
|
vcsLog
|
vcsLog ( self )
Private slot used to show the log of the local project.
|
|
vcsLogin
|
vcsLogin ( self )
Private slot used to login to a remote repository.
|
|
vcsLogout
|
vcsLogout ( self )
Private slot used to logout from a remote repository.
|
|
vcsRemove
|
vcsRemove ( self )
Private slot used to remove the local project from the repository.
Depending on the parameters set in the vcs object the project
may be removed from the local disk as well.
|
|
vcsTag
|
vcsTag ( self )
Private slot used to tag the local project in the repository.
|
|
vcsUpdate
|
vcsUpdate ( self )
Private slot used to update the local project from the repository.
|
|
writeProject
|
writeProject ( self, fn=None )
Public method to save the project infos to a project file.
Arguments
- fn
- optional filename of the project file to be written.
If fn is None, the filename stored in the project object
is used. This is the
save action. If fn is given, this filename
is used instead of the one in the project object. This is the
save as action.
Returns
flag indicating success
|
|
writeSession
|
writeSession ( self, quiet=0 )
Private method to write the session data to a file (.e3s).
The data save is:
- all open source filenames (fn:)
- the active window, if it belongs to the project (aw:)
- all breakpoints (bp:)
- the commandline (cl:)
- the working directory (wd:)
- the exception reporting flag (er:)
- the list of exception types to be highlighted (ex:)
Arguments
- quiet
- flag indicating quiet operations.
If this flag is true, no errors are reported.
|