sbIClickablePropertyInfo.idl

Go to the documentation of this file.

/*
//
// BEGIN SONGBIRD GPL
//
// This file is part of the Songbird web player.
//
// Copyright(c) 2005-2008 POTI, Inc.
// http://songbirdnest.com
//
// This file may be licensed under the terms of of the
// GNU General Public License Version 2 (the "GPL").
//
// Software distributed under the License is distributed
// on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either
// express or implied. See the GPL for the specific language
// governing rights and limitations.
//
// You should have received a copy of the GPL along with this
// program. If not, go to http://www.gnu.org/licenses/gpl.html
// or write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
//
// END SONGBIRD GPL
//
*/

#include "nsISupports.idl"
#include "sbIPropertyInfo.idl"

interface sbIClickablePropertyCallback;
interface sbIMediaItem;

[scriptable, uuid(b684129e-1dd1-11b2-bdb0-f02ef2b938e4)]
interface sbIClickablePropertyInfo : nsISupports
{
  attribute boolean suppressSelect;

  boolean isDisabled(in AString aCurrentValue);

  boolean hitTest(in AString aCurrentValue,
                  in AString aPart,
                  in unsigned long aBoxWidth,
                  in unsigned long aBoxHeight,
                  in unsigned long aMouseX,
                  in unsigned long aMouseY);

  boolean onClick(in sbIMediaItem aItem,
                  [optional] in nsISupports aEvent,
                  [optional] in nsISupports aContext);

  AString getValueForClick(in AString aCurrentValue,
                           in unsigned long aBoxWidth,
                           in unsigned long aBoxHeight,
                           in unsigned long aMouseX,
                           in unsigned long aMouseY);
};

[scriptable, function, uuid(74f08874-1dd2-11b2-9bf2-c0919899c308)]
interface sbIClickablePropertyCallback : nsISupports
{
  boolean onClick(in sbIPropertyInfo aPropertyInfo,
                  in sbIMediaItem aItem,
                  [optional] in nsISupports aEvent,
                  [optional] in nsISupports aContext);
};