src/insets/InsetNewpage.cpp

   1 /**
   2  * \file InsetNewpage.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author André Pönitz
   7  * \author Jürgen Spitzmüller
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #include <config.h>
  13
  14 #include "InsetNewpage.h"
  15
  16 #include "Cursor.h"
  17 #include "FuncRequest.h"
  18 #include "FuncStatus.h"
  19 #include "Lexer.h"
  20 #include "MetricsInfo.h"
  21 #include "OutputParams.h"
  22 #include "output_xhtml.h"
  23 #include "texstream.h"
  24 #include "Text.h"
  25 #include "TextMetrics.h"
  26
  27 #include "frontends/FontMetrics.h"
  28 #include "frontends/Painter.h"
  29
  30 #include "support/debug.h"
  31 #include "support/docstring.h"
  32 #include "support/docstream.h"
  33 #include "support/gettext.h"
  34
  35 using namespace std;
  36
  37
  38 namespace lyx {
  39
  40         InsetNewpage::InsetNewpage() : Inset(0)
  41 {}
  42
  43
  44 InsetNewpage::InsetNewpage(InsetNewpageParams const & params)
  45         : Inset(0), params_(params)
  46 {}
  47
  48
  49 void InsetNewpageParams::write(ostream & os) const
  50 {
  51         switch (kind) {
  52         case InsetNewpageParams::NEWPAGE:
  53                 os << "newpage";
  54                 break;
  55         case InsetNewpageParams::PAGEBREAK:
  56                 os <<  "pagebreak";
  57                 break;
  58         case InsetNewpageParams::CLEARPAGE:
  59                 os <<  "clearpage";
  60                 break;
  61         case InsetNewpageParams::CLEARDOUBLEPAGE:
  62                 os <<  "cleardoublepage";
  63                 break;
  64         }
  65 }
  66
  67
  68 void InsetNewpageParams::read(Lexer & lex)
  69 {
  70         lex.setContext("InsetNewpageParams::read");
  71         string token;
  72         lex >> token;
  73
  74         if (token == "newpage")
  75                 kind = InsetNewpageParams::NEWPAGE;
  76         else if (token == "pagebreak")
  77                 kind = InsetNewpageParams::PAGEBREAK;
  78         else if (token == "clearpage")
  79                 kind = InsetNewpageParams::CLEARPAGE;
  80         else if (token == "cleardoublepage")
  81                 kind = InsetNewpageParams::CLEARDOUBLEPAGE;
  82         else
  83                 lex.printError("Unknown kind");
  84 }
  85
  86
  87 void InsetNewpage::write(ostream & os) const
  88 {
  89         os << "Newpage ";
  90         params_.write(os);
  91 }
  92
  93
  94 void InsetNewpage::read(Lexer & lex)
  95 {
  96         params_.read(lex);
  97         lex >> "\\end_inset";
  98 }
  99
 100
 101 void InsetNewpage::metrics(MetricsInfo & mi, Dimension & dim) const
 102 {
 103         dim.asc = defaultRowHeight();
 104         dim.des = defaultRowHeight();
 105         dim.wid = mi.base.textwidth;
 106         // Cache the inset dimension.
 107         setDimCache(mi, dim);
 108 }
 109
 110
 111 void InsetNewpage::draw(PainterInfo & pi, int x, int y) const
 112 {
 113         using frontend::Painter;
 114
 115         FontInfo font;
 116         font.setColor(ColorName());
 117         font.decSize();
 118
 119         Dimension const dim = dimension(*pi.base.bv);
 120
 121         int w = 0;
 122         int a = 0;
 123         int d = 0;
 124         theFontMetrics(font).rectText(insetLabel(), w, a, d);
 125
 126         int const text_start = int(x + (dim.wid - w) / 2);
 127         int const text_end = text_start + w;
 128
 129         pi.pain.rectText(text_start, y + d, insetLabel(), font,
 130                 Color_none, Color_none);
 131
 132         pi.pain.line(x, y, text_start, y,
 133                    ColorName(), Painter::line_onoffdash);
 134         pi.pain.line(text_end, y, int(x + dim.wid), y,
 135                    ColorName(), Painter::line_onoffdash);
 136 }
 137
 138
 139 void InsetNewpage::doDispatch(Cursor & cur, FuncRequest & cmd)
 140 {
 141         switch (cmd.action()) {
 142
 143         case LFUN_INSET_MODIFY: {
 144                 InsetNewpageParams params;
 145                 cur.recordUndo();
 146                 string2params(to_utf8(cmd.argument()), params);
 147                 params_.kind = params.kind;
 148                 break;
 149         }
 150
 151         default:
 152                 Inset::doDispatch(cur, cmd);
 153                 break;
 154         }
 155 }
 156
 157
 158 bool InsetNewpage::getStatus(Cursor & cur, FuncRequest const & cmd,
 159         FuncStatus & status) const
 160 {
 161         switch (cmd.action()) {
 162         // we handle these
 163         case LFUN_INSET_MODIFY:
 164                 if (cmd.getArg(0) == "newpage") {
 165                         InsetNewpageParams params;
 166                         string2params(to_utf8(cmd.argument()), params);
 167                         status.setOnOff(params_.kind == params.kind);
 168                 }
 169                 status.setEnabled(true);
 170                 return true;
 171         default:
 172                 return Inset::getStatus(cur, cmd, status);
 173         }
 174 }
 175
 176
 177 docstring InsetNewpage::insetLabel() const
 178 {
 179         switch (params_.kind) {
 180                 case InsetNewpageParams::NEWPAGE:
 181                         return _("New Page");
 182                         break;
 183                 case InsetNewpageParams::PAGEBREAK:
 184                         return _("Page Break");
 185                         break;
 186                 case InsetNewpageParams::CLEARPAGE:
 187                         return _("Clear Page");
 188                         break;
 189                 case InsetNewpageParams::CLEARDOUBLEPAGE:
 190                         return _("Clear Double Page");
 191                         break;
 192                 default:
 193                         return _("New Page");
 194                         break;
 195         }
 196 }
 197
 198
 199 ColorCode InsetNewpage::ColorName() const
 200 {
 201         switch (params_.kind) {
 202                 case InsetNewpageParams::PAGEBREAK:
 203                         return Color_pagebreak;
 204                         break;
 205                 case InsetNewpageParams::NEWPAGE:
 206                 case InsetNewpageParams::CLEARPAGE:
 207                 case InsetNewpageParams::CLEARDOUBLEPAGE:
 208                         return Color_newpage;
 209                         break;
 210         }
 211         // not really useful, but to avoids gcc complaints
 212         return Color_newpage;
 213 }
 214
 215
 216 void InsetNewpage::latex(otexstream & os, OutputParams const & runparams) const
 217 {
 218         switch (params_.kind) {
 219                 case InsetNewpageParams::NEWPAGE:
 220                         os << "\\newpage{}";
 221                         break;
 222                 case InsetNewpageParams::PAGEBREAK:
 223                         if (runparams.moving_arg)
 224                                 os << "\\protect";
 225                         os << "\\pagebreak{}";
 226                         break;
 227                 case InsetNewpageParams::CLEARPAGE:
 228                         os << "\\clearpage{}";
 229                         break;
 230                 case InsetNewpageParams::CLEARDOUBLEPAGE:
 231                         os << "\\cleardoublepage{}";
 232                         break;
 233                 default:
 234                         os << "\\newpage{}";
 235                         break;
 236         }
 237 }
 238
 239
 240 int InsetNewpage::plaintext(odocstringstream & os,
 241         OutputParams const &, size_t) const
 242 {
 243         os << '\n';
 244         return PLAINTEXT_NEWLINE;
 245 }
 246
 247
 248 int InsetNewpage::docbook(odocstream & os, OutputParams const &) const
 249 {
 250         os << '\n';
 251         return 0;
 252 }
 253
 254
 255 docstring InsetNewpage::xhtml(XHTMLStream & xs, OutputParams const &) const
 256 {
 257         xs << html::CompTag("br");
 258         return docstring();
 259 }
 260
 261
 262 string InsetNewpage::contextMenuName() const
 263 {
 264         return "context-newpage";
 265 }
 266
 267
 268 void InsetNewpage::string2params(string const & in, InsetNewpageParams & params)
 269 {
 270         params = InsetNewpageParams();
 271         if (in.empty())
 272                 return;
 273
 274         istringstream data(in);
 275         Lexer lex;
 276         lex.setStream(data);
 277
 278         string name;
 279         lex >> name;
 280         if (!lex || name != "newpage") {
 281                 LYXERR0("Expected arg 2 to be \"wrap\" in " << in);
 282                 return;
 283         }
 284
 285         params.read(lex);
 286 }
 287
 288
 289 string InsetNewpage::params2string(InsetNewpageParams const & params)
 290 {
 291         ostringstream data;
 292         data << "newpage" << ' ';
 293         params.write(data);
 294         return data.str();
 295 }
 296
 297
 298 } // namespace lyx