3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Alejandro Aguilar Sierra
8 * \author Angus Leeming
10 * Full author contact details are available in file CREDITS.
15 #include "GuiInclude.h"
17 #include "frontend_helpers.h"
21 #include "FuncRequest.h"
25 #include "qt_helpers.h"
28 #include "support/os.h"
29 #include "support/lstrings.h"
30 #include "support/FileFilterList.h"
31 #include "support/filetools.h"
33 #include "insets/InsetListingsParams.h"
34 #include "insets/InsetInclude.h"
36 #include <QPushButton>
38 #include <QCloseEvent>
52 using support::FileFilterList;
53 using support::FileName;
54 using support::makeAbsPath;
55 using support::onlyPath;
56 using support::os::internal_path;
57 using support::prefixIs;
58 using support::getStringFromVector;
59 using support::getVectorFromString;
62 /// Flags what action is taken by Kernel::dispatch()
63 static std::string const lfun_name_ = "include";
66 GuiInclude::GuiInclude(LyXView & lv)
67 : GuiDialog(lv, "include"), params_(INCLUDE_CODE)
70 setViewTitle(_("Child Document"));
72 connect(okPB, SIGNAL(clicked()), this, SLOT(slotOK()));
73 connect(closePB, SIGNAL(clicked()), this, SLOT(slotClose()));
75 connect(visiblespaceCB, SIGNAL(clicked()), this, SLOT(change_adaptor()));
76 connect(filenameED, SIGNAL(textChanged(const QString &)),
77 this, SLOT(change_adaptor()));
78 connect(editPB, SIGNAL(clicked()), this, SLOT(edit()));
79 connect(browsePB, SIGNAL(clicked()), this, SLOT(browse()));
80 connect(typeCO, SIGNAL(activated(int)), this, SLOT(change_adaptor()));
81 connect(typeCO, SIGNAL(activated(int)), this, SLOT(typeChanged(int)));
82 connect(previewCB, SIGNAL(clicked()), this, SLOT(change_adaptor()));
83 connect(captionLE, SIGNAL(textChanged(const QString&)), this, SLOT(change_adaptor()));
84 connect(labelLE, SIGNAL(textChanged(const QString&)), this, SLOT(change_adaptor()));
85 connect(listingsED, SIGNAL(textChanged()), this, SLOT(change_adaptor()));
86 connect(listingsED, SIGNAL(textChanged()), this, SLOT(set_listings_msg()));
87 connect(bypassCB, SIGNAL(clicked()), this, SLOT(change_adaptor()));
88 connect(bypassCB, SIGNAL(clicked()), this, SLOT(set_listings_msg()));
90 setFocusProxy(filenameED);
92 bc().setPolicy(ButtonPolicy::OkApplyCancelReadOnlyPolicy);
94 bc().setCancel(closePB);
95 bc().addReadOnly(filenameED);
96 bc().addReadOnly(browsePB);
97 bc().addReadOnly(visiblespaceCB);
98 bc().addReadOnly(typeCO);
99 bc().addReadOnly(listingsED);
101 bc().addCheckedLineEdit(filenameED, filenameLA);
105 void GuiInclude::change_adaptor()
111 docstring GuiInclude::validate_listings_params()
113 // use a cache here to avoid repeated validation
114 // of the same parameters
115 static string param_cache = string();
116 static docstring msg_cache = docstring();
118 if (typeCO->currentIndex() != 3 || bypassCB->isChecked())
121 string params = fromqstr(listingsED->toPlainText());
122 if (params != param_cache) {
123 param_cache = params;
124 msg_cache = InsetListingsParams(params).validate();
130 void GuiInclude::set_listings_msg()
132 static bool isOK = true;
133 docstring msg = validate_listings_params();
138 listingsTB->setPlainText(
139 qt_("Input listing parameters on the right. Enter ? for a list of parameters."));
142 listingsTB->setPlainText(toqstr(msg));
147 void GuiInclude::closeEvent(QCloseEvent * e)
154 void GuiInclude::typeChanged(int v)
159 visiblespaceCB->setEnabled(false);
160 visiblespaceCB->setChecked(false);
161 previewCB->setEnabled(false);
162 previewCB->setChecked(false);
163 listingsGB->setEnabled(false);
167 visiblespaceCB->setEnabled(false);
168 visiblespaceCB->setChecked(false);
169 previewCB->setEnabled(true);
170 listingsGB->setEnabled(false);
174 visiblespaceCB->setEnabled(false);
175 visiblespaceCB->setChecked(false);
176 previewCB->setEnabled(false);
177 previewCB->setChecked(false);
178 listingsGB->setEnabled(true);
182 visiblespaceCB->setEnabled(true);
183 previewCB->setEnabled(false);
184 previewCB->setChecked(false);
185 listingsGB->setEnabled(false);
189 // http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg118471.html
190 //for the reason this is here.
191 okPB->setDefault(true);
195 void GuiInclude::updateContents()
197 filenameED->setText(toqstr(params_["filename"]));
199 visiblespaceCB->setChecked(false);
200 visiblespaceCB->setEnabled(false);
201 previewCB->setChecked(false);
202 previewCB->setEnabled(false);
203 listingsGB->setEnabled(false);
207 listingsTB->setPlainText(
208 qt_("Input listing parameters on the right. Enter ? for a list of parameters."));
210 string cmdname = params_.getCmdName();
211 if (cmdname != "include" &&
212 cmdname != "verbatiminput" &&
213 cmdname != "verbatiminput*" &&
214 cmdname != "lstinputlisting")
217 if (cmdname == "include") {
218 typeCO->setCurrentIndex(0);
220 } else if (cmdname == "input") {
221 typeCO->setCurrentIndex(1);
222 previewCB->setEnabled(true);
223 previewCB->setChecked(params_.preview());
225 } else if (cmdname == "verbatiminput*") {
226 typeCO->setCurrentIndex(2);
227 visiblespaceCB->setEnabled(true);
228 visiblespaceCB->setChecked(true);
230 } else if (cmdname == "verbatiminput") {
231 typeCO->setCurrentIndex(2);
232 visiblespaceCB->setEnabled(true);
234 } else if (cmdname == "lstinputlisting") {
235 typeCO->setCurrentIndex(3);
236 listingsGB->setEnabled(true);
237 listingsED->setEnabled(true);
238 InsetListingsParams par(to_utf8(params_["lstparams"]));
239 // extract caption and label and put them into their respective editboxes
240 vector<string> pars = getVectorFromString(par.separatedParams(), "\n");
241 for (vector<string>::iterator it = pars.begin();
242 it != pars.end(); ++it) {
243 if (prefixIs(*it, "caption=")) {
244 string cap = it->substr(8);
245 if (cap[0] == '{' && cap[cap.size() - 1] == '}') {
246 captionLE->setText(toqstr(cap.substr(1, cap.size() - 2)));
249 } else if (prefixIs(*it, "label=")) {
250 string lbl = it->substr(6);
251 if (lbl[0] == '{' && lbl[lbl.size()-1] == '}') {
252 labelLE->setText(toqstr(lbl.substr(1, lbl.size() - 2)));
257 // the rest is put to the extra edit box.
258 string extra = getStringFromVector(pars);
259 listingsED->setPlainText(toqstr(InsetListingsParams(extra).separatedParams()));
264 void GuiInclude::applyView()
266 params_["filename"] = from_utf8(internal_path(fromqstr(filenameED->text())));
267 params_.preview(previewCB->isChecked());
269 int const item = typeCO->currentIndex();
271 params_.setCmdName("include");
272 } else if (item == 1) {
273 params_.setCmdName("input");
274 } else if (item == 3) {
275 params_.setCmdName("lstinputlisting");
276 // the parameter string should have passed validation
277 InsetListingsParams par(fromqstr(listingsED->toPlainText()));
278 string caption = fromqstr(captionLE->text());
279 string label = fromqstr(labelLE->text());
280 if (!caption.empty())
281 par.addParam("caption", "{" + caption + "}");
283 par.addParam("label", "{" + label + "}");
284 string const listparams = par.params();
285 params_["lstparams"] = from_ascii(listparams);
287 if (visiblespaceCB->isChecked())
288 params_.setCmdName("verbatiminput*");
290 params_.setCmdName("verbatiminput");
295 void GuiInclude::browse()
299 int const item = typeCO->currentIndex();
309 docstring const & name = browse(qstring_to_ucs4(filenameED->text()), type);
311 filenameED->setText(toqstr(name));
315 void GuiInclude::edit()
318 string const file = fromqstr(filenameED->text());
325 bool GuiInclude::isValid()
327 return !filenameED->text().isEmpty() && validate_listings_params().empty();
331 bool GuiInclude::initialiseParams(string const & data)
333 InsetCommandMailer::string2params(lfun_name_, data, params_);
338 void GuiInclude::clearParams()
344 void GuiInclude::dispatchParams()
346 dispatch(FuncRequest(getLfun(), InsetCommandMailer::params2string(lfun_name_, params_)));
350 docstring GuiInclude::browse(docstring const & in_name, Type in_type) const
352 docstring const title = _("Select document to include");
354 // input TeX, verbatim, or LyX file ?
355 FileFilterList filters;
359 filters = FileFilterList(_("LaTeX/LyX Documents (*.tex *.lyx)"));
366 pair<docstring, docstring> dir1(_("Documents|#o#O"),
367 from_utf8(lyxrc.document_path));
369 docstring const docpath = from_utf8(onlyPath(buffer().absFileName()));
371 return browseRelFile(in_name, docpath, title,
372 filters, false, dir1);
376 void GuiInclude::edit(string const & file)
378 string const ext = support::getExtension(file);
380 dispatch(FuncRequest(LFUN_BUFFER_CHILD_OPEN, file));
382 // tex file or other text file in verbatim mode
383 formats.edit(buffer(),
384 makeAbsPath(file, onlyPath(buffer().absFileName())),
389 Dialog * createGuiInclude(LyXView & lv) { return new GuiInclude(lv); }
392 } // namespace frontend
395 #include "GuiInclude_moc.cpp"