2 * \file InsetBranch.cpp
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Martin Vermeer
8 * Full author contact details are available in file CREDITS.
13 #include "InsetBranch.h"
16 #include "BufferParams.h"
17 #include "BufferView.h"
18 #include "BranchList.h"
22 #include "DispatchResult.h"
23 #include "FuncRequest.h"
24 #include "FuncStatus.h"
26 #include "OutputParams.h"
27 #include "TextClass.h"
28 #include "TocBackend.h"
30 #include "support/debug.h"
31 #include "support/gettext.h"
33 #include "frontends/Application.h"
42 InsetBranch::InsetBranch(Buffer const & buf, InsetBranchParams const & params)
43 : InsetCollapsable(buf), params_(params)
45 // override the default for InsetCollapsable, which is to
46 // use the plain layout.
47 DocumentClass const & dc = buf.params().documentClass();
48 paragraphs().back().setDefaultLayout(dc);
52 InsetBranch::~InsetBranch()
54 hideDialogs("branch", this);
58 docstring InsetBranch::editMessage() const
60 return _("Opened Branch Inset");
64 void InsetBranch::write(ostream & os) const
67 InsetCollapsable::write(os);
71 void InsetBranch::read(Lexer & lex)
74 InsetCollapsable::read(lex);
78 docstring InsetBranch::toolTip(BufferView const &, int, int) const
80 return _("Branch: ") + params_.branch;
84 docstring const InsetBranch::buttonLabel(BufferView const & bv) const
86 docstring s = _("Branch: ") + params_.branch;
87 if (!params_.branch.empty()) {
89 ColorCode c = lcolor.getFromLyXName(to_utf8(params_.branch));
93 if (decoration() == InsetLayout::CLASSIC)
94 return isOpen(bv) ? s : getNewLabel(s);
96 return params_.branch + ": " + getNewLabel(s);
100 ColorCode InsetBranch::backgroundColor() const
102 if (params_.branch.empty())
103 return Inset::backgroundColor();
105 ColorCode c = lcolor.getFromLyXName(to_utf8(params_.branch));
112 bool InsetBranch::showInsetDialog(BufferView * bv) const
114 bv->showDialog("branch", params2string(params()),
115 const_cast<InsetBranch *>(this));
120 void InsetBranch::doDispatch(Cursor & cur, FuncRequest & cmd)
122 switch (cmd.action) {
123 case LFUN_INSET_MODIFY: {
124 InsetBranchParams params;
125 InsetBranch::string2params(to_utf8(cmd.argument()), params);
126 params_.branch = params.branch;
127 setLayout(cur.buffer()->params());
131 case LFUN_MOUSE_PRESS:
132 if (cmd.button() != mouse_button::button3)
133 InsetCollapsable::doDispatch(cur, cmd);
138 case LFUN_INSET_DIALOG_UPDATE:
139 cur.bv().updateDialog("branch", params2string(params()));
142 case LFUN_INSET_TOGGLE:
143 if (cmd.argument() == "assign") {
144 // The branch inset uses "assign".
145 if (isBranchSelected()) {
146 if (status(cur.bv()) != Open)
147 setStatus(cur, Open);
151 if (status(cur.bv()) != Collapsed)
152 setStatus(cur, Collapsed);
158 InsetCollapsable::doDispatch(cur, cmd);
162 InsetCollapsable::doDispatch(cur, cmd);
168 bool InsetBranch::getStatus(Cursor & cur, FuncRequest const & cmd,
169 FuncStatus & flag) const
171 switch (cmd.action) {
172 case LFUN_INSET_MODIFY:
173 case LFUN_INSET_DIALOG_UPDATE:
174 flag.setEnabled(true);
177 case LFUN_INSET_TOGGLE:
178 if (cmd.argument() == "open")
179 flag.setEnabled(status_ != Open);
180 else if (cmd.argument() == "close")
181 flag.setEnabled(status_ == Open);
182 else if (cmd.argument() == "toggle")
183 flag.setEnabled(true);
184 else if (cmd.argument() == "assign" || cmd.argument().empty()) {
185 if (isBranchSelected())
186 flag.setEnabled(status(cur.bv()) != Open);
188 flag.setEnabled(status(cur.bv()) != Collapsed);
190 flag.setEnabled(true);
194 return InsetCollapsable::getStatus(cur, cmd, flag);
200 bool InsetBranch::isBranchSelected() const
202 Buffer const & realbuffer = *buffer().masterBuffer();
203 BranchList const & branchlist = realbuffer.params().branchlist();
204 Branch const * ourBranch = branchlist.find(params_.branch);
207 return ourBranch->isSelected();
211 int InsetBranch::latex(odocstream & os, OutputParams const & runparams) const
213 return isBranchSelected() ? InsetText::latex(os, runparams) : 0;
217 int InsetBranch::plaintext(odocstream & os,
218 OutputParams const & runparams) const
220 if (!isBranchSelected())
223 os << '[' << buffer().B_("branch") << ' ' << params_.branch << ":\n";
224 InsetText::plaintext(os, runparams);
227 return PLAINTEXT_NEWLINE + 1; // one char on a separate line
231 int InsetBranch::docbook(odocstream & os,
232 OutputParams const & runparams) const
234 return isBranchSelected() ? InsetText::docbook(os, runparams) : 0;
238 void InsetBranch::tocString(odocstream & os) const
240 if (isBranchSelected())
241 InsetCollapsable::tocString(os);
245 void InsetBranch::validate(LaTeXFeatures & features) const
247 if (isBranchSelected())
248 InsetCollapsable::validate(features);
252 bool InsetBranch::isMacroScope() const
254 // Its own scope if not selected by buffer
255 return !isBranchSelected();
259 string InsetBranch::params2string(InsetBranchParams const & params)
262 data << "branch" << ' ';
268 void InsetBranch::string2params(string const & in, InsetBranchParams & params)
270 params = InsetBranchParams();
274 istringstream data(in);
277 lex.setContext("InsetBranch::string2params");
278 lex >> "branch" >> "Branch";
283 void InsetBranch::addToToc(DocIterator const & cpit)
285 DocIterator pit = cpit;
286 pit.push_back(CursorSlice(*this));
288 Toc & toc = buffer().tocBackend().toc("branch");
289 docstring const str = params_.branch + ": " + text().getPar(0).asString();
290 toc.push_back(TocItem(pit, 0, str));
291 // Proceed with the rest of the inset.
292 InsetCollapsable::addToToc(cpit);
296 void InsetBranchParams::write(ostream & os) const
298 os << "Branch " << to_utf8(branch) << '\n';
302 void InsetBranchParams::read(Lexer & lex)
305 branch = lex.getDocString();