You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
koffice/kexi/plugins/importexport/csv/kexicsvexportwizard.cpp

432 lines
15 KiB

/* This file is part of the KDE project
Copyright (C) 2005,2006 Jaroslaw Staniek <js@iidea.pl>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#include "kexicsvexportwizard.h"
#include "kexicsvwidgets.h"
#include <main/startup/KexiStartupFileDialog.h>
#include <kexidb/cursor.h>
#include <kexidb/utils.h>
#include <core/keximainwindow.h>
#include <core/kexiproject.h>
#include <core/kexipartinfo.h>
#include <core/kexipartmanager.h>
#include <core/kexiguimsghandler.h>
#include <kexiutils/utils.h>
#include <widget/kexicharencodingcombobox.h>
#include <tqcheckbox.h>
#include <tqgroupbox.h>
#include <tqclipboard.h>
#include <tdeapplication.h>
#include <tdelocale.h>
#include <kiconloader.h>
#include <kactivelabel.h>
#include <kpushbutton.h>
#include <tdeapplication.h>
#include <kdebug.h>
#include <ksavefile.h>
KexiCSVExportWizard::KexiCSVExportWizard( const KexiCSVExport::Options& options,
KexiMainWindow* mainWin, TQWidget * parent, const char * name )
: KWizard(parent, name)
, m_options(options)
// , m_mode(mode)
// , m_itemId(itemId)
, m_mainWin(mainWin)
, m_fileSavePage(0)
, m_defaultsBtn(0)
, m_rowCount(-1)
, m_rowCountDetermined(false)
, m_cancelled(false)
{
if (m_options.mode==KexiCSVExport::Clipboard) {
finishButton()->setText(i18n("Copy"));
backButton()->hide();
}
else {
finishButton()->setText(i18n("Export"));
}
helpButton()->hide();
TQString infoLblFromText;
KexiGUIMessageHandler msgh(this);
m_tableOrQuery = new KexiDB::TableOrQuerySchema(
m_mainWin->project()->dbConnection(), m_options.itemId);
if (m_tableOrQuery->table()) {
if (m_options.mode==KexiCSVExport::Clipboard) {
setCaption(i18n("Copy Data From Table to Clipboard"));
infoLblFromText = i18n("Copying data from table:");
}
else {
setCaption(i18n("Export Data From Table to CSV File"));
infoLblFromText = i18n("Exporting data from table:");
}
}
else if (m_tableOrQuery->query()) {
if (m_options.mode==KexiCSVExport::Clipboard) {
setCaption(i18n("Copy Data From Query to Clipboard"));
infoLblFromText = i18n("Copying data from table:");
}
else {
setCaption(i18n("Export Data From Query to CSV File"));
infoLblFromText = i18n("Exporting data from query:");
}
}
else {
msgh.showErrorMessage(m_mainWin->project()->dbConnection(),
i18n("Could not open data for exporting."));
m_cancelled = true;
return;
}
// OK, source data found.
// Setup pages
// 1. File Save Page
if (m_options.mode==KexiCSVExport::File) {
m_fileSavePage = new KexiStartupFileDialog(
":CSVImportExport", //startDir
KexiStartupFileDialog::Custom | KexiStartupFileDialog::SavingFileBasedDB,
this, "m_fileSavePage");
m_fileSavePage->setMinimumHeight(kapp->desktop()->height()/2);
m_fileSavePage->setAdditionalFilters( csvMimeTypes() );
m_fileSavePage->setDefaultExtension("csv");
m_fileSavePage->setLocationText( KexiUtils::stringToFileName(m_tableOrQuery->captionOrName()) );
connect(m_fileSavePage, TQT_SIGNAL(rejected()), this, TQT_SLOT(reject()));
addPage(m_fileSavePage, i18n("Enter Name of File You Want to Save Data To"));
}
// 2. Export options
m_exportOptionsPage = new TQWidget(this, "m_exportOptionsPage");
TQGridLayout *exportOptionsLyr = new TQGridLayout( m_exportOptionsPage, 6, 3,
KDialogBase::marginHint(), KDialogBase::spacingHint(), "exportOptionsLyr");
m_infoLblFrom = new KexiCSVInfoLabel( infoLblFromText, m_exportOptionsPage );
KexiPart::Info *partInfo = Kexi::partManager().infoForMimeType(
m_tableOrQuery->table() ? "kexi/table" : "kexi/query");
if (partInfo)
m_infoLblFrom->setIcon(partInfo->itemIcon());
m_infoLblFrom->separator()->hide();
exportOptionsLyr->addMultiCellWidget(m_infoLblFrom, 0, 0, 0, 2);
m_infoLblTo = new KexiCSVInfoLabel(
(m_options.mode==KexiCSVExport::File) ? i18n("To CSV file:") : i18n("To clipboard:"),
m_exportOptionsPage
);
if (m_options.mode==KexiCSVExport::Clipboard)
m_infoLblTo->setIcon("edit-paste");
exportOptionsLyr->addMultiCellWidget(m_infoLblTo, 1, 1, 0, 2);
m_showOptionsButton = new KPushButton(KGuiItem(i18n("Show Options >>"), "configure"),
m_exportOptionsPage);
connect(m_showOptionsButton, TQT_SIGNAL(clicked()), this, TQT_SLOT(slotShowOptionsButtonClicked()));
exportOptionsLyr->addMultiCellWidget(m_showOptionsButton, 2, 2, 0, 0);
m_showOptionsButton->setSizePolicy(TQSizePolicy::Fixed, TQSizePolicy::Fixed);
// -<options section>
m_exportOptionsSection = new TQGroupBox(1,Qt::Vertical, i18n("Options"), m_exportOptionsPage,
"m_exportOptionsSection");
m_exportOptionsSection->setSizePolicy(TQSizePolicy::Fixed, TQSizePolicy::Fixed);
exportOptionsLyr->addMultiCellWidget(m_exportOptionsSection, 3, 3, 0, 1);
TQWidget *exportOptionsSectionWidget
= new TQWidget(m_exportOptionsSection, "exportOptionsSectionWidget");
TQGridLayout *exportOptionsSectionLyr = new TQGridLayout( exportOptionsSectionWidget, 5, 2,
0, KDialogBase::spacingHint(), "exportOptionsLyr");
// -delimiter
m_delimiterWidget = new KexiCSVDelimiterWidget(false, //!lineEditOnBottom
exportOptionsSectionWidget);
m_delimiterWidget->setDelimiter(defaultDelimiter());
exportOptionsSectionLyr->addWidget( m_delimiterWidget, 0, 1 );
TQLabel *delimiterLabel = new TQLabel(m_delimiterWidget, i18n("Delimiter:"), exportOptionsSectionWidget);
exportOptionsSectionLyr->addWidget( delimiterLabel, 0, 0 );
// -text quote
TQWidget *textQuoteWidget = new TQWidget(exportOptionsSectionWidget);
TQHBoxLayout *textQuoteLyr = new TQHBoxLayout(textQuoteWidget);
exportOptionsSectionLyr->addWidget(textQuoteWidget, 1, 1);
m_textQuote = new KexiCSVTextQuoteComboBox( textQuoteWidget );
m_textQuote->setTextQuote(defaultTextQuote());
textQuoteLyr->addWidget( m_textQuote );
textQuoteLyr->addStretch(0);
TQLabel *textQuoteLabel = new TQLabel(m_textQuote, i18n("Text quote:"), exportOptionsSectionWidget);
exportOptionsSectionLyr->addWidget( textQuoteLabel, 1, 0 );
// - character encoding
m_characterEncodingCombo = new KexiCharacterEncodingComboBox( exportOptionsSectionWidget );
m_characterEncodingCombo->setSizePolicy(TQSizePolicy::Fixed, TQSizePolicy::Fixed);
exportOptionsSectionLyr->addWidget( m_characterEncodingCombo, 2, 1 );
TQLabel *characterEncodingLabel = new TQLabel(m_characterEncodingCombo, i18n("Text encoding:"),
exportOptionsSectionWidget);
exportOptionsSectionLyr->addWidget( characterEncodingLabel, 2, 0 );
// - checkboxes
m_addColumnNamesCheckBox = new TQCheckBox(i18n("Add column names as the first row"),
exportOptionsSectionWidget);
m_addColumnNamesCheckBox->setChecked(true);
exportOptionsSectionLyr->addWidget( m_addColumnNamesCheckBox, 3, 1 );
//! @todo 1.1: for copying use "Always use above options for copying" string
m_alwaysUseCheckBox = new TQCheckBox(i18n("Always use above options for exporting"),
m_exportOptionsPage);
exportOptionsLyr->addMultiCellWidget(m_alwaysUseCheckBox, 4, 4, 0, 1);
// exportOptionsSectionLyr->addWidget( m_alwaysUseCheckBox, 4, 1 );
m_exportOptionsSection->hide();
m_alwaysUseCheckBox->hide();
// -</options section>
// exportOptionsLyr->setColStretch(3, 1);
exportOptionsLyr->addMultiCell(
new TQSpacerItem( 0, 0, TQSizePolicy::Preferred, TQSizePolicy::MinimumExpanding), 5, 5, 0, 1 );
// addPage(m_exportOptionsPage, i18n("Set Export Options"));
addPage(m_exportOptionsPage, m_options.mode==KexiCSVExport::Clipboard ? i18n("Copying") : i18n("Exporting"));
setFinishEnabled(m_exportOptionsPage, true);
// load settings
kapp->config()->setGroup("ImportExport");
if (m_options.mode!=KexiCSVExport::Clipboard && readBoolEntry("ShowOptionsInCSVExportDialog", false)) {
show();
slotShowOptionsButtonClicked();
}
if (readBoolEntry("StoreOptionsForCSVExportDialog", false)) {
// load defaults:
m_alwaysUseCheckBox->setChecked(true);
TQString s = readEntry("DefaultDelimiterForExportingCSVFiles", defaultDelimiter());
if (!s.isEmpty())
m_delimiterWidget->setDelimiter(s);
s = readEntry("DefaultTextQuoteForExportingCSVFiles", defaultTextQuote());
m_textQuote->setTextQuote(s); //will be invaliudated here, so not a problem
s = readEntry("DefaultEncodingForExportingCSVFiles");
if (!s.isEmpty())
m_characterEncodingCombo->setSelectedEncoding(s);
m_addColumnNamesCheckBox->setChecked(
readBoolEntry("AddColumnNamesForExportingCSVFiles", true) );
}
updateGeometry();
// -keep widths equal on page #2:
int width = TQMAX( m_infoLblFrom->leftLabel()->sizeHint().width(),
m_infoLblTo->leftLabel()->sizeHint().width());
m_infoLblFrom->leftLabel()->setFixedWidth(width);
m_infoLblTo->leftLabel()->setFixedWidth(width);
}
KexiCSVExportWizard::~KexiCSVExportWizard()
{
delete m_tableOrQuery;
}
bool KexiCSVExportWizard::cancelled() const
{
return m_cancelled;
}
void KexiCSVExportWizard::showPage ( TQWidget * page )
{
if (page == m_fileSavePage) {
m_fileSavePage->setFocus();
}
else if (page==m_exportOptionsPage) {
if (m_options.mode==KexiCSVExport::File)
m_infoLblTo->setFileName( m_fileSavePage->currentFileName() );
TQString text = m_tableOrQuery->captionOrName();
if (!m_rowCountDetermined) {
//do this costly operation only once
m_rowCount = KexiDB::rowCount(*m_tableOrQuery);
m_rowCountDetermined = true;
}
int columns = KexiDB::fieldCount(*m_tableOrQuery);
text += "\n";
if (m_rowCount>0)
text += i18n("(rows: %1, columns: %2)").arg(m_rowCount).arg(columns);
else
text += i18n("(columns: %1)").arg(columns);
m_infoLblFrom->setLabelText(text);
TQFontMetrics fm(m_infoLblFrom->fileNameLabel()->font());
m_infoLblFrom->fileNameLabel()->setFixedHeight( fm.height() * 2 + fm.lineSpacing() );
if (m_defaultsBtn)
m_defaultsBtn->show();
}
if (page!=m_exportOptionsPage) {
if (m_defaultsBtn)
m_defaultsBtn->hide();
}
KWizard::showPage(page);
}
void KexiCSVExportWizard::next()
{
if (currentPage() == m_fileSavePage) {
if (!m_fileSavePage->checkFileName())
return;
KWizard::next();
finishButton()->setFocus();
return;
}
KWizard::next();
}
void KexiCSVExportWizard::done(int result)
{
if (TQDialog::Accepted == result) {
if (m_fileSavePage)
m_options.fileName = m_fileSavePage->currentFileName();
m_options.delimiter = m_delimiterWidget->delimiter();
m_options.textQuote = m_textQuote->textQuote();
m_options.addColumnNames = m_addColumnNamesCheckBox->isChecked();
if (!KexiCSVExport::exportData(*m_tableOrQuery, m_options))
return;
}
else if (TQDialog::Rejected == result) {
//nothing to do
}
//store options
kapp->config()->setGroup("ImportExport");
if (m_options.mode!=KexiCSVExport::Clipboard)
writeEntry("ShowOptionsInCSVExportDialog", m_exportOptionsSection->isVisible());
const bool store = m_alwaysUseCheckBox->isChecked();
writeEntry("StoreOptionsForCSVExportDialog", store);
// only save if an option differs from default
if (store && m_delimiterWidget->delimiter()!=defaultDelimiter())
writeEntry("DefaultDelimiterForExportingCSVFiles", m_delimiterWidget->delimiter());
else
deleteEntry("DefaultDelimiterForExportingCSVFiles");
if (store && m_textQuote->textQuote()!=defaultTextQuote())
writeEntry("DefaultTextQuoteForExportingCSVFiles", m_textQuote->textQuote());
else
deleteEntry("DefaultTextQuoteForExportingCSVFiles");
if (store && !m_characterEncodingCombo->defaultEncodingSelected())
writeEntry("DefaultEncodingForExportingCSVFiles", m_characterEncodingCombo->selectedEncoding());
else
deleteEntry("DefaultEncodingForExportingCSVFiles");
if (store && !m_addColumnNamesCheckBox->isChecked())
writeEntry("AddColumnNamesForExportingCSVFiles", m_addColumnNamesCheckBox->isChecked());
else
deleteEntry("AddColumnNamesForExportingCSVFiles");
KWizard::done(result);
}
void KexiCSVExportWizard::slotShowOptionsButtonClicked()
{
if (m_exportOptionsSection->isVisible()) {
m_showOptionsButton->setText(i18n("Show Options >>"));
m_exportOptionsSection->hide();
m_alwaysUseCheckBox->hide();
if (m_defaultsBtn)
m_defaultsBtn->hide();
}
else {
m_showOptionsButton->setText(i18n("Hide Options <<"));
m_exportOptionsSection->show();
m_alwaysUseCheckBox->show();
if (m_defaultsBtn)
m_defaultsBtn->show();
}
}
void KexiCSVExportWizard::layOutButtonRow( TQHBoxLayout * layout )
{
TQWizard::layOutButtonRow( layout );
//find the last sublayout
TQLayout *l = 0;
for (TQLayoutIterator lit( layout->iterator() ); lit.current(); ++lit)
l = lit.current()->layout();
if (dynamic_cast<TQBoxLayout*>(l)) {
if (!m_defaultsBtn) {
m_defaultsBtn = new KPushButton(i18n("Defaults"), this);
TQWidget::setTabOrder(backButton(), m_defaultsBtn);
connect(m_defaultsBtn, TQT_SIGNAL(clicked()), this, TQT_SLOT(slotDefaultsButtonClicked()));
}
if (!m_exportOptionsSection->isVisible())
m_defaultsBtn->hide();
dynamic_cast<TQBoxLayout*>(l)->insertWidget(0, m_defaultsBtn);
}
}
void KexiCSVExportWizard::slotDefaultsButtonClicked()
{
m_delimiterWidget->setDelimiter(defaultDelimiter());
m_textQuote->setTextQuote(defaultTextQuote());
m_addColumnNamesCheckBox->setChecked(true);
m_characterEncodingCombo->selectDefaultEncoding();
}
static TQString convertKey(const char *key, KexiCSVExport::Mode mode)
{
TQString _key(TQString::fromLatin1(key));
if (mode == KexiCSVExport::Clipboard) {
_key.replace("Exporting", "Copying");
_key.replace("Export", "Copy");
_key.replace("CSVFiles", "CSVToClipboard");
}
return _key;
}
bool KexiCSVExportWizard::readBoolEntry(const char *key, bool defaultValue)
{
return kapp->config()->readBoolEntry(convertKey(key, m_options.mode), defaultValue);
}
TQString KexiCSVExportWizard::readEntry(const char *key, const TQString& defaultValue)
{
return kapp->config()->readEntry(convertKey(key, m_options.mode), defaultValue);
}
void KexiCSVExportWizard::writeEntry(const char *key, const TQString& value)
{
kapp->config()->writeEntry(convertKey(key, m_options.mode), value);
}
void KexiCSVExportWizard::writeEntry(const char *key, bool value)
{
kapp->config()->writeEntry(convertKey(key, m_options.mode), value);
}
void KexiCSVExportWizard::deleteEntry(const char *key)
{
kapp->config()->deleteEntry(convertKey(key, m_options.mode));
}
TQString KexiCSVExportWizard::defaultDelimiter() const
{
if (m_options.mode==KexiCSVExport::Clipboard) {
if (!m_options.forceDelimiter.isEmpty())
return m_options.forceDelimiter;
else
return KEXICSV_DEFAULT_CLIPBOARD_DELIMITER;
}
return KEXICSV_DEFAULT_FILE_DELIMITER;
}
TQString KexiCSVExportWizard::defaultTextQuote() const
{
if (m_options.mode==KexiCSVExport::Clipboard)
return KEXICSV_DEFAULT_CLIPBOARD_TEXT_QUOTE;
return KEXICSV_DEFAULT_FILE_TEXT_QUOTE;
}
#include "kexicsvexportwizard.moc"