Noatun API Documentation

NoatunApp Class Reference

Noatun Application class. More...

#include <noatun/app.h>

Inheritance diagram for NoatunApp:

Inheritance graph
[legend]
List of all members.

Public Types

enum  StartupPlayMode { Restore = 0, Play, DontPlay }

Public Slots

void toggleInterfaces ()
void showInterfaces ()
void hideInterfaces ()
void preferences ()
void quit ()
void fileOpen ()
void effectView ()
void equalizerView ()

Signals

void hideYourself ()
void showYourself ()

Public Member Functions

Playlistplaylist () const
Playerplayer () const
NoatunPreferencespreferencesBox () const
QString mimeTypes ()
LibraryLoaderlibraryLoader () const
Downloaderdownloader () const
Effectseffects () const
::Equalizerequalizer () const
::VEqualizervequalizer ()
KDialogBase * equalizerView () const
QCString version () const
virtual void commitData (QSessionManager &)
virtual void saveState (QSessionManager &)
bool autoPlay () const
int startupPlayMode () const
bool loopList () const
bool oneInstance () const
QString saveDirectory () const
bool clearOnStart () const
bool clearOnOpen () const
bool hackUpPlaylist () const
bool fastMixer () const
QString titleFormat () const
bool displayRemaining () const
void setOneInstance (bool)
void setLoopList (bool)
void setAutoPlay (bool)
void setStartupPlayMode (int mode)
void setSaveDirectory (const QString &)
void setRememberPositions (bool)
void setClearOnStart (bool)
void setClearOnOpen (bool)
void setHackUpPlaylist (bool)
void setFastMixer (bool)
void setTitleFormat (const QString &)
void setDisplayRemaining (bool)
NoatunStdAction::PluginActionMenupluginActionMenu ()
int pluginMenuAdd (const QString &text, const QObject *receiver, const char *member)
void pluginMenuRemove (int id)
KPopupMenu * pluginMenu ()

Static Public Member Functions

QImage readPNG (const QString &filename)

Protected Member Functions

virtual int newInstance ()

Detailed Description

Noatun Application class.

Can be accessed from every plugin by using "napp"

Author:
Charles Samuels
Version:
2.3

Definition at line 31 of file app.h.


Member Enumeration Documentation

enum NoatunApp::StartupPlayMode
 

The three startup modes how noatun should behave when it is restarted.

Restore - it can restore the player's last state

Play - it automatically starts playing the next file in the playlist

DontPlay - it doesn't start playing

Definition at line 88 of file app.h.


Member Function Documentation

bool NoatunApp::autoPlay  )  const
 

Deprecated:
Use startupPlayMode() instead

bool NoatunApp::clearOnOpen  )  const
 

Returns:
true if the playlist will be cleared when opening a new file via commandline or file open dialog, false otherwise

bool NoatunApp::clearOnStart  )  const
 

Deprecated:
now merged with clearOnOpen()

bool NoatunApp::displayRemaining  )  const
 

Returns:
true if remaining time is displayed to the user, false if played time is displayed

void NoatunApp::effectView  )  [slot]
 

Shows the effects window

void NoatunApp::equalizerView  )  [slot]
 

Shows the equalizer window

bool NoatunApp::fastMixer  )  const
 

Returns:
true if hardware-mixing is being used, false in case software mixing is active

void NoatunApp::fileOpen  )  [slot]
 

Shows the standard file-open dialog

void NoatunApp::hideInterfaces  )  [slot]
 

ask the UIs to hide, then you have to look around for them, or you'll lose

void NoatunApp::hideYourself  )  [signal]
 

Tells you (a UI plugin) to hide

QString NoatunApp::mimeTypes  ) 
 

Returns:
a list of mimetypes aRts (and thus Noatun) can play KFileDialog accepts this QString instead of the shell globs in its static functions, make use of it :)

Player* NoatunApp::player  )  const [inline]
 

access to the central player object Any plugin can access the noatun player backend with

napp->playlist();

Definition at line 51 of file app.h.

Playlist* NoatunApp::playlist  )  const
 

Provides access to the central playlist object. Any plugin can access the noatun playlist with

napp->playlist();

NoatunStdAction::PluginActionMenu* NoatunApp::pluginActionMenu  ) 
 

To insert items use KActions and insert() them into pluginActionMenu().

Returns:
pointer to the actionmenu

KPopupMenu* NoatunApp::pluginMenu  ) 
 

Deprecated:
Use pluginActionMenu() instead
Returns:
pointer to the plugin menu

int NoatunApp::pluginMenuAdd const QString &  text,
const QObject *  receiver,
const char *  member
 

Deprecated:
Adds an item to the plugin menu. You may use this value with pluginMenu() for greater control of your menu entry
Returns:
the ID associated with the menu item, for use in pluginMenuRemove()

void NoatunApp::pluginMenuRemove int  id  ) 
 

Deprecated:
Removes an item previously added to the plugin menu.
Parameters:
id the ID of the "to be removed" menu item

void NoatunApp::preferences  )  [slot]
 

Opens the preferences dialog You can also use

napp->preferencesBox()->show()
See also:
NoatunPreferences

NoatunPreferences* NoatunApp::preferencesBox  )  const [inline]
 

access to NoatunPreferences

Definition at line 55 of file app.h.

void NoatunApp::quit  )  [slot]
 

Exits Noatun

void NoatunApp::setAutoPlay bool   ) 
 

Deprecated:
Use setStartupPlayMode() instead

void NoatunApp::setClearOnOpen bool   ) 
 

Set if the playlist will be cleared when opening a new file via commandline or file open dialog

void NoatunApp::setClearOnStart bool   ) 
 

Deprecated:
now merged with setClearOnOpen()

void NoatunApp::setDisplayRemaining bool   ) 
 

Pass true if remaining time should be displayed to the user, false if played time should be displayed

void NoatunApp::setFastMixer bool   ) 
 

Set if hardware-mixing ("fast") or software-mixing ("slow") should be used

void NoatunApp::showInterfaces  )  [slot]
 

ask the UIs to show

void NoatunApp::showYourself  )  [signal]
 

Tells you (a UI plugin) to show again

void NoatunApp::toggleInterfaces  )  [slot]
 

ask the UIs to hide or show


The documentation for this class was generated from the following file:
KDE Logo
This file is part of the documentation for Noatun 2.6.0.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Thu Oct 21 23:49:47 2004 by doxygen 1.3.8-20040913 written by Dimitri van Heesch, © 1997-2003