/***************************************************************************
 *                          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 IToolBarLayout
 *   Tool's layout: ToolBar. The tool is a single
 *   button in toolbar (with, probably, extension) that
 *   can be added to an existen toolbar or can laid
 *   in it's own toolbar. Tools can migrate from one
 *   toolbar to another if according interceptors are
 *   installed.
 *--------------------------------------------------------------------------
 * @created: Sunday, January 12, 2003 16:20:18
 */

#if !defined(IToolBarLayout_h_included)
#define IToolBarLayout_h_included
//forward declaration of this class might require
namespace core
{ namespace layout
  { class IToolBarLayout; }; };
#include <zmodeler.h>
#include <core/layout/layoutTypes.h>
#include <core/layout/ILayout.h>
#include <core/ui/IToolBar.h>


namespace core
{
  namespace layout
  {
    
    class IToolBarLayout : public core::layout::ILayout
    {
    public:
      virtual ZRESULT getToolBarCaption(ZString& caption) const=0;
      /* kind of button: check-item, check-group, single item,
       * and/or with extension */
      virtual ZRESULT getItemKind(DWORD& kind) const=0;
      virtual ZRESULT getVariationName(ZString& strName)=0;
      virtual ZRESULT onDeploy(CToolBar* pToolBar, DWORD dwID)=0;
      /* Called only if layout kind has a 'CUSTOM_CONTROL' bit. */
      virtual ZRESULT deploy(core::ui::IToolBar* pToolBar)=0;
    
    };//class IToolBarLayout
  };//layout
};//core

#endif
