/*
 * DO NOT EDIT.  THIS FILE IS GENERATED FROM calIWeekTitleService.idl
 */

#ifndef __gen_calIWeekTitleService_h__
#define __gen_calIWeekTitleService_h__


#ifndef __gen_nsISupports_h__
#include "nsISupports.h"
#endif

/* For IDL files that don't want to include root IDL files. */
#ifndef NS_NO_VTABLE
#define NS_NO_VTABLE
#endif
class calIDateTime; /* forward declaration */


/* starting interface:    calIWeekTitleService */
#define CALIWEEKTITLESERVICE_IID_STR "6bcf8c57-f066-4eba-ab48-950c9fffd9ff"

#define CALIWEEKTITLESERVICE_IID \
  {0x6bcf8c57, 0xf066, 0x4eba, \
    { 0xab, 0x48, 0x95, 0x0c, 0x9f, 0xff, 0xd9, 0xff }}

/**
 * This interface will calculate a week title from a given datetime. This
 * will depends on the users preferences. 
 * Extensions might override the default implementation, in order to
 * generate week titles aimed at special cases (like weeknumbers for a
 * schoolyear)
 */
class NS_NO_VTABLE calIWeekTitleService : public nsISupports {
 public: 

  NS_DEFINE_STATIC_IID_ACCESSOR(CALIWEEKTITLESERVICE_IID)

  /**
   * Return the week title. It's meant to be displayed.
   * (Usually, will return a weeknumber, but might return a string like Q1W4)
   *
   * @param dateTime
   *            The dateTime to get the weektitle for
   * @returns
   *            A string, representing the week title. Will usually be the
   *            week number. Every week (7 days) should get a different string,
   *            but the switch from one week to the next isn't necessarily
   *            on sunday.
   */
  /* AString getWeekTitle (in calIDateTime dataTime); */
  NS_IMETHOD GetWeekTitle(calIDateTime *dataTime, nsAString & _retval) = 0;

};

/* Use this macro when declaring classes that implement this interface. */
#define NS_DECL_CALIWEEKTITLESERVICE \
  NS_IMETHOD GetWeekTitle(calIDateTime *dataTime, nsAString & _retval); 

/* Use this macro to declare functions that forward the behavior of this interface to another object. */
#define NS_FORWARD_CALIWEEKTITLESERVICE(_to) \
  NS_IMETHOD GetWeekTitle(calIDateTime *dataTime, nsAString & _retval) { return _to GetWeekTitle(dataTime, _retval); } 

/* Use this macro to declare functions that forward the behavior of this interface to another object in a safe way. */
#define NS_FORWARD_SAFE_CALIWEEKTITLESERVICE(_to) \
  NS_IMETHOD GetWeekTitle(calIDateTime *dataTime, nsAString & _retval) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetWeekTitle(dataTime, _retval); } 

#if 0
/* Use the code below as a template for the implementation class for this interface. */

/* Header file */
class _MYCLASS_ : public calIWeekTitleService
{
public:
  NS_DECL_ISUPPORTS
  NS_DECL_CALIWEEKTITLESERVICE

  _MYCLASS_();

private:
  ~_MYCLASS_();

protected:
  /* additional members */
};

/* Implementation file */
NS_IMPL_ISUPPORTS1(_MYCLASS_, calIWeekTitleService)

_MYCLASS_::_MYCLASS_()
{
  /* member initializers and constructor code */
}

_MYCLASS_::~_MYCLASS_()
{
  /* destructor code */
}

/* AString getWeekTitle (in calIDateTime dataTime); */
NS_IMETHODIMP _MYCLASS_::GetWeekTitle(calIDateTime *dataTime, nsAString & _retval)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}

/* End of implementation class template. */
#endif


#endif /* __gen_calIWeekTitleService_h__ */
