berryCommandCategory.h

Go to the documentation of this file.

/*===================================================================

BlueBerry Platform

Copyright (c) German Cancer Research Center,
Division of Medical and Biological Informatics.
All rights reserved.

This software is distributed WITHOUT ANY WARRANTY; without
even the implied warranty of MERCHANTABILITY or FITNESS FOR
A PARTICULAR PURPOSE.

See LICENSE.txt or http://www.mitk.org for details.

===================================================================*/

#ifndef BERRYCOMMANDCATEGORY_H_
#define BERRYCOMMANDCATEGORY_H_

#include "common/berryNamedHandleObject.h"
#include "berryICommandCategoryListener.h"

#include <org_blueberry_core_commands_Export.h>

namespace berry
{

class BERRY_COMMANDS CommandCategory: public NamedHandleObject
{

public:

  berryObjectMacro(CommandCategory);

  void AddCategoryListener(ICommandCategoryListener* categoryListener);

  void Define(const QString& name, const QString& description);

  void RemoveCategoryListener(ICommandCategoryListener* categoryListener);

  /*
   * (non-Javadoc)
   *
   * @see org.eclipse.core.commands.common.HandleObject#toString()
   */
  QString ToString() const override;

  /*
   * (non-Javadoc)
   *
   * @see org.eclipse.core.commands.common.HandleObject#undefine()
   */
  void Undefine() override;

protected:

  friend class CommandManager;

  CommandCategory(const QString& id);

private:

  void FireCategoryChanged(const SmartPointer<CommandCategoryEvent> categoryEvent);

  ICommandCategoryListener::Events categoryEvents;
};

}

#endif /* BERRYCOMMANDCATEGORY_H_ */