berryHandlerUtil.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 BERRYHANDLERUTIL_H_
#define BERRYHANDLERUTIL_H_

#include <berryExecutionEvent.h>
#include <berryObjectList.h>
#include <berryObjectString.h>

#include <org_blueberry_ui_qt_Export.h>
#include "berryIWorkbenchPart.h"
#include "berryIWorkbenchPartSite.h"
#include "berryISelection.h"
#include "berryIWorkbenchWindow.h"

#include "berryISources.h"

namespace berry {

class BERRY_UI_QT HandlerUtil {

private:

  static void NoVariableFound(const ExecutionEvent::ConstPointer& event, const QString& name);

  static void IncorrectTypeFound(const ExecutionEvent::ConstPointer& event, const QString& name,
                                 const QString& expectedType, const QString& wrongType);


public:

  typedef ObjectList<ObjectString::Pointer> StringVectorType;

  static Object::ConstPointer GetVariable(const ExecutionEvent::ConstPointer& event, const QString& name);

  static Object::ConstPointer GetVariableChecked(const ExecutionEvent::ConstPointer& event, const QString& name);

  static Object::ConstPointer GetVariable(Object::Pointer context, const QString& name);

  static StringVectorType::ConstPointer GetActiveContexts(const ExecutionEvent::ConstPointer& event);

  static StringVectorType::ConstPointer GetActiveContextsChecked(const ExecutionEvent::ConstPointer& event);

//  static Shell GetActiveShell(const ExecutionEvent::ConstPointer& event) {
//    Object::Pointer o = getVariable(event, ISources.ACTIVE_SHELL_NAME);
//    if (o instanceof Shell) {
//      return (Shell) o;
//    }
//    return null;
//  }

//  static Shell GetActiveShellChecked(const ExecutionEvent::ConstPointer& event)
//       {
//    Object::Pointer o = getVariableChecked(event, ISources.ACTIVE_SHELL_NAME);
//    if (!(o instanceof Shell)) {
//      incorrectTypeFound(event, ISources.ACTIVE_SHELL_NAME, Shell.class,
//          o.getClass());
//    }
//    return (Shell) o;
//  }

   static IWorkbenchWindow::Pointer GetActiveWorkbenchWindow(const ExecutionEvent::ConstPointer& event);

    static IWorkbenchWindow::Pointer GetActiveWorkbenchWindowChecked(
        const ExecutionEvent::ConstPointer& event);

  //static IEditorPart::Pointer GetActiveEditor(const ExecutionEvent::ConstPointer& event);

  //static IEditorPart::Pointer GetActiveEditorChecked(const ExecutionEvent::ConstPointer& event);

  static ObjectString::ConstPointer GetActiveEditorId(const ExecutionEvent::ConstPointer& event);

  static ObjectString::ConstPointer GetActiveEditorIdChecked(const ExecutionEvent::ConstPointer& event);

  static IWorkbenchPart::Pointer GetActivePart(const ExecutionEvent::ConstPointer& event);

  static IWorkbenchPart::Pointer GetActivePartChecked(const ExecutionEvent::ConstPointer& event);

  static ObjectString::ConstPointer GetActivePartId(const ExecutionEvent::ConstPointer& event);

  static ObjectString::ConstPointer GetActivePartIdChecked(const ExecutionEvent::ConstPointer& event);

  static IWorkbenchPartSite::Pointer GetActiveSite(const ExecutionEvent::ConstPointer& event);

  static IWorkbenchPartSite::Pointer GetActiveSiteChecked(const ExecutionEvent::ConstPointer& event);

  static ISelection::ConstPointer GetCurrentSelection(const ExecutionEvent::ConstPointer& event);

  static ISelection::ConstPointer GetCurrentSelectionChecked(const ExecutionEvent::ConstPointer& event);

  static StringVectorType::ConstPointer GetActiveMenus(const ExecutionEvent::ConstPointer& event);

  static StringVectorType::ConstPointer GetActiveMenusChecked(const ExecutionEvent::ConstPointer& event);

  static ISelection::ConstPointer GetActiveMenuSelection(const ExecutionEvent::ConstPointer& event);

  static ISelection::ConstPointer GetActiveMenuSelectionChecked(const ExecutionEvent::ConstPointer& event);

  static ISelection::ConstPointer GetActiveMenuEditorInput(const ExecutionEvent::ConstPointer& event);

  static ISelection::ConstPointer GetActiveMenuEditorInputChecked(
      const ExecutionEvent::ConstPointer& event);

  static ISelection::ConstPointer GetShowInSelection(const ExecutionEvent::ConstPointer& event);

  static ISelection::ConstPointer GetShowInSelectionChecked(const ExecutionEvent::ConstPointer& event);

  static Object::ConstPointer GetShowInInput(const ExecutionEvent::ConstPointer& event);

  static Object::ConstPointer GetShowInInputChecked(const ExecutionEvent::ConstPointer& event);

  static bool ToggleCommandState(const SmartPointer<Command>& command);

  static bool MatchesRadioState(const SmartPointer<ExecutionEvent>& event);

  static void UpdateRadioState(const SmartPointer<Command>& command, const QString& newState);
};

}
#endif /*BERRYHANDLERUTIL_H_*/