sbIPropertyInfo.idl

Go to the documentation of this file.

/*
 *=BEGIN SONGBIRD GPL
 *
 * This file is part of the Songbird web player.
 *
 * Copyright(c) 2005-2011 POTI, Inc.
 * http://www.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"

interface nsISimpleEnumerator;

interface sbIPropertyArray;
interface sbIPropertyOperator;
interface sbIPropertyUnitConverter;

[scriptable, uuid(736df4ca-1dd2-11b2-adeb-b4366f783780)]
interface sbIPropertyInfo : nsISupports
{
  readonly attribute AString OPERATOR_EQUALS;
  readonly attribute AString OPERATOR_NOTEQUALS;
  readonly attribute AString OPERATOR_GREATER;
  readonly attribute AString OPERATOR_GREATEREQUAL;
  readonly attribute AString OPERATOR_LESS;
  readonly attribute AString OPERATOR_LESSEQUAL;
  readonly attribute AString OPERATOR_CONTAINS;
  readonly attribute AString OPERATOR_NOTCONTAINS;
  readonly attribute AString OPERATOR_BEGINSWITH;
  readonly attribute AString OPERATOR_NOTBEGINSWITH;
  readonly attribute AString OPERATOR_ENDSWITH;
  readonly attribute AString OPERATOR_NOTENDSWITH;
  readonly attribute AString OPERATOR_BETWEEN;
  readonly attribute AString OPERATOR_ISSET;
  readonly attribute AString OPERATOR_ISNOTSET;

  /* NOTE: if you change this list of null sort values, please update the
   * documentation in sbIRemoteWebPlaylist.idl as well, thanks!
   */

  const unsigned long SORT_NULL_SMALL = 0;

  const unsigned long SORT_NULL_BIG   = 1;

  const unsigned long SORT_NULL_FIRST = 2;

  const unsigned long SORT_NULL_LAST  = 3;
  
  attribute unsigned long nullSort;

  attribute sbIPropertyArray secondarySort;

  attribute AString id;

  attribute AString type;

  attribute AString displayName;

  attribute AString localizationKey;

  attribute boolean userViewable;

  attribute boolean userEditable;

  attribute boolean remoteReadable;

  attribute boolean remoteWritable;
  
  attribute boolean usedInIdentity;

  //attribute boolean hasValues;

  //attribute nsIStringEnumerator values;

  attribute nsISimpleEnumerator operators;

  sbIPropertyOperator getOperator(in AString aOperator);

  boolean validate(in AString aValue);

  AString sanitize(in AString aValue);

  AString format(in AString aValue);

  AString makeSortable(in AString aValue);

  AString makeSearchable(in AString aValue);

  readonly attribute sbIPropertyUnitConverter unitConverter;
};

[scriptable, uuid(2c5553c0-8f2e-11dd-ad8b-0800200c9a66)]
interface sbITextPropertyInfo : sbIPropertyInfo
{
  attribute unsigned long minLength;

  attribute unsigned long maxLength;

  attribute boolean enforceLowercase;
  
  attribute boolean noCompressWhitespace;
};

[scriptable, uuid(66d736f5-057e-4537-98f9-df2e1b560a13)]
interface sbINumberPropertyInfo : sbIPropertyInfo
{
  const unsigned long RADIX_8  = 8;

  const unsigned long RADIX_10 = 10;

  const unsigned long RADIX_16 = 16;

  const unsigned long FLOAT = 0;

  attribute long long minValue;

  attribute long long maxValue;

  attribute double minFloatValue;

  attribute double maxFloatValue;

  attribute unsigned long radix;
};

[scriptable, uuid(b8d0b930-8aab-4afa-969d-3a5dca7ea536)]
interface sbIURIPropertyInfo : sbIPropertyInfo
{
  attribute AString constrainScheme;
};

[scriptable, uuid(4e09ff7d-732c-4d5f-9d61-2ff0c626c40a)]
interface sbIDatetimePropertyInfo : sbIPropertyInfo
{
  readonly attribute AString OPERATOR_INTHELAST;
  readonly attribute AString OPERATOR_NOTINTHELAST;
  readonly attribute AString OPERATOR_ONDATE;
  readonly attribute AString OPERATOR_NOTONDATE;
  readonly attribute AString OPERATOR_BEFOREDATE;
  readonly attribute AString OPERATOR_BEFOREORONDATE;
  readonly attribute AString OPERATOR_AFTERDATE;
  readonly attribute AString OPERATOR_AFTERORONDATE;
  readonly attribute AString OPERATOR_BETWEENDATES;

  const long TIMETYPE_UNINITIALIZED = -1;

  const long TIMETYPE_DATE = 0; 
  
  const long TIMETYPE_TIME = 1; 
  
  const long TIMETYPE_DATETIME = 2;

  const long TIMETYPE_TIMESTAMP = 4;

  attribute long timeType;

  attribute long long minDateTime;

  attribute long long maxDateTime;
};

[scriptable, uuid(c353b0a3-f715-4001-ae1b-f39f3a0591fa)]
interface sbIDurationPropertyInfo : sbIPropertyInfo
{
  attribute long long minDuration;

  attribute long long maxDuration;

  attribute boolean durationInverse;

  attribute boolean durationWithMilliseconds;
};

[scriptable, uuid(154e77d3-6750-4f4c-a070-473bb7645381)]
interface sbIProgressPropertyInfo : sbITextPropertyInfo
{
  attribute AString modePropertyName;
};

[scriptable, uuid(f16351be-db4c-400a-8ee0-b135113f02dd)]
interface sbIBooleanPropertyInfo : sbIPropertyInfo
{
  readonly attribute AString OPERATOR_ISTRUE;
  readonly attribute AString OPERATOR_ISFALSE;
};

[scriptable, uuid(ecd56b59-906a-44c9-ac24-3345f1b70b10)]
interface sbIDummyPropertyInfo : sbIPropertyInfo
{
};