commonmenus.cpp

/****************************************************************************
**
** Copyright (C) 2007-2009 Kevin Clague. All rights reserved.
**
** This file may be used under the terms of the GNU General Public
** License version 2.0 as published by the Free Software Foundation
** and appearing in the file LICENSE.GPL included in the packaging of
** this file.  Please review the following information to ensure GNU
** General Public Licensing requirements will be met:
** http://www.trolltech.com/products/qt/opensource.html
**
** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
**
****************************************************************************/

#include "commonmenus.h"
#include "placement.h"
#include "metatypes.h"

#include <QMenu>
#include <QAction>
#include <QString>

CommonMenus::CommonMenus(void)
{
}

CommonMenus::~CommonMenus(void)
{
}

CommonMenus commonMenus;

QAction* CommonMenus::fontMenu(
        QMenu   &menu, 
  const QString  name)
{
  QAction *action;

  QString formatted = QString("Change %1Font") .arg(name);
  action = menu.addAction(formatted);

  formatted = QString(
   "You can change the font or the size for this %1") .arg(name);

  action->setWhatsThis(formatted);

  return action;
}

QAction* CommonMenus::colorMenu(
        QMenu   &menu, 
  const QString  name)
{
  QAction *action;

  QString formatted = QString("Change %1Color") .arg(name);
  action = menu.addAction(formatted);

  formatted = QString("You can change the color of this %1") .arg(name);
  action->setWhatsThis(formatted);

  return action;
}

QAction* CommonMenus::marginMenu(
        QMenu   &menu, 
  const QString  name)
{
  QAction *action;

  QString formatted = QString("Change %1Margins") .arg(name);
  action = menu.addAction(formatted);

  formatted = QString("You can change how much empty space their is around this %1 number") .arg(name);
  action->setWhatsThis(formatted);

  return action;
}

QString placement2english(PlacementEnc placement)
{
  switch (placement) {
    case TopLeft:
      return "top left";
    break;
    case TopRight:
      return "top right";
    break;
    case BottomRight:
      return "bottom right";
    break;
    case BottomLeft:
      return "bottom left";
    break;
    case Top:
      return "top";
    break;
    case Bottom:
      return "bottom";
    break;
    case Left:
      return "left side";
    break;
    case Right:
      return "right side";
    break;
    case Center:
      return "center";
    break;
    default:
      return "";
    break;
  }
}

QString type2english(PlacementType type)
{
  switch (type) {
    case PageType:
      return "page";
    break;
    case CsiType:
      return "step assembly image";
    break;
    case StepGroupType:
      return "group of steps";
    break;
    case StepNumberType:
      return "step number";
    break;
    case PartsListType:
      return "parts list";
    break;
    case CalloutType:
      return "callout";
    break;
    case PageNumberType:
      return "page number";
    break;
    default:
      return "";
    break;
  }
}

QString type2english2(PlacementType type)
{
  switch (type) {
    case PageType:
      return "this page";
    break;
    case CsiType:
      return "a step assembly image";
    break;
    case StepGroupType:
      return "a group of steps";
    break;
    case StepNumberType:
      return "a step number";
    break;
    case PartsListType:
      return "a parts list";
    break;
    case CalloutType:
      return "a callout";
    break;
    case PageNumberType:
      return "the page number";
    break;
    default:
      return "";
    break;
  }
}

QString CommonMenus::englishPlacement(
  PlacementType  myType,
  PlacementData &placementData)
{
  QString english;
  QString type          = type2english(myType);
  QString relativeTo    = type2english2(placementData.relativeTo);
  QString placement     = placement2english(placementData.placement);
  QString justification = placement2english(placementData.justification);
  QString preposition;

  if (placementData.preposition == Inside) {
    preposition = "inside";
  } else {
    preposition = "outside";
  }

  switch (placementData.placement) {
    case TopLeft:
    case TopRight:
    case BottomRight:
    case BottomLeft:
      english = QString("This %1 is placed in the %2 %3 corner of %4.")
                .arg(type) .arg(placement) .arg(preposition) .arg(relativeTo);
    break;
    case Top:
    case Bottom:
    case Left:
    case Right:
      if (placementData.preposition == Inside) {
        english = QString("this %1 is placed inside %2 against the center of the %3.")
                  .arg(type) .arg(relativeTo) .arg(placement);
      } else {
        english = QString("this %1 is placed outside %2 on the %3, slid to the %4.")
                  .arg(type) .arg(relativeTo) .arg(placement) .arg(justification);
      }
    break;
    case Center:
      english = QString("this %1 is placed in the center of %2.")
                .arg(type) .arg(relativeTo);
    break;
    default:
    break;
  }
  return english;
}

QString CommonMenus::naturalLanguagePlacement(
  PlacementType  type,
  PlacementData &placement)
{
  return englishPlacement(type,placement);
}


QString CommonMenus::naturalLanguagePlacementWhatsThis(
        PlacementType  type,
        PlacementData &placement,
  const QString        name)
{
  return englishPlacementWhatsThis(type,placement,name);
}

QString CommonMenus::englishPlacementWhatsThis(
        PlacementType  type,
        PlacementData &placementData,
  const QString        name)
{
  QString whatsThis;

  whatsThis = name + ":\n";
  whatsThis  += "LPub lets you put things next to other things.  In this case,\n" +
                englishPlacement(type,placementData) + "\n\n" + 
                "Clicking \"" + name + "\" pops up a window with a list of\n"
                "things you can put this " + type2english(type) + " next to.  It also\n" + 
                "lets you describe how it is placed next to the thing you choose.\n\n";

  if (placementData.offsets[XX] != 0 || placementData.offsets[YY] != 0) {
    whatsThis += "You've already discovered that you can click and drag\n"
                 "this " + type2english(type) + "around.  Great job, but there's more.\n\n";
  } else {
    whatsThis += "Did you know that you can click and drag this " + type2english(type) + 
                 " around using the mouse?\n\n";
  }
  return whatsThis;
} 

QAction* CommonMenus::placementMenu(
        QMenu   &menu, 
  const QString  name,
  const QString  whatsThis)
{
  QAction *action;

  QString formatted = QString("Move %1") .arg(name);
  action = menu.addAction(formatted);
  action->setWhatsThis(whatsThis);

  return action;
}

QAction* CommonMenus::backgroundMenu(
        QMenu   &menu, 
  const QString  name)
{
  QAction *action;

  QString formatted = QString("Change %1Background") .arg(name);
  action = menu.addAction(formatted);

  formatted = QString("You can change the color or use a picture for the %1background") .arg(name);
  action->setWhatsThis(formatted);

  return action;
}

QAction* CommonMenus::borderMenu(
        QMenu   &menu, 
  const QString  name)
{
  QAction *action;

  QString formatted = QString("Change %1Border") .arg(name);
  action = menu.addAction(formatted);

  action->setWhatsThis("You can pick a square corner border, round corner border or no border at all");

  return action;
}

QAction* CommonMenus::scaleMenu(  
        QMenu   &menu, 
  const QString  name)
{
  QString formatted = QString("Change %1Scale") .arg(name);

  QAction *action;
  action = menu.addAction(formatted);

  action->setWhatsThis(
    "You can make %1look bigger or smaller on the page by changing the scale."
    "A scale of 1 is true size.  A scale of 2 is double true size\n");

  return action;
}

QAction* CommonMenus::renderParmsMenu(  
        QMenu   &menu, 
  const QString  name)
{
  QString formatted = QString("Change %1Render Parameters") .arg(name);

  QAction *action;
  action = menu.addAction(formatted);
  action->setEnabled(false);

  action->setWhatsThis("This is not implemented yet");

  return action;
}