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 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

 NoatunApp ()
 ~NoatunApp ()
Playlistplaylist () const
Playerplayer () const
NoatunPreferencespreferencesBox () const
QString mimeTypes ()
LibraryLoaderlibraryLoader () const
Downloaderdownloader () const
Effectseffects () const
::Equalizerequalizer () const
::VEqualizervequalizer ()
KDialogBaseequalizerView () const
QCString version () const
virtual void commitData (QSessionManager &)
virtual void saveState (QSessionManager &)
bool autoPlay () 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 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.


Constructor & Destructor Documentation

NoatunApp::NoatunApp  ) 
 

NoatunApp::~NoatunApp  ) 
 


Member Function Documentation

bool NoatunApp::autoPlay  )  const
 

bool NoatunApp::clearOnOpen  )  const
 

bool NoatunApp::clearOnStart  )  const
 

Deprecated:
now merged with clearOnOpen

virtual void NoatunApp::commitData QSessionManager &   )  [virtual]
 

bool NoatunApp::displayRemaining  )  const
 

Downloader* NoatunApp::downloader  )  const [inline]
 

Definition at line 66 of file app.h.

Effects* NoatunApp::effects  )  const
 

void NoatunApp::effectView  )  [slot]
 

::Equalizer* NoatunApp::equalizer  )  const [inline]
 

Definition at line 69 of file app.h.

void NoatunApp::equalizerView  )  [slot]
 

KDialogBase* NoatunApp::equalizerView  )  const [inline]
 

Definition at line 71 of file app.h.

bool NoatunApp::fastMixer  )  const
 

void NoatunApp::fileOpen  )  [slot]
 

bool NoatunApp::hackUpPlaylist  )  const
 

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

LibraryLoader* NoatunApp::libraryLoader  )  const [inline]
 

Definition at line 65 of file app.h.

bool NoatunApp::loopList  )  const
 

QString NoatunApp::mimeTypes  ) 
 

get a list of mimetypes aRts (noatun) can play, KFileDialog accepts this instead of the shell globs in the static functions, so there ya go :)

virtual int NoatunApp::newInstance  )  [protected, virtual]
 

bool NoatunApp::oneInstance  )  const
 

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 52 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 56 of file app.h.

void NoatunApp::quit  )  [slot]
 

Exits Noatun

QImage NoatunApp::readPNG const QString &  filename  )  [static]
 

QString NoatunApp::saveDirectory  )  const
 

virtual void NoatunApp::saveState QSessionManager &   )  [virtual]
 

void NoatunApp::setAutoPlay bool   ) 
 

void NoatunApp::setClearOnOpen bool   ) 
 

void NoatunApp::setClearOnStart bool   ) 
 

Deprecated:
now merged with setClearOnOpen

void NoatunApp::setDisplayRemaining bool   ) 
 

void NoatunApp::setFastMixer bool   ) 
 

void NoatunApp::setHackUpPlaylist bool   ) 
 

void NoatunApp::setLoopList bool   ) 
 

void NoatunApp::setOneInstance bool   ) 
 

void NoatunApp::setRememberPositions bool   ) 
 

void NoatunApp::setSaveDirectory const QString &   ) 
 

void NoatunApp::setTitleFormat const QString &   ) 
 

void NoatunApp::showInterfaces  )  [slot]
 

ask the UIs to show

void NoatunApp::showYourself  )  [signal]
 

Tells you (a UI plugin) to show again

QString NoatunApp::titleFormat  )  const
 

void NoatunApp::toggleInterfaces  )  [slot]
 

ask the UIs to hide or show

::VEqualizer* NoatunApp::vequalizer  ) 
 

QCString NoatunApp::version  )  const
 


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 Fri Oct 22 00:20:37 2004 by doxygen 1.3.8-20040913 written by Dimitri van Heesch, © 1997-2003