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")
53 setViewTitle(_("Child Document"));
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(embedCB, SIGNAL(toggled(bool)), this, SLOT(change_adaptor()));
64 connect(typeCO, SIGNAL(activated(int)), this, SLOT(change_adaptor()));
65 connect(typeCO, SIGNAL(activated(int)), this, SLOT(typeChanged(int)));
66 connect(previewCB, SIGNAL(clicked()), this, SLOT(change_adaptor()));
67 connect(captionLE, SIGNAL(textChanged(const QString&)), this, SLOT(change_adaptor()));
68 connect(labelLE, SIGNAL(textChanged(const QString&)), this, SLOT(change_adaptor()));
69 connect(listingsED, SIGNAL(textChanged()), this, SLOT(change_adaptor()));
70 connect(listingsED, SIGNAL(textChanged()), this, SLOT(set_listings_msg()));
71 connect(bypassCB, SIGNAL(clicked()), this, SLOT(change_adaptor()));
72 connect(bypassCB, SIGNAL(clicked()), this, SLOT(set_listings_msg()));
74 setFocusProxy(filenameED);
76 bc().setPolicy(ButtonPolicy::OkApplyCancelReadOnlyPolicy);
78 bc().setCancel(closePB);
79 bc().addReadOnly(filenameED);
80 bc().addReadOnly(browsePB);
81 bc().addReadOnly(visiblespaceCB);
82 bc().addReadOnly(typeCO);
83 bc().addReadOnly(listingsED);
85 bc().addCheckedLineEdit(filenameED, filenameLA);
89 void GuiInclude::change_adaptor()
95 docstring GuiInclude::validate_listings_params()
97 // use a cache here to avoid repeated validation
98 // of the same parameters
99 static string param_cache = string();
100 static docstring msg_cache = docstring();
102 if (typeCO->currentIndex() != 3 || bypassCB->isChecked())
105 string params = fromqstr(listingsED->toPlainText());
106 if (params != param_cache) {
107 param_cache = params;
108 msg_cache = InsetListingsParams(params).validate();
114 void GuiInclude::set_listings_msg()
116 static bool isOK = true;
117 docstring msg = validate_listings_params();
122 listingsTB->setPlainText(
123 qt_("Input listing parameters on the right. Enter ? for a list of parameters."));
126 listingsTB->setPlainText(toqstr(msg));
131 void GuiInclude::closeEvent(QCloseEvent * e)
138 void GuiInclude::typeChanged(int v)
143 visiblespaceCB->setEnabled(false);
144 visiblespaceCB->setChecked(false);
145 previewCB->setEnabled(false);
146 previewCB->setChecked(false);
147 listingsGB->setEnabled(false);
151 visiblespaceCB->setEnabled(false);
152 visiblespaceCB->setChecked(false);
153 previewCB->setEnabled(true);
154 listingsGB->setEnabled(false);
158 visiblespaceCB->setEnabled(false);
159 visiblespaceCB->setChecked(false);
160 previewCB->setEnabled(false);
161 previewCB->setChecked(false);
162 listingsGB->setEnabled(true);
166 visiblespaceCB->setEnabled(true);
167 previewCB->setEnabled(false);
168 previewCB->setChecked(false);
169 listingsGB->setEnabled(false);
173 // http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg118471.html
174 //for the reason this is here.
175 okPB->setDefault(true);
179 void GuiInclude::updateContents()
181 filenameED->setText(toqstr(params_["filename"]));
182 embedCB->setCheckState(params_["embed"].empty() ? Qt::Unchecked : Qt::Checked);
184 visiblespaceCB->setChecked(false);
185 visiblespaceCB->setEnabled(false);
186 previewCB->setChecked(false);
187 previewCB->setEnabled(false);
188 listingsGB->setEnabled(false);
192 listingsTB->setPlainText(
193 qt_("Input listing parameters on the right. Enter ? for a list of parameters."));
195 string cmdname = params_.getCmdName();
196 if (cmdname != "include" &&
197 cmdname != "verbatiminput" &&
198 cmdname != "verbatiminput*" &&
199 cmdname != "lstinputlisting")
202 if (cmdname == "include") {
203 typeCO->setCurrentIndex(0);
205 } else if (cmdname == "input") {
206 typeCO->setCurrentIndex(1);
207 previewCB->setEnabled(true);
208 previewCB->setChecked(params_.preview());
210 } else if (cmdname == "verbatiminput*") {
211 typeCO->setCurrentIndex(2);
212 visiblespaceCB->setEnabled(true);
213 visiblespaceCB->setChecked(true);
215 } else if (cmdname == "verbatiminput") {
216 typeCO->setCurrentIndex(2);
217 visiblespaceCB->setEnabled(true);
219 } else if (cmdname == "lstinputlisting") {
220 typeCO->setCurrentIndex(3);
221 listingsGB->setEnabled(true);
222 listingsED->setEnabled(true);
223 InsetListingsParams par(to_utf8(params_["lstparams"]));
224 // extract caption and label and put them into their respective editboxes
225 vector<string> pars = getVectorFromString(par.separatedParams(), "\n");
226 for (vector<string>::iterator it = pars.begin();
227 it != pars.end(); ++it) {
228 if (prefixIs(*it, "caption=")) {
229 string cap = it->substr(8);
230 if (cap[0] == '{' && cap[cap.size() - 1] == '}') {
231 captionLE->setText(toqstr(cap.substr(1, cap.size() - 2)));
234 } else if (prefixIs(*it, "label=")) {
235 string lbl = it->substr(6);
236 if (lbl[0] == '{' && lbl[lbl.size()-1] == '}') {
237 labelLE->setText(toqstr(lbl.substr(1, lbl.size() - 2)));
242 // the rest is put to the extra edit box.
243 string extra = getStringFromVector(pars);
244 listingsED->setPlainText(toqstr(InsetListingsParams(extra).separatedParams()));
249 void GuiInclude::applyView()
251 params_["filename"] = from_utf8(internal_path(fromqstr(filenameED->text())));
252 params_["embed"] = embedCB->checkState() == Qt::Checked ? _("true") : _("false");
253 params_.preview(previewCB->isChecked());
255 int const item = typeCO->currentIndex();
257 params_.setCmdName("include");
258 } else if (item == 1) {
259 params_.setCmdName("input");
260 } else if (item == 3) {
261 params_.setCmdName("lstinputlisting");
262 // the parameter string should have passed validation
263 InsetListingsParams par(fromqstr(listingsED->toPlainText()));
264 string caption = fromqstr(captionLE->text());
265 string label = fromqstr(labelLE->text());
266 if (!caption.empty())
267 par.addParam("caption", "{" + caption + "}");
269 par.addParam("label", "{" + label + "}");
270 string const listparams = par.params();
271 params_["lstparams"] = from_ascii(listparams);
273 if (visiblespaceCB->isChecked())
274 params_.setCmdName("verbatiminput*");
276 params_.setCmdName("verbatiminput");
281 void GuiInclude::browse()
285 int const item = typeCO->currentIndex();
295 docstring const & name = browse(qstring_to_ucs4(filenameED->text()), type);
297 filenameED->setText(toqstr(name));
301 void GuiInclude::edit()
304 string const file = fromqstr(filenameED->text());
311 bool GuiInclude::isValid()
313 return !filenameED->text().isEmpty() && validate_listings_params().empty();
317 docstring GuiInclude::browse(docstring const & in_name, Type in_type) const
319 docstring const title = _("Select document to include");
321 // input TeX, verbatim, or LyX file ?
322 FileFilterList filters;
326 filters = FileFilterList(_("LaTeX/LyX Documents (*.tex *.lyx)"));
333 docstring const docpath = from_utf8(onlyPath(buffer().absFileName()));
335 return browseRelFile(in_name, docpath, title, filters, false,
336 _("Documents|#o#O"), from_utf8(lyxrc.document_path));
340 void GuiInclude::edit(string const & file)
342 string const ext = support::getExtension(file);
344 dispatch(FuncRequest(LFUN_BUFFER_CHILD_OPEN, file));
346 // tex file or other text file in verbatim mode
347 formats.edit(buffer(),
348 makeAbsPath(file, onlyPath(buffer().absFileName())),
353 Dialog * createGuiInclude(GuiView & lv) { return new GuiInclude(lv); }
356 } // namespace frontend
359 #include "GuiInclude_moc.cpp"