tdelibs/interfaces/kmediaplayer/view.h

// Copyright (C) 2002 Neil Stevens <neil@qualityassistant.com>
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
// THE AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
// AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
// CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//
// Except as contained in this notice, the name(s) of the author(s) shall not be
// used in advertising or otherwise to promote the sale, use or other dealings
// in this Software without prior written authorization from the author(s).

#ifndef KMEDIAPLAYERVIEW_H
#define KMEDIAPLAYERVIEW_H

#include <tqwidget.h>
#include <kdelibs_export.h>

namespace KMediaPlayer
{

/** View is part of the user interface of a Player. */
class KDE_EXPORT View : public TQWidget
{
Q_OBJECT

public:
	/** Your typical TQWidget constructor. */
	View(TQWidget *parent, const char *name);
	virtual ~View(void);

	/** The Possible buttons that can appear in the UI. */
	enum Button
	{
		/** Button that connects to Player::play */
		Play = 1,
		/** Button that connects to Player::stop */
		Stop = 2,
		/** Button that connects to Player::pause */
		Pause = 4,
		/** A seeker that interfaces with Player::seek */
		Seeker = 8,
		/** Show all buttons. */
		All = 255
	};

	/** Return which buttons are being displayed. */
	int buttons(void);

	/** Return the TQWidget in which video is displayed.
		May Return 0L if there is none. */
	TQWidget *videoWidget();

public slots:
	/** Set which buttons to display. See Button. */
	void setButtons(int);

	/** Returns if a particular button is being displayed. */
	bool button(int);
	/** Display a particular button. */
	void showButton(int);
	/** Stop displaying a particular button. */
	void hideButton(int);
	/** Toggle the display of a particular button. */
	void toggleButton(int);

signals:
	/** Emitted when the set of displayed buttons changes. */
	void buttonsChanged(int);

protected:
	/** The implementing view should set the widget in which
		the video will be displayed. KMediaPlayer users may
		reparent() it to somewhere else, for example.
	*/
	void setVideoWidget(TQWidget *videoWidget);

private:
	int currentButtons;

	struct Data;
	Data *d;
};

}

#endif