src/frontends/qt4/GuiCharacter.cpp

   1 /**
   2  * \file GuiCharacter.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Angus Leeming
   7  * \author Edwin Leuven
   8  * \author John Levon
   9  * \author Jürgen Spitzmüller
  10  *
  11  * Full author contact details are available in file CREDITS.
  12  */
  13
  14 #include <config.h>
  15
  16 #include "GuiCharacter.h"
  17
  18 #include "GuiApplication.h"
  19 #include "qt_helpers.h"
  20
  21 #include "Font.h"
  22 #include "Buffer.h"
  23 #include "BufferParams.h"
  24 #include "BufferView.h"
  25 #include "Color.h"
  26 #include "ColorCache.h"
  27 #include "ColorSet.h"
  28 #include "Cursor.h"
  29 #include "FuncRequest.h"
  30 #include "Language.h"
  31 #include "Paragraph.h"
  32
  33 #include "support/gettext.h"
  34 #include "support/lstrings.h"
  35
  36 #include <QAbstractItemModel>
  37 #include <QComboBox>
  38 #include <QModelIndex>
  39 #include <QSettings>
  40 #include <QVariant>
  41
  42 using namespace std;
  43
  44 namespace lyx {
  45 namespace frontend {
  46
  47 static QList<ShapePair> shapeData()
  48 {
  49         QList<ShapePair> shapes;
  50         shapes << ShapePair(qt_("No change"), IGNORE_SHAPE);
  51         shapes << ShapePair(qt_("Upright"), UP_SHAPE);
  52         shapes << ShapePair(qt_("Italic"), ITALIC_SHAPE);
  53         shapes << ShapePair(qt_("Slanted"), SLANTED_SHAPE);
  54         shapes << ShapePair(qt_("Small Caps"), SMALLCAPS_SHAPE);
  55         shapes << ShapePair(qt_("Reset"), INHERIT_SHAPE);
  56         return shapes;
  57 }
  58
  59
  60 static QList<SizePair> sizeData()
  61 {
  62         QList<SizePair> sizes;
  63         sizes << SizePair(qt_("No change"), FONT_SIZE_IGNORE);
  64         sizes << SizePair(qt_("Tiny"), FONT_SIZE_TINY);
  65         sizes << SizePair(qt_("Smallest"), FONT_SIZE_SCRIPT);
  66         sizes << SizePair(qt_("Smaller"), FONT_SIZE_FOOTNOTE);
  67         sizes << SizePair(qt_("Small"), FONT_SIZE_SMALL);
  68         sizes << SizePair(qt_("Normal"), FONT_SIZE_NORMAL);
  69         sizes << SizePair(qt_("Large"), FONT_SIZE_LARGE);
  70         sizes << SizePair(qt_("Larger"), FONT_SIZE_LARGER);
  71         sizes << SizePair(qt_("Largest"), FONT_SIZE_LARGEST);
  72         sizes << SizePair(qt_("Huge"), FONT_SIZE_HUGE);
  73         sizes << SizePair(qt_("Huger"), FONT_SIZE_HUGER);
  74         sizes << SizePair(qt_("Increase"), FONT_SIZE_INCREASE);
  75         sizes << SizePair(qt_("Decrease"), FONT_SIZE_DECREASE);
  76         sizes << SizePair(qt_("Reset"), FONT_SIZE_INHERIT);
  77         return sizes;
  78 }
  79
  80
  81 static QList<BarPair> barData()
  82 {
  83         QList<BarPair> bars;
  84         bars << BarPair(qt_("No change"), IGNORE);
  85         bars << BarPair(qt_("(Without)[[underlining]]"), NONE);
  86         bars << BarPair(qt_("Single[[underlining]]"), UNDERBAR);
  87         bars << BarPair(qt_("Double[[underlining]]"), UULINE);
  88         bars << BarPair(qt_("Wavy"), UWAVE);
  89         bars << BarPair(qt_("Reset"), INHERIT);
  90         return bars;
  91 }
  92
  93
  94 static QList<BarPair> strikeData()
  95 {
  96         QList<BarPair> strike;
  97         strike << BarPair(qt_("No change"), IGNORE);
  98         strike << BarPair(qt_("(Without)[[strikethrough]]"), NONE);
  99         strike << BarPair(qt_("Single[[strikethrough]]"), STRIKEOUT);
 100         strike << BarPair(qt_("With /"), XOUT);
 101         strike << BarPair(qt_("Reset"), INHERIT);
 102         return strike;
 103 }
 104
 105
 106 static QList<ColorCode> colorData()
 107 {
 108         QList<ColorCode> colors;
 109         colors << Color_black;
 110         colors << Color_blue;
 111         colors << Color_brown;
 112         colors << Color_cyan;
 113         colors << Color_darkgray;
 114         colors << Color_gray;
 115         colors << Color_green;
 116         colors << Color_lightgray;
 117         colors << Color_lime;
 118         colors << Color_magenta;
 119         colors << Color_olive;
 120         colors << Color_orange;
 121         colors << Color_pink;
 122         colors << Color_purple;
 123         colors << Color_red;
 124         colors << Color_teal;
 125         colors << Color_violet;
 126         colors << Color_white;
 127         colors << Color_yellow;
 128         return colors;
 129 }
 130
 131
 132 static QList<SeriesPair> seriesData()
 133 {
 134         QList<SeriesPair> series;
 135         series << SeriesPair(qt_("No change"), IGNORE_SERIES);
 136         series << SeriesPair(qt_("Medium"),    MEDIUM_SERIES);
 137         series << SeriesPair(qt_("Bold"),      BOLD_SERIES);
 138         series << SeriesPair(qt_("Reset"),     INHERIT_SERIES);
 139         return series;
 140 }
 141
 142
 143 static QList<FamilyPair> familyData()
 144 {
 145         QList<FamilyPair> families;
 146         families << FamilyPair(qt_("No change"),  IGNORE_FAMILY);
 147         families << FamilyPair(qt_("Roman"),      ROMAN_FAMILY);
 148         families << FamilyPair(qt_("Sans Serif"), SANS_FAMILY);
 149         families << FamilyPair(qt_("Typewriter"), TYPEWRITER_FAMILY);
 150         families << FamilyPair(qt_("Reset"),      INHERIT_FAMILY);
 151         return families;
 152 }
 153
 154
 155 static QList<LanguagePair> languageData()
 156 {
 157         QList<LanguagePair> list;
 158         // FIXME (Abdel 14/05/2008): it would be nice if we could use this model
 159         // directly in the language combo; but, as we need also the 'No Change' and
 160         // 'Reset' items, this is not possible right now. Separating those two
 161         // entries in radio buttons would be a better GUI IMHO.
 162         QAbstractItemModel * language_model = guiApp->languageModel();
 163         // Make sure the items are sorted.
 164         language_model->sort(0);
 165
 166         for (int i = 0; i != language_model->rowCount(); ++i) {
 167                 QModelIndex index = language_model->index(i, 0);
 168                 list << LanguagePair(index.data(Qt::DisplayRole).toString(),
 169                         index.data(Qt::UserRole).toString());
 170         }
 171         return list;
 172 }
 173
 174
 175 namespace {
 176
 177 template<typename T>
 178 void fillCombo(QComboBox * combo, QList<T> const & list)
 179 {
 180         typename QList<T>::const_iterator cit = list.begin();
 181         for (; cit != list.end(); ++cit)
 182                 combo->addItem(cit->first);
 183 }
 184
 185 template<typename T>
 186 void fillComboColor(QComboBox * combo, QList<T> const & list)
 187 {
 188         // at first add the 2 colors "No change" and "No color"
 189         combo->addItem(qt_("No change"), "ignore");
 190         combo->addItem(qt_("(Without)[[color]]"), "none");
 191         // now add the real colors
 192         QPixmap coloritem(32, 32);
 193         QColor color;
 194         QList<ColorCode>::const_iterator cit = list.begin();
 195         for (; cit != list.end(); ++cit) {
 196                 QString const lyxname = toqstr(lcolor.getLyXName(*cit));
 197                 QString const guiname = toqstr(translateIfPossible(lcolor.getGUIName(*cit)));
 198                 color = QColor(guiApp->colorCache().get(*cit, false));
 199                 coloritem.fill(color);
 200                 combo->addItem(QIcon(coloritem), guiname, lyxname);
 201         }
 202         //the last color is "Reset"
 203         combo->addItem(qt_("Reset"), "inherit");
 204 }
 205
 206 } // namespace
 207
 208 GuiCharacter::GuiCharacter(GuiView & lv)
 209         : GuiDialog(lv, "character", qt_("Text Style")),
 210           font_(ignore_font, ignore_language), emph_(false), noun_(false)
 211 {
 212         setupUi(this);
 213
 214         connect(okPB, SIGNAL(clicked()), this, SLOT(slotOK()));
 215         connect(applyPB, SIGNAL(clicked()), this, SLOT(slotApply()));
 216         connect(closePB, SIGNAL(clicked()), this, SLOT(slotClose()));
 217         connect(autoapplyCB, SIGNAL(stateChanged(int)), this,
 218                 SLOT(slotAutoApply()));
 219
 220         connect(ulineCO, SIGNAL(currentIndexChanged(int)), this, SLOT(change_adaptor()));
 221         connect(strikeCO, SIGNAL(currentIndexChanged(int)), this, SLOT(change_adaptor()));
 222         connect(sizeCO, SIGNAL(currentIndexChanged(int)), this, SLOT(change_adaptor()));
 223         connect(familyCO, SIGNAL(currentIndexChanged(int)), this, SLOT(change_adaptor()));
 224         connect(seriesCO, SIGNAL(currentIndexChanged(int)), this, SLOT(change_adaptor()));
 225         connect(shapeCO, SIGNAL(currentIndexChanged(int)), this, SLOT(change_adaptor()));
 226         connect(colorCO, SIGNAL(currentIndexChanged(int)), this, SLOT(change_adaptor()));
 227         connect(langCO, SIGNAL(currentIndexChanged(int)), this, SLOT(change_adaptor()));
 228
 229         family = familyData();
 230         series = seriesData();
 231         shape  = shapeData();
 232         size   = sizeData();
 233         bar    = barData();
 234         strike = strikeData();
 235         color  = colorData();
 236         qSort(color.begin(), color.end(), ColorSorter);
 237
 238         language = languageData();
 239         language.prepend(LanguagePair(qt_("Reset"), "reset"));
 240         language.prepend(LanguagePair(qt_("No change"), "ignore"));
 241
 242         fillCombo(familyCO, family);
 243         fillCombo(seriesCO, series);
 244         fillCombo(sizeCO, size);
 245         fillCombo(shapeCO, shape);
 246         fillCombo(ulineCO, bar);
 247         fillCombo(strikeCO, strike);
 248         fillComboColor(colorCO, color);
 249         fillCombo(langCO, language);
 250
 251         bc().setPolicy(ButtonPolicy::OkApplyCancelAutoReadOnlyPolicy);
 252         bc().setOK(okPB);
 253         bc().setApply(applyPB);
 254         bc().setCancel(closePB);
 255         bc().setAutoApply(autoapplyCB);
 256         bc().addReadOnly(familyCO);
 257         bc().addReadOnly(seriesCO);
 258         bc().addReadOnly(sizeCO);
 259         bc().addReadOnly(shapeCO);
 260         bc().addReadOnly(ulineCO);
 261         bc().addReadOnly(strikeCO);
 262         bc().addReadOnly(nounCB);
 263         bc().addReadOnly(emphCB);
 264         bc().addReadOnly(langCO);
 265         bc().addReadOnly(colorCO);
 266         bc().addReadOnly(autoapplyCB);
 267
 268 #ifdef Q_OS_MAC
 269         // On Mac it's common to have tool windows which are always in the
 270         // foreground and are hidden when the main window is not focused.
 271         setWindowFlags(Qt::Tool);
 272         autoapplyCB->setChecked(true);
 273 #endif
 274 }
 275
 276
 277 void GuiCharacter::on_emphCB_clicked()
 278 {
 279         // skip intermediate state at user click
 280         if (!emph_) {
 281                 emphCB->setCheckState(Qt::Checked);
 282                 emph_ = true;
 283         }
 284         change_adaptor();
 285 }
 286
 287
 288 void GuiCharacter::on_nounCB_clicked()
 289 {
 290         // skip intermediate state at user click
 291         if (!noun_) {
 292                 nounCB->setCheckState(Qt::Checked);
 293                 noun_ = true;
 294         }
 295         change_adaptor();
 296 }
 297
 298
 299 void GuiCharacter::change_adaptor()
 300 {
 301         changed();
 302
 303         if (!autoapplyCB->isChecked())
 304                 return;
 305
 306         // to be really good here, we should set the combos to the values of
 307         // the current text, and make it appear as "no change" if the values
 308         // stay the same between applys. Might be difficult though wrt to a
 309         // moved cursor - jbl
 310         slotApply();
 311 }
 312
 313
 314 template<class P, class B>
 315 static int findPos2nd(QList<P> const & vec, B const & val)
 316 {
 317         for (int i = 0; i != vec.size(); ++i)
 318                 if (vec[i].second == val)
 319                         return i;
 320         return 0;
 321 }
 322
 323
 324 namespace{
 325 FontState getBar(FontInfo const & fi)
 326 {
 327         if (fi.underbar() == FONT_ON)
 328                 return UNDERBAR;
 329
 330         if (fi.uuline() == FONT_ON)
 331                 return UULINE;
 332
 333         if (fi.uwave() == FONT_ON)
 334                 return UWAVE;
 335
 336         if (fi.underbar() == FONT_IGNORE)
 337                 return IGNORE;
 338
 339         return NONE;
 340 }
 341
 342
 343 FontState getStrike(FontInfo const & fi)
 344 {
 345         if (fi.strikeout() == FONT_ON)
 346                 return STRIKEOUT;
 347
 348         if (fi.xout() == FONT_ON)
 349                 return XOUT;
 350
 351         if (fi.strikeout() == FONT_IGNORE)
 352                 return IGNORE;
 353
 354         return NONE;
 355 }
 356
 357
 358 Qt::CheckState getMarkupState(lyx::FontState fs)
 359 {
 360         switch (fs) {
 361         case FONT_OFF:
 362                 return Qt::Unchecked;
 363         case FONT_ON:
 364                 return Qt::Checked;
 365         case FONT_TOGGLE:
 366         case FONT_INHERIT:
 367         case FONT_IGNORE:
 368         default:
 369                 return Qt::PartiallyChecked;
 370         }
 371 }
 372
 373 lyx::FontState setMarkupState(Qt::CheckState cs)
 374 {
 375         switch (cs) {
 376         case Qt::Unchecked:
 377                 return FONT_OFF;
 378         case Qt::Checked:
 379                 return FONT_ON;
 380         case Qt::PartiallyChecked:
 381         default:
 382                 return FONT_IGNORE;
 383         }
 384 }
 385
 386 } // end namespace anon
 387
 388
 389 void GuiCharacter::updateContents()
 390 {
 391         if (bufferview()->cursor().selection()) {
 392                 Font font = bufferview()->cursor().real_current_font;
 393                 FontInfo fi = font.fontInfo();
 394                 BufferParams const & bp = buffer().masterParams();
 395
 396                 // Check if each font attribute is constant for the selection range.
 397                 DocIterator const from = bufferview()->cursor().selectionBegin();
 398                 DocIterator const to = bufferview()->cursor().selectionEnd();
 399                 for (DocIterator dit = from ; dit != to && !dit.atEnd(); ) {
 400                         if (!dit.inTexted()) {
 401                                 dit.forwardPos();
 402                                 continue;
 403                         }
 404                         Paragraph const & par = dit.paragraph();
 405                         pos_type const pos = dit.pos();
 406                         Font tmp = par.getFont(bp, pos, font);
 407                         if (font.language() != tmp.language())
 408                                 font.setLanguage(ignore_language);
 409                         if (fi.family() != tmp.fontInfo().family())
 410                                 font.fontInfo().setFamily(IGNORE_FAMILY);
 411                         if (fi.series() != tmp.fontInfo().series())
 412                                 font.fontInfo().setSeries(IGNORE_SERIES);
 413                         if (fi.shape() != tmp.fontInfo().shape())
 414                                 font.fontInfo().setShape(IGNORE_SHAPE);
 415                         if (fi.size() != tmp.fontInfo().size())
 416                                 font.fontInfo().setSize(FONT_SIZE_IGNORE);
 417                         if (fi.emph() != tmp.fontInfo().emph())
 418                                 font.fontInfo().setEmph(FONT_IGNORE);
 419                         if (fi.noun() != tmp.fontInfo().noun())
 420                                 font.fontInfo().setNoun(FONT_IGNORE);
 421                         if (fi.color() != tmp.fontInfo().color())
 422                                 font.fontInfo().setColor(Color_ignore);
 423                         if (fi.underbar() != tmp.fontInfo().underbar()
 424                             || fi.uuline() != tmp.fontInfo().uuline()
 425                             || fi.uwave() != tmp.fontInfo().uwave())
 426                                 setBar(font.fontInfo(), IGNORE);
 427                         if (fi.strikeout() != tmp.fontInfo().strikeout()
 428                             || fi.xout() != tmp.fontInfo().xout())
 429                                 setStrike(font.fontInfo(), IGNORE);
 430                         dit.forwardPos();
 431                 }
 432                 font_ = font;
 433         } else
 434                 font_ = bufferview()->cursor().real_current_font;
 435
 436         paramsToDialog(font_);
 437 }
 438
 439
 440 void GuiCharacter::setBar(FontInfo & fi, FontState val)
 441 {
 442         switch (val) {
 443         case IGNORE:
 444                 fi.setUnderbar(FONT_IGNORE);
 445                 fi.setUuline(FONT_IGNORE);
 446                 fi.setUwave(FONT_IGNORE);
 447                 break;
 448         case UNDERBAR:
 449                 setBar(fi, NONE);
 450                 fi.setUnderbar(FONT_ON);
 451                 break;
 452         case UULINE:
 453                 setBar(fi, NONE);
 454                 fi.setUuline(FONT_ON);
 455                 break;
 456         case UWAVE:
 457                 setBar(fi, NONE);
 458                 fi.setUwave(FONT_ON);
 459                 break;
 460         case INHERIT:
 461                 fi.setUnderbar(FONT_INHERIT);
 462                 fi.setUuline(FONT_INHERIT);
 463                 fi.setUwave(FONT_INHERIT);
 464                 break;
 465         case NONE:
 466                 fi.setUnderbar(FONT_OFF);
 467                 fi.setUuline(FONT_OFF);
 468                 fi.setUwave(FONT_OFF);
 469                 break;
 470         case XOUT:
 471         case STRIKEOUT:
 472         default:
 473                 break;
 474         }
 475 }
 476
 477
 478 void GuiCharacter::setStrike(FontInfo & fi, FontState val)
 479 {
 480         switch (val) {
 481         case IGNORE:
 482                 fi.setStrikeout(FONT_IGNORE);
 483                 fi.setXout(FONT_IGNORE);
 484                 break;
 485         case STRIKEOUT:
 486                 setStrike(fi, NONE);
 487                 fi.setStrikeout(FONT_ON);
 488                 break;
 489         case XOUT:
 490                 setStrike(fi, NONE);
 491                 fi.setXout(FONT_ON);
 492                 break;
 493         case INHERIT:
 494                 fi.setStrikeout(FONT_INHERIT);
 495                 fi.setXout(FONT_INHERIT);
 496                 break;
 497         case NONE:
 498                 fi.setStrikeout(FONT_OFF);
 499                 fi.setXout(FONT_OFF);
 500                 break;
 501         case UNDERBAR:
 502         case UWAVE:
 503         case UULINE:
 504         default:
 505                 break;
 506         }
 507 }
 508
 509
 510 void GuiCharacter::paramsToDialog(Font const & font)
 511 {
 512         FontInfo const & fi = font.fontInfo();
 513         familyCO->setCurrentIndex(findPos2nd(family, fi.family()));
 514         seriesCO->setCurrentIndex(findPos2nd(series, fi.series()));
 515         shapeCO->setCurrentIndex(findPos2nd(shape, fi.shape()));
 516         sizeCO->setCurrentIndex(findPos2nd(size, fi.size()));
 517         ulineCO->setCurrentIndex(findPos2nd(bar, getBar(fi)));
 518         strikeCO->setCurrentIndex(findPos2nd(strike, getStrike(fi)));
 519         colorCO->setCurrentIndex(colorCO->findData(toqstr(lcolor.getLyXName(fi.color()))));
 520         emphCB->setCheckState(getMarkupState(fi.emph()));
 521         nounCB->setCheckState(getMarkupState(fi.noun()));
 522         emph_ = emphCB->checkState() == Qt::Checked;
 523         noun_ = nounCB->checkState() == Qt::Checked;
 524
 525         // reset_language is a null pointer.
 526         QString const lang = (font.language() == reset_language)
 527                 ? "reset" : toqstr(font.language()->lang());
 528         langCO->setCurrentIndex(findPos2nd(language, lang));
 529 }
 530
 531
 532 void GuiCharacter::applyView()
 533 {
 534         FontInfo & fi = font_.fontInfo();
 535         fi.setFamily(family[familyCO->currentIndex()].second);
 536         fi.setSeries(series[seriesCO->currentIndex()].second);
 537         fi.setShape(shape[shapeCO->currentIndex()].second);
 538         fi.setSize(size[sizeCO->currentIndex()].second);
 539         fi.setEmph(setMarkupState(emphCB->checkState()));
 540         fi.setNoun(setMarkupState(nounCB->checkState()));
 541         setBar(fi, bar[ulineCO->currentIndex()].second);
 542         setStrike(fi, strike[strikeCO->currentIndex()].second);
 543         fi.setColor(lcolor.getFromLyXName(fromqstr(colorCO->itemData(colorCO->currentIndex()).toString())));
 544
 545         font_.setLanguage(languages.getLanguage(
 546                 fromqstr(language[langCO->currentIndex()].second)));
 547 }
 548
 549
 550 bool GuiCharacter::initialiseParams(string const &)
 551 {
 552         if (autoapplyCB->isChecked())
 553                 return true;
 554
 555         FontInfo & fi = font_.fontInfo();
 556
 557         // so that the user can press Ok
 558         if (fi.family()    != IGNORE_FAMILY
 559             || fi.series() != IGNORE_SERIES
 560             || fi.shape()  != IGNORE_SHAPE
 561             || fi.size()   != FONT_SIZE_IGNORE
 562             || getBar(fi)  != IGNORE
 563             || fi.color()  != Color_ignore
 564             || font_.language() != ignore_language)
 565                 setButtonsValid(true);
 566
 567         paramsToDialog(font_);
 568         return true;
 569 }
 570
 571
 572 void GuiCharacter::dispatchParams()
 573 {
 574         dispatch(FuncRequest(getLfun(), font_.toString(false)));
 575 }
 576
 577
 578 void GuiCharacter::saveSession(QSettings & settings) const
 579 {
 580         Dialog::saveSession(settings);
 581         settings.setValue(sessionKey() + "/autoapply", autoapplyCB->isChecked());
 582 }
 583
 584
 585 void GuiCharacter::restoreSession()
 586 {
 587         Dialog::restoreSession();
 588         QSettings settings;
 589         autoapplyCB->setChecked(
 590                 settings.value(sessionKey() + "/autoapply").toBool());
 591 }
 592
 593
 594 Dialog * createGuiCharacter(GuiView & lv) { return new GuiCharacter(lv); }
 595
 596
 597 } // namespace frontend
 598 } // namespace lyx
 599
 600 #include "moc_GuiCharacter.cpp"