Sayonara Player
Modules | Namespaces | Classes | Typedefs | Enumerations | Functions
Helper

everything what's highly reusable More...

Modules

 File Utils
 everything about files
 
 Lyrics
 
 MetaData Helper
 
 PLS and M3U parser
 Parsers for pls, m3u and asx.
 
 Settings
 the Settings framework
 

Namespaces

 Compressor
 Compressor utils.
 
 Library
 An interface class needed when implementing a library plugin.
 
 Util
 Helper functions.
 

Classes

class  DirectoryReader
 Directory reader functions. More...
 
class  Util::Image
 The Image class. More...
 
class  Library::Filter
 The Filter class. More...
 
class  Library::MergeData
 Changes all metadata containing one of the source ids and replaces it with the target id. For example, 3 different artists are merged into one. More...
 
class  Library::Sortings
 The Sortings class. More...
 
class  Logger
 The Logger class. More...
 
class  MessageReceiverInterface
 The GlobalMessageReceiverInterface class
implement this class in order to have the possibility to show messages. More...
 
class  RandomGenerator
 The RandomGenerator class. More...
 
class  Util::Set< T >
 A set structure. Inherited from std::set with some useful methods. For integer and String this set is ordered. More...
 
class  Util::Tree< T >
 The Tree class. More...
 
class  AsyncWebAccess
 Asynchgronous web access class. More...
 

Typedefs

using StringPair = QPair< QString, QString >
 Sayonara Typedefs.
 

Enumerations

enum  PlayState : unsigned char {
  Playing =0,
  Paused,
  Stopped,
  FirstStartup
}
 The PlayState enum.
 
enum  Library::SearchMode {
  None = 0,
  CaseInsensitve = (1<<0),
  NoSpecialChars = (1<<1),
  NoDiacriticChars = (1<<2),
  SearchModeMaskSize = (1<<3)
}
 The SearchMode enum.
 
enum  Message::Answer : unsigned char {
  Yes =0,
  No,
  Ok,
  Cancel,
  Undefined
}
 The GlobalMessage class.
 
enum  Message::QuestionType : unsigned char {
  YesNo =0,
  OkCancel
}
 The GlobalMessage class.
 

Functions

QString Library::Utils::convertSearchstring (const QString &str, SearchModeMask mode)
 Converts a user entered string into a cis-representation. For example, diacrytic chars are replaced by latin ones, spaces are removed and so on, so the resulting string can be searched for in the database. More...
 
QString Library::Utils::convertSearchstring (const QString &str, SearchModeMask mode, const QList< QChar > &ignored_chars)
 Converts a user entered string into a cis-representation. For example, diacrytic chars are replaced by latin ones, spaces are removed and so on, so the resulting string can be searched for in the database. More...
 
bool Message::registerReceiver (MessageReceiverInterface *receiver)
 register a receiver here, so it is called whenever a message has to be written More...
 

Detailed Description

everything what's highly reusable

Function Documentation

◆ convertSearchstring() [1/2]

QString Library::Utils::convertSearchstring ( const QString &  str,
SearchModeMask  mode 
)

Converts a user entered string into a cis-representation. For example, diacrytic chars are replaced by latin ones, spaces are removed and so on, so the resulting string can be searched for in the database.

Parameters
strsource string
modecombination of SearchMode values

◆ convertSearchstring() [2/2]

QString Library::Utils::convertSearchstring ( const QString &  str,
SearchModeMask  mode,
const QList< QChar > &  ignored_chars 
)

Converts a user entered string into a cis-representation. For example, diacrytic chars are replaced by latin ones, spaces are removed and so on, so the resulting string can be searched for in the database.

Parameters
strsource string
modecombination of SearchMode values
ignored_charschars that are not replaced within that method

◆ registerReceiver()

bool Message::registerReceiver ( MessageReceiverInterface receiver)

register a receiver here, so it is called whenever a message has to be written

Parameters
receiverthe receiver class
Returns
false, if there's already another receiver. True else