/***************************************************************************
 *                          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 IConfigurationService
 *   Service for grouping configuration dialogs and controls
 *--------------------------------------------------------------------------
 * @created: Wednesday, May 05, 2004 16:01:35
 */

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


namespace services
{
  
  class IConfigurationService : public services::IService
  {
  public:
    /* Adds configuration page */
    virtual ZRESULT addPage(ZStringSeq seqLocation, ZString strTitle, core::layout::IChildDialog* pChildDialog, long* pOrdinalID=NULL, CImageList* pImageList=NULL, long nImage=-1)=0;
    virtual ZRESULT showPage(long nOrdinalID, bool bShowModal=true, bool bAllowOtherPages=false)=0;
    virtual ZRESULT removePage(long nOrdinalID)=0;
    virtual ZRESULT setModified(bool bModified, long nOrdinalID=0)=0;
    /* Apply: 0x0001
     * OK:    0x0002
     * Cancel:0x0004 */
    virtual ZRESULT showButtons(DWORD dwShow, DWORD dwHide)=0;
    virtual ZRESULT close(bool bOK=true)=0;
    virtual ZRESULT setCaption(ZString strCaption)=0;
    /* Provides an IPropertiesService which can be used to
     * configure static variables. One can used it to allow user
     * edit your static configuration variables (flags, color, settings
     * etc). Make sure the variables you supply are static, since
     * this service uses their address and modifies data directly. */
    virtual ZRESULT getStaticProperties(services::IPropertiesService** ppSvc)=0;
  
  };//class IConfigurationService
};//services

#endif
