de.sciss.freesound.lucre.RetrievalView.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of scalafreesound-views_2.11 Show documentation

A library for accessing freesound.org from Scala. (Mellite integration)

The newest version!

/*
 *  RetrievalView.scala
 *  (ScalaFreesound)
 *
 *  Copyright (c) 2010-2019 Hanns Holger Rutz. All rights reserved.
 *
 *	This software is published under the GNU Affero General Public License v3+
 *
 *
 *  For further information, please contact Hanns Holger Rutz at
 *  [email protected]
 */

package de.sciss.freesound.lucre

import de.sciss.freesound.swing.{SearchView, SoundTableView, SoundView}
import de.sciss.freesound.{Client, Sound, TextSearch}
import de.sciss.lucre.stm
import de.sciss.lucre.synth.Sys
import de.sciss.mellite.UniverseView
import de.sciss.synth.proc.Universe

import scala.collection.immutable.{Seq => ISeq}
import scala.swing.{Component, SequentialContainer, TabbedPane}

object RetrievalView {
  def apply[S <: Sys[S]](searchInit: TextSearch, soundInit: ISeq[Sound] = Nil)
           (implicit tx: S#Tx, client: Client, previewsCache: PreviewsCache,
            universe: Universe[S]): RetrievalView[S] =
    impl.RetrievalViewImpl[S](searchInit = searchInit, soundInit = soundInit)
}
trait RetrievalView[S <: stm.Sys[S]] extends UniverseView[S] {
  /** Swing view; must call on EDT! */
  def searchView    : SearchView

  /** Swing view; must call on EDT! */
  def soundTableView: SoundTableView

  /** Swing view; must call on EDT! */
  def soundView: SoundView

  /** Swing view -- clients can append their own components. */
  def resultBottomComponent: Component with SequentialContainer

  /** Swing view; must call on EDT! */
  def tabbedPane: TabbedPane

  def search: TextSearch

  /** Shows the tab for the search settings. */
  def showSearch    (): Unit

  /** Shows the tab for the search results. */
  def showResults   (): Unit

  /** Shows the tab for the sound information. */
  def showInfo      (): Unit
}