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::isFileReadable;
55 using support::makeAbsPath;
56 using support::onlyPath;
57 using support::os::internal_path;
58 using support::prefixIs;
59 using support::getStringFromVector;
60 using support::getVectorFromString;
63 GuiInclude::GuiInclude(LyXView & lv)
64 : GuiDialog(lv, "include"), Controller(this), params_("include")
67 setViewTitle(_("Child Document"));
68 setController(this, false);
70 connect(okPB, SIGNAL(clicked()), this, SLOT(slotOK()));
71 connect(closePB, SIGNAL(clicked()), this, SLOT(slotClose()));
73 connect(visiblespaceCB, SIGNAL(clicked()), this, SLOT(change_adaptor()));
74 connect(filenameED, SIGNAL(textChanged(const QString &)),
75 this, SLOT(change_adaptor()));
76 connect(editPB, SIGNAL(clicked()), this, SLOT(edit()));
77 connect(browsePB, SIGNAL(clicked()), this, SLOT(browse()));
78 connect(typeCO, SIGNAL(activated(int)), this, SLOT(change_adaptor()));
79 connect(typeCO, SIGNAL(activated(int)), this, SLOT(typeChanged(int)));
80 connect(previewCB, SIGNAL(clicked()), this, SLOT(change_adaptor()));
81 connect(captionLE, SIGNAL(textChanged(const QString&)), this, SLOT(change_adaptor()));
82 connect(labelLE, SIGNAL(textChanged(const QString&)), this, SLOT(change_adaptor()));
83 connect(listingsED, SIGNAL(textChanged()), this, SLOT(change_adaptor()));
84 connect(listingsED, SIGNAL(textChanged()), this, SLOT(set_listings_msg()));
85 connect(bypassCB, SIGNAL(clicked()), this, SLOT(change_adaptor()));
86 connect(bypassCB, SIGNAL(clicked()), this, SLOT(set_listings_msg()));
88 setFocusProxy(filenameED);
90 bc().setPolicy(ButtonPolicy::OkApplyCancelReadOnlyPolicy);
92 bc().setCancel(closePB);
93 bc().addReadOnly(filenameED);
94 bc().addReadOnly(browsePB);
95 bc().addReadOnly(visiblespaceCB);
96 bc().addReadOnly(typeCO);
97 bc().addReadOnly(listingsED);
99 bc().addCheckedLineEdit(filenameED, filenameLA);
103 void GuiInclude::change_adaptor()
109 docstring GuiInclude::validate_listings_params()
111 // use a cache here to avoid repeated validation
112 // of the same parameters
113 static string param_cache = string();
114 static docstring msg_cache = docstring();
116 if (typeCO->currentIndex() != 3 || bypassCB->isChecked())
119 string params = fromqstr(listingsED->toPlainText());
120 if (params != param_cache) {
121 param_cache = params;
122 msg_cache = InsetListingsParams(params).validate();
128 void GuiInclude::set_listings_msg()
130 static bool isOK = true;
131 docstring msg = validate_listings_params();
136 listingsTB->setPlainText(
137 qt_("Input listing parameters on the right. Enter ? for a list of parameters."));
140 listingsTB->setPlainText(toqstr(msg));
145 void GuiInclude::closeEvent(QCloseEvent * e)
152 void GuiInclude::typeChanged(int v)
157 visiblespaceCB->setEnabled(false);
158 visiblespaceCB->setChecked(false);
159 previewCB->setEnabled(false);
160 previewCB->setChecked(false);
161 listingsGB->setEnabled(false);
165 visiblespaceCB->setEnabled(false);
166 visiblespaceCB->setChecked(false);
167 previewCB->setEnabled(true);
168 listingsGB->setEnabled(false);
172 visiblespaceCB->setEnabled(false);
173 visiblespaceCB->setChecked(false);
174 previewCB->setEnabled(false);
175 previewCB->setChecked(false);
176 listingsGB->setEnabled(true);
180 visiblespaceCB->setEnabled(true);
181 previewCB->setEnabled(false);
182 previewCB->setChecked(false);
183 listingsGB->setEnabled(false);
187 // http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg118471.html
188 //for the reason this is here.
189 okPB->setDefault(true);
193 void GuiInclude::updateContents()
195 filenameED->setText(toqstr(params_["filename"]));
197 visiblespaceCB->setChecked(false);
198 visiblespaceCB->setEnabled(false);
199 previewCB->setChecked(false);
200 previewCB->setEnabled(false);
201 listingsGB->setEnabled(false);
205 listingsTB->setPlainText(
206 qt_("Input listing parameters on the right. Enter ? for a list of parameters."));
208 string cmdname = params_.getCmdName();
209 if (cmdname != "include" &&
210 cmdname != "verbatiminput" &&
211 cmdname != "verbatiminput*" &&
212 cmdname != "lstinputlisting")
215 if (cmdname == "include") {
216 typeCO->setCurrentIndex(0);
218 } else if (cmdname == "input") {
219 typeCO->setCurrentIndex(1);
220 previewCB->setEnabled(true);
221 previewCB->setChecked(params_.preview());
223 } else if (cmdname == "verbatiminput*") {
224 typeCO->setCurrentIndex(2);
225 visiblespaceCB->setEnabled(true);
226 visiblespaceCB->setChecked(true);
228 } else if (cmdname == "verbatiminput") {
229 typeCO->setCurrentIndex(2);
230 visiblespaceCB->setEnabled(true);
232 } else if (cmdname == "lstinputlisting") {
233 typeCO->setCurrentIndex(3);
234 listingsGB->setEnabled(true);
235 listingsED->setEnabled(true);
236 InsetListingsParams par(params_.getOptions());
237 // extract caption and label and put them into their respective editboxes
238 vector<string> pars = getVectorFromString(par.separatedParams(), "\n");
239 for (vector<string>::iterator it = pars.begin();
240 it != pars.end(); ++it) {
241 if (prefixIs(*it, "caption=")) {
242 string cap = it->substr(8);
243 if (cap[0] == '{' && cap[cap.size() - 1] == '}') {
244 captionLE->setText(toqstr(cap.substr(1, cap.size() - 2)));
247 } else if (prefixIs(*it, "label=")) {
248 string lbl = it->substr(6);
249 if (lbl[0] == '{' && lbl[lbl.size()-1] == '}') {
250 labelLE->setText(toqstr(lbl.substr(1, lbl.size() - 2)));
255 // the rest is put to the extra edit box.
256 string extra = getStringFromVector(pars);
257 listingsED->setPlainText(toqstr(InsetListingsParams(extra).separatedParams()));
262 void GuiInclude::applyView()
264 params_["filename"] = from_utf8(internal_path(fromqstr(filenameED->text())));
265 params_.preview(previewCB->isChecked());
267 int const item = typeCO->currentIndex();
269 params_.setCmdName("include");
270 } else if (item == 1) {
271 params_.setCmdName("input");
272 } else if (item == 3) {
273 params_.setCmdName("lstinputlisting");
274 // the parameter string should have passed validation
275 InsetListingsParams par(fromqstr(listingsED->toPlainText()));
276 string caption = fromqstr(captionLE->text());
277 string label = fromqstr(labelLE->text());
278 if (!caption.empty())
279 par.addParam("caption", "{" + caption + "}");
281 par.addParam("label", "{" + label + "}");
282 params_.setOptions(par.params());
284 if (visiblespaceCB->isChecked())
285 params_.setCmdName("verbatiminput*");
287 params_.setCmdName("verbatiminput");
292 void GuiInclude::browse()
296 int const item = typeCO->currentIndex();
306 docstring const & name = browse(qstring_to_ucs4(filenameED->text()), type);
308 filenameED->setText(toqstr(name));
312 void GuiInclude::edit()
315 string const file = fromqstr(filenameED->text());
322 bool GuiInclude::isValid()
324 return !filenameED->text().isEmpty() && validate_listings_params().empty();
328 bool GuiInclude::initialiseParams(string const & data)
330 InsetIncludeMailer::string2params(data, params_);
335 void GuiInclude::clearParams()
341 void GuiInclude::dispatchParams()
343 dispatch(FuncRequest(getLfun(), InsetIncludeMailer::params2string(params_)));
347 docstring GuiInclude::browse(docstring const & in_name, Type in_type) const
349 docstring const title = _("Select document to include");
351 // input TeX, verbatim, or LyX file ?
352 FileFilterList filters;
356 filters = FileFilterList(_("LaTeX/LyX Documents (*.tex *.lyx)"));
364 pair<docstring, docstring> dir1(_("Documents|#o#O"),
365 from_utf8(lyxrc.document_path));
367 docstring const docpath = from_utf8(onlyPath(buffer().fileName()));
369 return browseRelFile(in_name, docpath, title,
370 filters, false, dir1);
374 void GuiInclude::edit(string const & file)
376 string const ext = support::getExtension(file);
378 dispatch(FuncRequest(LFUN_BUFFER_CHILD_OPEN, file));
380 // tex file or other text file in verbatim mode
381 formats.edit(buffer(),
382 FileName(makeAbsPath(file, onlyPath(buffer().fileName()))),
387 Dialog * createGuiInclude(LyXView & lv) { return new GuiInclude(lv); }
390 } // namespace frontend
393 #include "GuiInclude_moc.cpp"