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/filetools.h"
31 #include "insets/InsetListingsParams.h"
32 #include "insets/InsetInclude.h"
34 #include <QPushButton>
36 #include <QCloseEvent>
42 using namespace lyx::support;
43 using namespace lyx::support::os;
49 GuiInclude::GuiInclude(GuiView & lv)
50 : GuiCommand(lv, "include", qt_("Child Document"))
54 connect(okPB, SIGNAL(clicked()), this, SLOT(slotOK()));
55 connect(closePB, SIGNAL(clicked()), this, SLOT(slotClose()));
57 connect(visiblespaceCB, SIGNAL(clicked()), this, SLOT(change_adaptor()));
58 connect(filenameED, SIGNAL(textChanged(const QString &)),
59 this, SLOT(change_adaptor()));
60 connect(editPB, SIGNAL(clicked()), this, SLOT(edit()));
61 connect(browsePB, SIGNAL(clicked()), this, SLOT(browse()));
62 connect(embedCB, SIGNAL(toggled(bool)), this, SLOT(change_adaptor()));
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::closeEvent(QCloseEvent * e)
137 void GuiInclude::typeChanged(int v)
142 visiblespaceCB->setEnabled(false);
143 visiblespaceCB->setChecked(false);
144 previewCB->setEnabled(false);
145 previewCB->setChecked(false);
146 listingsGB->setEnabled(false);
150 visiblespaceCB->setEnabled(false);
151 visiblespaceCB->setChecked(false);
152 previewCB->setEnabled(true);
153 listingsGB->setEnabled(false);
157 visiblespaceCB->setEnabled(false);
158 visiblespaceCB->setChecked(false);
159 previewCB->setEnabled(false);
160 previewCB->setChecked(false);
161 listingsGB->setEnabled(true);
165 visiblespaceCB->setEnabled(true);
166 previewCB->setEnabled(false);
167 previewCB->setChecked(false);
168 listingsGB->setEnabled(false);
172 // http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg118471.html
173 //for the reason this is here.
174 okPB->setDefault(true);
178 void GuiInclude::updateContents()
180 filenameED->setText(toqstr(params_["filename"]));
181 embedCB->setCheckState(params_["embed"].empty() ? Qt::Unchecked : Qt::Checked);
183 visiblespaceCB->setChecked(false);
184 visiblespaceCB->setEnabled(false);
185 previewCB->setChecked(false);
186 previewCB->setEnabled(false);
187 listingsGB->setEnabled(false);
191 listingsTB->setPlainText(
192 qt_("Input listing parameters on the right. Enter ? for a list of parameters."));
194 string cmdname = params_.getCmdName();
195 if (cmdname != "include" &&
196 cmdname != "verbatiminput" &&
197 cmdname != "verbatiminput*" &&
198 cmdname != "lstinputlisting")
201 if (cmdname == "include") {
202 typeCO->setCurrentIndex(0);
204 } else if (cmdname == "input") {
205 typeCO->setCurrentIndex(1);
206 previewCB->setEnabled(true);
207 previewCB->setChecked(params_.preview());
209 } else if (cmdname == "verbatiminput*") {
210 typeCO->setCurrentIndex(2);
211 visiblespaceCB->setEnabled(true);
212 visiblespaceCB->setChecked(true);
214 } else if (cmdname == "verbatiminput") {
215 typeCO->setCurrentIndex(2);
216 visiblespaceCB->setEnabled(true);
218 } else if (cmdname == "lstinputlisting") {
219 typeCO->setCurrentIndex(3);
220 listingsGB->setEnabled(true);
221 listingsED->setEnabled(true);
222 InsetListingsParams par(to_utf8(params_["lstparams"]));
223 // extract caption and label and put them into their respective editboxes
224 vector<string> pars = getVectorFromString(par.separatedParams(), "\n");
225 for (vector<string>::iterator it = pars.begin();
226 it != pars.end(); ++it) {
227 if (prefixIs(*it, "caption=")) {
228 string cap = it->substr(8);
229 if (cap[0] == '{' && cap[cap.size() - 1] == '}') {
230 captionLE->setText(toqstr(cap.substr(1, cap.size() - 2)));
233 } else if (prefixIs(*it, "label=")) {
234 string lbl = it->substr(6);
235 if (lbl[0] == '{' && lbl[lbl.size()-1] == '}') {
236 labelLE->setText(toqstr(lbl.substr(1, lbl.size() - 2)));
241 // the rest is put to the extra edit box.
242 string extra = getStringFromVector(pars);
243 listingsED->setPlainText(toqstr(InsetListingsParams(extra).separatedParams()));
248 void GuiInclude::applyView()
250 params_["filename"] = from_utf8(internal_path(fromqstr(filenameED->text())));
251 params_["embed"] = embedCB->checkState() == Qt::Checked ? _("true") : _("false");
252 params_.preview(previewCB->isChecked());
254 int const item = typeCO->currentIndex();
256 params_.setCmdName("include");
257 } else if (item == 1) {
258 params_.setCmdName("input");
259 } else if (item == 3) {
260 params_.setCmdName("lstinputlisting");
261 // the parameter string should have passed validation
262 InsetListingsParams par(fromqstr(listingsED->toPlainText()));
263 string caption = fromqstr(captionLE->text());
264 string label = fromqstr(labelLE->text());
265 if (!caption.empty())
266 par.addParam("caption", "{" + caption + "}");
268 par.addParam("label", "{" + label + "}");
269 string const listparams = par.params();
270 params_["lstparams"] = from_ascii(listparams);
272 if (visiblespaceCB->isChecked())
273 params_.setCmdName("verbatiminput*");
275 params_.setCmdName("verbatiminput");
280 void GuiInclude::browse()
284 int const item = typeCO->currentIndex();
294 docstring const & name = browse(qstring_to_ucs4(filenameED->text()), type);
296 filenameED->setText(toqstr(name));
300 void GuiInclude::edit()
303 string const file = fromqstr(filenameED->text());
310 bool GuiInclude::isValid()
312 return !filenameED->text().isEmpty() && validate_listings_params().empty();
316 docstring GuiInclude::browse(docstring const & in_name, Type in_type) const
318 docstring const title = _("Select document to include");
320 // input TeX, verbatim, or LyX file ?
321 FileFilterList filters;
325 filters = FileFilterList(_("LaTeX/LyX Documents (*.tex *.lyx)"));
332 docstring const docpath = from_utf8(onlyPath(buffer().absFileName()));
334 return browseRelFile(in_name, docpath, title, filters, false,
335 _("Documents|#o#O"), from_utf8(lyxrc.document_path));
339 void GuiInclude::edit(string const & file)
341 string const ext = support::getExtension(file);
343 dispatch(FuncRequest(LFUN_BUFFER_CHILD_OPEN, file));
345 // tex file or other text file in verbatim mode
346 formats.edit(buffer(),
347 makeAbsPath(file, onlyPath(buffer().absFileName())),
352 Dialog * createGuiInclude(GuiView & lv) { return new GuiInclude(lv); }
355 } // namespace frontend
358 #include "GuiInclude_moc.cpp"