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"
19 #include "FuncRequest.h"
20 #include "support/gettext.h"
23 #include "qt_helpers.h"
26 #include "support/os.h"
27 #include "support/lstrings.h"
28 #include "support/FileFilterList.h"
29 #include "support/FileName.h"
30 #include "support/filetools.h"
32 #include "insets/InsetListingsParams.h"
33 #include "insets/InsetInclude.h"
35 #include <QPushButton>
42 using namespace lyx::support;
43 using namespace lyx::support::os;
49 GuiInclude::GuiInclude(GuiView & lv)
50 : GuiDialog(lv, "include", qt_("Child Document")),
51 params_(insetCode("include"))
55 connect(okPB, SIGNAL(clicked()), this, SLOT(slotOK()));
56 connect(closePB, SIGNAL(clicked()), this, SLOT(slotClose()));
58 connect(visiblespaceCB, SIGNAL(clicked()), this, SLOT(change_adaptor()));
59 connect(filenameED, SIGNAL(textChanged(const QString &)),
60 this, SLOT(change_adaptor()));
61 connect(editPB, SIGNAL(clicked()), this, SLOT(edit()));
62 connect(browsePB, SIGNAL(clicked()), this, SLOT(browse()));
63 connect(typeCO, SIGNAL(activated(int)), this, SLOT(change_adaptor()));
64 connect(typeCO, SIGNAL(activated(int)), this, SLOT(typeChanged(int)));
65 connect(previewCB, SIGNAL(clicked()), this, SLOT(change_adaptor()));
66 connect(captionLE, SIGNAL(textChanged(const QString&)), this, SLOT(change_adaptor()));
67 connect(labelLE, SIGNAL(textChanged(const QString&)), this, SLOT(change_adaptor()));
68 connect(listingsED, SIGNAL(textChanged()), this, SLOT(change_adaptor()));
69 connect(listingsED, SIGNAL(textChanged()), this, SLOT(set_listings_msg()));
70 connect(bypassCB, SIGNAL(clicked()), this, SLOT(change_adaptor()));
71 connect(bypassCB, SIGNAL(clicked()), this, SLOT(set_listings_msg()));
73 setFocusProxy(filenameED);
75 bc().setPolicy(ButtonPolicy::OkApplyCancelReadOnlyPolicy);
77 bc().setCancel(closePB);
78 bc().addReadOnly(filenameED);
79 bc().addReadOnly(browsePB);
80 bc().addReadOnly(visiblespaceCB);
81 bc().addReadOnly(typeCO);
82 bc().addReadOnly(listingsED);
84 bc().addCheckedLineEdit(filenameED, filenameLA);
88 void GuiInclude::change_adaptor()
94 docstring GuiInclude::validate_listings_params()
96 // use a cache here to avoid repeated validation
97 // of the same parameters
98 static string param_cache = string();
99 static docstring msg_cache = docstring();
101 if (typeCO->currentIndex() != 3 || bypassCB->isChecked())
104 string params = fromqstr(listingsED->toPlainText());
105 if (params != param_cache) {
106 param_cache = params;
107 msg_cache = InsetListingsParams(params).validate();
113 void GuiInclude::set_listings_msg()
115 static bool isOK = true;
116 docstring msg = validate_listings_params();
121 listingsTB->setPlainText(
122 qt_("Input listing parameters on the right. Enter ? for a list of parameters."));
125 listingsTB->setPlainText(toqstr(msg));
130 void GuiInclude::typeChanged(int v)
135 visiblespaceCB->setEnabled(false);
136 visiblespaceCB->setChecked(false);
137 previewCB->setEnabled(false);
138 previewCB->setChecked(false);
139 listingsGB->setEnabled(false);
143 visiblespaceCB->setEnabled(false);
144 visiblespaceCB->setChecked(false);
145 previewCB->setEnabled(true);
146 listingsGB->setEnabled(false);
150 visiblespaceCB->setEnabled(false);
151 visiblespaceCB->setChecked(false);
152 previewCB->setEnabled(false);
153 previewCB->setChecked(false);
154 listingsGB->setEnabled(true);
158 visiblespaceCB->setEnabled(true);
159 previewCB->setEnabled(false);
160 previewCB->setChecked(false);
161 listingsGB->setEnabled(false);
165 // http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg118471.html
166 //for the reason this is here.
167 okPB->setDefault(true);
171 void GuiInclude::updateContents()
173 filenameED->setText(toqstr(params_["filename"]));
175 visiblespaceCB->setChecked(false);
176 visiblespaceCB->setEnabled(false);
177 previewCB->setChecked(false);
178 previewCB->setEnabled(false);
179 listingsGB->setEnabled(false);
183 listingsTB->setPlainText(
184 qt_("Input listing parameters on the right. Enter ? for a list of parameters."));
186 string cmdname = params_.getCmdName();
187 if (cmdname != "include" &&
188 cmdname != "verbatiminput" &&
189 cmdname != "verbatiminput*" &&
190 cmdname != "lstinputlisting")
193 if (cmdname == "include") {
194 typeCO->setCurrentIndex(0);
196 } else if (cmdname == "input") {
197 typeCO->setCurrentIndex(1);
198 previewCB->setEnabled(true);
199 previewCB->setChecked(params_.preview());
201 } else if (cmdname == "verbatiminput*") {
202 typeCO->setCurrentIndex(2);
203 visiblespaceCB->setEnabled(true);
204 visiblespaceCB->setChecked(true);
206 } else if (cmdname == "verbatiminput") {
207 typeCO->setCurrentIndex(2);
208 visiblespaceCB->setEnabled(true);
210 } else if (cmdname == "lstinputlisting") {
211 typeCO->setCurrentIndex(3);
212 listingsGB->setEnabled(true);
213 listingsED->setEnabled(true);
214 InsetListingsParams par(to_utf8(params_["lstparams"]));
215 // extract caption and label and put them into their respective editboxes
216 vector<string> pars = getVectorFromString(par.separatedParams(), "\n");
217 for (vector<string>::iterator it = pars.begin();
218 it != pars.end(); ++it) {
219 if (prefixIs(*it, "caption=")) {
220 string cap = it->substr(8);
221 if (cap[0] == '{' && cap[cap.size() - 1] == '}') {
222 captionLE->setText(toqstr(cap.substr(1, cap.size() - 2)));
225 } else if (prefixIs(*it, "label=")) {
226 string lbl = it->substr(6);
227 if (lbl[0] == '{' && lbl[lbl.size()-1] == '}') {
228 labelLE->setText(toqstr(lbl.substr(1, lbl.size() - 2)));
233 // the rest is put to the extra edit box.
234 string extra = getStringFromVector(pars);
235 listingsED->setPlainText(toqstr(InsetListingsParams(extra).separatedParams()));
240 void GuiInclude::applyView()
242 params_["filename"] = from_utf8(internal_path(fromqstr(filenameED->text())));
243 params_.preview(previewCB->isChecked());
245 int const item = typeCO->currentIndex();
247 params_.setCmdName("include");
248 } else if (item == 1) {
249 params_.setCmdName("input");
250 } else if (item == 3) {
251 params_.setCmdName("lstinputlisting");
252 // the parameter string should have passed validation
253 InsetListingsParams par(fromqstr(listingsED->toPlainText()));
254 string caption = fromqstr(captionLE->text());
255 string label = fromqstr(labelLE->text());
256 if (!caption.empty())
257 par.addParam("caption", "{" + caption + "}");
259 par.addParam("label", "{" + label + "}");
260 string const listparams = par.params();
261 params_["lstparams"] = from_ascii(listparams);
263 if (visiblespaceCB->isChecked())
264 params_.setCmdName("verbatiminput*");
266 params_.setCmdName("verbatiminput");
271 void GuiInclude::browse()
275 int const item = typeCO->currentIndex();
285 QString name = browse(filenameED->text(), type);
287 filenameED->setText(name);
291 void GuiInclude::edit()
294 string const file = fromqstr(filenameED->text());
301 bool GuiInclude::isValid()
303 return !filenameED->text().isEmpty() && validate_listings_params().empty();
307 QString GuiInclude::browse(QString const & in_name, Type in_type) const
309 QString const title = qt_("Select document to include");
311 // input TeX, verbatim, or LyX file ?
312 FileFilterList filters;
316 filters = FileFilterList(_("LaTeX/LyX Documents (*.tex *.lyx)"));
323 QString const docpath = toqstr(support::onlyPath(buffer().absFileName()));
325 return browseRelFile(in_name, docpath, title, filters, false,
326 qt_("Documents|#o#O"), toqstr(lyxrc.document_path));
330 void GuiInclude::edit(string const & file)
332 string const ext = support::getExtension(file);
334 dispatch(FuncRequest(LFUN_BUFFER_CHILD_OPEN, file));
336 // tex file or other text file in verbatim mode
337 formats.edit(buffer(),
338 makeAbsPath(file, support::onlyPath(buffer().absFileName())),
343 bool GuiInclude::initialiseParams(std::string const & data)
345 InsetCommand::string2params("include", data, params_);
350 void GuiInclude::dispatchParams()
352 std::string const lfun = InsetCommand::params2string("include", params_);
353 dispatch(FuncRequest(getLfun(), lfun));
357 Dialog * createGuiInclude(GuiView & lv) { return new GuiInclude(lv); }
360 } // namespace frontend
363 #include "GuiInclude_moc.cpp"