|
Methods defined here:
- About(self, widget=None)
- Creates and shows the "About" dialog box.
Parameters:
widget -- reserved for GTK callbacks, don't use it explicitly.
- AboutLinkActivate(self, widget, link)
- Opens the Jokosher website in the user's default web browser.
Parameters:
widget -- reserved for GTK callbacks, don't use it explicitly.
- CheckGstreamerVersions(self)
- Check for CVS versions of Gstreamer and gnonlin. If requirements are not met,
a warning message is issued to the user.
- ClearStatusBar(self, messageID)
- Clears the status bar text in the position pointed by messageID.
Parameters:
messageID -- the message identifier of the text to be cleared.
- CloseProject(self)
- Closes the current project. If there's changes pending, it'll ask the user for confirmation.
Returns:
the status of the close operation:
0 = there was no project open or it was closed succesfully.
1 = cancel the operation and return to the normal program flow.
- GetDistroVersion(self)
- Obtain a string with the distribution name and version.
Returns:
A string with the distribution name and version.
- OnAddAudio(self, widget)
- Adds an audio file to the selected Instrument.
Parameters:
widget -- reserved for GTK callbacks, don't use it explicitly.
- OnAddAudioFile(self, widget=None)
- Called when the "Add Audio File Instrument" in the project menu is clicked.
Parameters:
widget -- reserved for GTK callbacks, don't use it explicitly.
- OnChangeInstrument(self, widget=None)
- Changes the type of the selected Instrument.
Parameters:
widget -- reserved for GTK callbacks, don't use it explicitly.
- OnCloseProject(self, widget=None)
- Closes the current project by calling CloseProject().
Parameters:
widget -- reserved for GTK callbacks, don't use it explicitly.
- OnCompactMixView(self, button=None)
- Updates the main window after switching to the compact view mixing mode.
Parameters:
button -- Button object calling this method.
- OnContributingDialog(self, widget)
- Creates and shows the "Contributing to Jokosher" dialog.
Parameters:
widget -- reserved for GTK callbacks, don't use it explicitly.
- OnContributingLinkButtonClicked(self, widget)
- Opens the Jokosher contributing website in the user's default web browser.
Parameters:
widget -- reserved for GTK callbacks, don't use it explicitly.
- OnCopy(self, widget=None)
- Copies the portion of selected audio to the clipboard.
Parameters:
widget -- reserved for GTK callbacks, don't use it explicitly.
- OnCut(self, widget=None, cut=True)
- Cuts the portion of selected audio and puts it in the clipboard.
Parameters:
widget -- reserved for GTK callbacks, don't use it explicitly.
cut -- determines whether the operation should perform a cut or copy operation:
True = perform a cut operation.
False = perform a copy operation.
- OnDelete(self, widget=None)
- Deletes the currently selected instruments or events.
Parameters:
widget -- reserved for GTK callbacks, don't use it explicitly.
- OnDestroy(self, widget=None, event=None)
- Called when the main window is destroyed.
Parameters:
widget -- reserved for GTK callbacks, don't use it explicitly.
event -- reserved for GTK callbacks, don't use it explicitly.
Returns:
True -- the current project can't be properly closed.
This stops signal propagation.
- OnEditMenu(self, widget)
- HACK: When the edit menu opens, checks if any events or instruments are selected
and sets the cut, copy, paste and delete menu items sensitivity accordingly.
Parameters:
widget -- reserved for GTK callbacks, don't use it explicitly.
- OnExport(self, widget=None, profile=None)
- Displays the Mixdown Profiles dialog, which allows the user to
(simply) export the project as ogg or mp3 (replacing the old
export dialog), or create a mixdown profile that does a set of
complicated things.
Parameters:
widget -- reserved for GTK callbacks, don't use it explicitly.
- OnExportCancel(self, widget=None)
- Cancels a running export operation and destroys the export progress dialog.
Parameters:
widget: reserved for GTK callbacks, don't use it explicitly.
- OnExport_old(self, widget=None)
- Creates and shows a save file dialog which allows the user to export
the project as ogg or mp3.
Parameters:
widget -- reserved for GTK callbacks, don't use it explicitly.
- OnExtensionManagerDialog(self, widget)
- Creates and shows the "Extension Manager" dialog.
Parameters:
widget -- reserved for GTK callbacks, don't use it explicitly.
- OnF3Pressed(self)
- Toggle to compact mix view button when F3 is pressed.
- OnFileMenu(self, widget)
- When the file menu opens, check if there are any events and set the mixdown project menu item's
sensitivity accordingly and also the 'mixdown as' sensitivity.
Parameters:
widget -- reserved for GTK callbacks, don't use it explicitly.
- OnForumsMenu(self, widget)
- Opens the Jokosher forum in the user's default web browser.
Parameters:
widget -- reserved for GTK callbacks, don't use it explicitly.
- OnForwardPressed(self, widget=None)
- Starts moving forward within the project's timeline.
Parameters:
widget -- reserved for GTK callbacks, don't use it explicitly.
- OnForwardReleased(self, widget=None)
- Stops the current forward operation.
Parameters:
widget -- reserved for GTK callbacks, don't use it explicitly.
- OnHelpContentsMenu(self, widget=None)
- Calls the appropiate help tool with the user manual in the correct
locale.
Parameters:
widget -- reserved for GTK callbacks, don't use it explicitly.
- OnImportProject(self, widget, destroyCallback=None)
- Creates and shows a open file dialog which allows the user to open
an existing Jokosher project.
Parameters:
widget -- reserved for GTK callbacks, don't use it explicitly.
destroyCallback -- function that'll get called when the open file
dialog gets destroyed.
- OnInstrumentConnectionsDialog(self, widget)
- Creates and shows the "Instrument Connections Dialog".
Parameters:
widget -- reserved for GTK callbacks, don't use it explicitly.
- OnInstrumentMenu(self, widget)
- HACK: When the instrument menu opens, set sensitivity depending on
whether there's a selected instrument or not.
Parameters:
widget -- reserved for GTK callbacks, don't use it explicitly.
- OnKeyPress(self, widget, event)
- Handles the hotkeys, calling whichever function they are assigned to.
Parameters:
widget -- reserved for GTK callbacks, don't use it explicitly.
event -- reserved for GTK callbacks, don't use it explicitly.
- OnMouseDown(self, widget, mouse)
- If there's a project open, clears event and instrument selections.
Parameters:
widget -- reserved for GTK callbacks, don't use it explicitly.
mouse -- reserved for GTK callbacks, don't use it explicitly.
- OnNewProject(self, widget)
- Tries to create a new Project inside the Jokosher data directory.
If the process fails, a message is issued to the user stating the error.
Parameters:
widget -- reserved for GTK callbacks, don't use it explicitly.
- OnOpenProject(self, widget)
- OnOpenRecentProjectButton(self, widget)
- Loads the selected recent project.
Parameters:
widget -- reserved for GTK callbacks, don't use it explicitly.
- OnPaste(self, widget=None)
- Pastes the portion of audio in the clipboard to the selected instrument,
at the selected position in time.
Parameters:
widget -- reserved for GTK callbacks, don't use it explicitly.
- OnPreferences(self, widget, destroyCallback=None)
- Creates and shows the "Jokosher Preferences" dialog.
Parameters:
widget -- reserved for GTK callbacks, don't use it explicitly.
destroyCallback -- function that'll get called when the preferences
dialog gets destroyed.
- OnProjectAudioState(self, project)
- Callback for when the project starts playing or recording, or when it is
paused or stopped.
Parameters:
project -- The project instance that send the signal.
- OnProjectExportStart(self, project)
- Callback for when the project starts exporting audio to a file.
Parameters:
project -- The project instance that send the signal.
- OnProjectExportStop(self, project)
- Callback for when the project has finished exporting audio to a file.
Parameters:
project -- The project instance that send the signal.
- OnProjectNameChanged(self, project, new_name)
- Callback for when the project's name changes.
- OnProjectProperties(self, widget=None)
- Called when the "Properties..." in the project menu is clicked.
Parameters:
widget -- reserved for GTK callbacks, don't use it explicitly.
- OnProjectPropertiesClose(self, dialog, response, nameEntry, authorEntry, notesTextView)
- Called when the "Project Properties" windows is closed.
Parameters:
dialog -- reserved for GTK callbacks, don't use it explicitly.
- OnProjectUndo(self, project=None)
- Callback for when the project's undo or redo stacks change.
Parameters:
project -- The project instance that send the signal.
- OnRecentProjectSelected(self, treeview, path, view_column)
- This method is called when one of the entries in the recent projects
list is selected.
Parameters:
treeview -- reserved for GTK callbacks, don't use it explicitly.
path -- reserved for GTK callbacks, don't use it explicitly.
view_column -- reserved for GTK callbacks, don't use it explicitly.
- OnRecentProjectsItem(self, widget, project_item)
- Opens the project selected from the "Recent Projects" drop-down menu.
Parameters:
widget -- reserved for GTK callbacks, don't use it explicitly.
path -- path to the project file.
name -- name of the project being opened.
- OnRedo(self, widget)
- Redoes the last undo operation and updates the displays.
Parameters:
widget -- reserved for GTK callbacks, don't use it explicitly.
- OnRemoveInstrument(self, widget)
- Removes all selected Instruments from the Project.
Parameters:
widget -- reserved for GTK callbacks, don't use it explicitly.
- OnReportBug(self, widget)
- Opens the report bug launchpad website in the user's default web browser.
Parameters:
widget -- reserved for GTK callbacks, don't use it explicitly.
- OnResize(self, widget, event)
- Called when the main window gets resized.
Parameters:
widget -- GTK callback parameter.
event -- GTK callback parameter.
Returns:
False -- continue GTK signal propagation.
- OnRewindPressed(self, widget=None)
- Starts moving backward within the project's timeline.
Parameters:
widget -- reserved for GTK callbacks, don't use it explicitly.
- OnRewindReleased(self, widget=None)
- Stops the current rewind operation.
Parameters:
widget -- reserved for GTK callbacks, don't use it explicitly.
- OnSaveProject(self, widget=None)
- Saves the current project file.
Parameters:
widget -- reserved for GTK callbacks, don't use it explicitly.
- OnShowAddInstrumentDialog(self, widget=None)
- Creates and shows the "Add Instrument" dialog box.
Parameters:
widget -- reserved for GTK callbacks, don't use it explicitly.
- OnShowBarsBeats(self, widget)
- Sets and updates the current timeline view to Bars, Beats and Ticks.
Parameters:
widget -- reserved for GTK callbacks, don't use it explicitly.
- OnShowHoursMins(self, widget)
- Sets and updates the current timeline view to Hours, Minutes and Seconds.
Parameters:
widget -- reserved for GTK callbacks, don't use it explicitly.
- OnSystemInformation(self, widget)
- Displays a small window with the system information.
Parameters:
widget -- Gtk callback parameter.
- OnTransportMode(self, transportManager=None, mode=None)
- Callback for signal when the transport mode changes.
Parameters:
transportManager -- the TransportManager instance that send the signal.
mode -- the mode type that the transport changed to.
- OnUndo(self, widget)
- Undoes the last change made to the project and updates the displays.
Parameters:
widget -- reserved for GTK callbacks, don't use it explicitly.
- OnWelcomePaneExpose(self, widget, event)
- Draw a pretty picture to the background of the welcome pane.
Parameters:
widget -- GTK callback parameter.
event -- GTK callback parameter.
- OpenProjectFromPath(self, path, parent=None)
- Opens the project file referred by the path parameter.
Parameters:
path -- path to the project to be opened.
parent -- parent window of the error message dialog.
Returns:
the status of the loading operation:
True = the project could be successfully opened and
set as the current project.
False = loading the project failed. A dialog will be
displayed to user detailing the error.
- OpenRecentProjects(self)
- Load the self.project_database_list with items from global settings.
- Play(self, widget=None)
- Toggles playback.
Parameters:
widget -- reserved for GTK callbacks, don't use it explicitly.
- PopulateMixdownAsMenu(self)
- If there are any saved mixdown profiles, create a Mixdown As submenu in
the file menu and add links to them.
- PopulateRecentProjects(self)
- Populates the Recent Projects menu with items from self.project_database_list.
- Record(self, widget=None)
- Toggles recording. If there's an error, a warning/error message is
issued to the user.
Parameters:
widget -- reserved for GTK callbacks, don't use it explicitly.
- SaveRecentProjects(self)
- Saves the list of the previously used projects to the Jokosher config file.
- SetGUIProjectLoaded(self)
- Refreshes the main window and it's components when a project is opened or closed.
For example, buttons are enabled/disabled whether there's a project currently open or not.
- SetProject(self, project)
- Tries to establish the Project parameter as the current project.
If there are errors, an error message is issued to the user.
Parameters:
project -- the Project object to set as the main project.
- SetStatusBar(self, message)
- Appends the message parameter to the status bar text.
Parameters:
message -- string to append to the status bar text.
- ShowImportFileChooser(self)
- Creates a file chooser dialog and gets the filename to be imported,
as well as if the file should be copied to the project folder or not.
Returns:
A 2-tuple containing the a list of file paths to be imported and a boolean
that will be true if the user requested the file to be copied to the project folder.
Both entries in the tuple will be None is the dialog was cancelled.
- ShowOpenProjectErrorDialog(self, error, parent=None)
- Creates and shows a dialog to inform the user about an error that has ocurred.
Parameters:
error -- string with the error(s) description.
parent -- parent window of the error message dialog.
- Stop(self, widget=None)
- Stops the current record/playback (whichever is happening) operation.
Parameters:
widget -- reserved for GTK callbacks, don't use it explicitly.
- TogglePlayIcon(self)
- Changes the play button icon/tooltip from play to pause and viceversa.
- UpdateExportDialog(self)
- Updates the progress bar corresponding to the current export operation.
- UpdateProjectLastUsedTime(self, path, name)
- Inserts a new project with its corresponding path to the recent project list.
Parameters:
path -- path to the project file.
name -- name of the project being added.
- __init__(self, openproject=None, loadExtensions=True, startuptype=None)
- Creates a new instance of MainApp.
Parameters:
openproject -- filename of the project to open at startup.
loadExtensions -- whether the extensions should be loaded.
startuptype -- determines the startup state of Jokosher:
0 = Open the project referred by the openproject parameter.
1 = Do not open the previous project.
Data and other attributes defined here:
- MODE_COMPACT_MIX = 2
- MODE_RECORDING = 1
|