/***************************************************************************
 *                          Zanoza Modeler v2.x                            *
 *      This is unpublished propietary source code of Zanoza Software.     *
 *      The copyright notice does not evidence any actual or intended      *
 *                    publication of such source code.                     *
 *                                                                         *
 *                Copyright (c) 2002-2008 Zanoza Software.                 *
 *                                                                         *
 *                        All rights reserved.                             *
 ***************************************************************************
 *--------------------------------------------------------------------------
 * @author:   Oleg Melashenko
 *--------------------------------------------------------------------------
 * @purpose:  Declaration of the class ILocalizationService
 *   Service for UI localization.
 *--------------------------------------------------------------------------
 * @created: Wednesday, April 19, 2006 18:03:48
 */

#if !defined(ILocalizationService_h_included)
#define ILocalizationService_h_included
//forward declaration of this class might require
namespace services
{ class ILocalizationService; };
#include <zmodeler.h>
#include <core/coreTypes.h>
#include <services/zmServices.h>
#include <services/IService.h>


namespace services
{
  
  class ILocalizationService : public services::IService
  {
  public:
    virtual ZRESULT setCurrentBranchByID(long nID)=0;
    virtual ZRESULT setCurrentBranch(LPCTSTR pszBranch)=0;
    /* Steps from current brach down to supplied item (and localizes it).
     * If NULL is passed as an argument, current branch steps one level up. */
    virtual ZRESULT stepCurrentBranch(ZString* pstrItem=NULL, bool bLocalize=true)=0;
    virtual ZRESULT formatBranchString(ZString& strBranch, ZStringSeq& seqBranch, bool bStrToSeq=true)=0;
    virtual ZRESULT localizeLocation(ZStringSeq& seqBranch, bool bSetAsCurrent=false, long* pID=NULL)=0;
    virtual ZRESULT getBranchID(ZStringSeq& seqBranch, long& nID, bool bLocalize=true)=0;
    virtual ZRESULT localizeResource(HWND hWnd, LPSTR pszLocation, ZString* pstrTitle=NULL)=0;
    virtual ZRESULT getToolTranslation(ZStringSeq* pSeqLoc, ZString& strTitle, ZStringSeq* seqHint=NULL)=0;
    virtual ZRESULT getWordTranslation(LPCTSTR pszText, ZString& strTrans)=0;
  
  };//class ILocalizationService
};//services

#endif
