Scribus Developer Documentation - API
logo-pen

Scribus Developer Documentation - API

CustomFDialog Class Reference

A Scribus own file dialog. Used almost everywhere. You can see extension handling in e.g. bool SVGExportPlugin::run(QString filename). More...

#include <customfdialog.h>

Inheritance diagram for CustomFDialog:

Inheritance graph
[legend]
Collaboration diagram for CustomFDialog:

Collaboration graph
[legend]

List of all members.

Public Slots

void handleCompress ()
 Switch the filename extensions by compress checkbox state.

Public Member Functions

 CustomFDialog (QWidget *parent, QString wDir, QString caption="", QString filter="", int flags=fdExistingFiles)
 Create Scribus file dialog.
 ~CustomFDialog ()
void setExtension (QString e)
 Set the default extension of the resulting file name.
QString extension ()
 Get the file extension.
void setZipExtension (QString e)
 Set the "compress" extension of the resulting file name.
QString zipExtension ()
 Get the zipped file extension.
void setSelection (QString)
QString selectedFile ()
void addWidgets (QWidget *widgets)

Public Attributes

QCheckBox * SaveZip
QCheckBox * WithFonts
QCheckBox * WithProfiles
QFrame * Layout
QFrame * LayoutC
QComboBox * TxCodeM
QLabel * TxCodeT
ScFileWidgetfileDialog
FDialogPreviewpw
QCheckBox * showPreview
QPushButton * OKButton
QPushButton * CancelB

Protected Attributes

QVBoxLayout * vboxLayout
QVBoxLayout * vboxLayout1
QHBoxLayout * hboxLayout
QHBoxLayout * Layout1
QHBoxLayout * Layout1C
QString ext
 Property with default extension.
QString extZip
 Property with default compress extension.
int optionFlags
 Option flags given by user in ctore.
bool previewIsShown

Private Slots

void fileClicked (const QString &path)
 Go to the document home dir.
void togglePreview ()


Detailed Description

A Scribus own file dialog. Used almost everywhere. You can see extension handling in e.g. bool SVGExportPlugin::run(QString filename).

Definition at line 84 of file customfdialog.h.


Constructor & Destructor Documentation

CustomFDialog::CustomFDialog ( QWidget *  parent,
QString  wDir,
QString  caption = "",
QString  filter = "",
int  flags = fdExistingFiles 
)

Create Scribus file dialog.

Parameters:
parent a reference to the QWidget parent.
wDir starting working directory
caption text caption of the dialog window
filter a mask/filter. E.g.: *.txt
flags combination of fdFlags, default to fdExistingFiles

Definition at line 241 of file customfdialog.cpp.

References CancelB, extZip, fdCompressFile, fdDirectoriesOnly, fdExistingFiles, fdShowCodecs, fdShowPreview, fileClicked(), fileDialog, handleCompress(), hboxLayout, Layout, Layout1, Layout1C, LayoutC, loadIcon(), OKButton, previewIsShown, pw, SaveZip, showPreview, togglePreview(), tr(), CommonStrings::tr_Cancel, CommonStrings::tr_OK, TxCodeM, TxCodeT, vboxLayout, vboxLayout1, WithFonts, and WithProfiles.

CustomFDialog::~CustomFDialog (  ) 

Definition at line 433 of file customfdialog.cpp.


Member Function Documentation

void CustomFDialog::setExtension ( QString  e  ) 

Set the default extension of the resulting file name.

Parameters:
e string extension without any "."

Definition at line 462 of file customfdialog.cpp.

References ext.

Referenced by SVGExportPlugin::run().

QString CustomFDialog::extension (  ) 

Get the file extension.

Return values:
QString see setExtension(QString e)

Definition at line 467 of file customfdialog.cpp.

References ext.

void CustomFDialog::setZipExtension ( QString  e  ) 

Set the "compress" extension of the resulting file name.

Parameters:
e string extension without any "."

Definition at line 472 of file customfdialog.cpp.

References extZip.

Referenced by SVGExportPlugin::run().

QString CustomFDialog::zipExtension (  ) 

Get the zipped file extension.

Return values:
QString see setZipExtension(QString e)

Definition at line 477 of file customfdialog.cpp.

References extZip.

void CustomFDialog::setSelection ( QString  sel  ) 

QString CustomFDialog::selectedFile (  ) 

void CustomFDialog::addWidgets ( QWidget *  widgets  ) 

Definition at line 428 of file customfdialog.cpp.

References vboxLayout.

Referenced by ScGTFileDialog::customize().

void CustomFDialog::fileClicked ( const QString &  path  )  [private, slot]

Go to the document home dir.

Definition at line 401 of file customfdialog.cpp.

References FDialogPreview::GenPreview(), previewIsShown, and pw.

Referenced by CustomFDialog().

void CustomFDialog::togglePreview (  )  [private, slot]

Definition at line 407 of file customfdialog.cpp.

References previewIsShown, and pw.

Referenced by CustomFDialog().

void CustomFDialog::handleCompress (  )  [slot]

Switch the filename extensions by compress checkbox state.

Definition at line 437 of file customfdialog.cpp.

References ext, extZip, SaveZip, selectedFile(), and setSelection().

Referenced by CustomFDialog(), and SVGExportPlugin::run().


Member Data Documentation

Definition at line 113 of file customfdialog.h.

Referenced by CustomFDialog(), handleCompress(), and SVGExportPlugin::run().

Definition at line 114 of file customfdialog.h.

Referenced by CustomFDialog().

Definition at line 115 of file customfdialog.h.

Referenced by CustomFDialog().

Definition at line 116 of file customfdialog.h.

Referenced by CustomFDialog().

Definition at line 117 of file customfdialog.h.

Referenced by CustomFDialog().

Definition at line 119 of file customfdialog.h.

Referenced by CustomFDialog().

Definition at line 120 of file customfdialog.h.

Referenced by CustomFDialog(), selectedFile(), and setSelection().

Definition at line 121 of file customfdialog.h.

Referenced by CustomFDialog(), fileClicked(), setSelection(), and togglePreview().

Definition at line 122 of file customfdialog.h.

Referenced by CustomFDialog().

Definition at line 123 of file customfdialog.h.

Referenced by CustomFDialog().

QPushButton* CustomFDialog::CancelB

Definition at line 124 of file customfdialog.h.

Referenced by CustomFDialog().

QVBoxLayout* CustomFDialog::vboxLayout [protected]

Definition at line 136 of file customfdialog.h.

Referenced by addWidgets(), and CustomFDialog().

QVBoxLayout* CustomFDialog::vboxLayout1 [protected]

Definition at line 137 of file customfdialog.h.

Referenced by CustomFDialog().

QHBoxLayout* CustomFDialog::hboxLayout [protected]

Definition at line 138 of file customfdialog.h.

Referenced by CustomFDialog().

QHBoxLayout* CustomFDialog::Layout1 [protected]

Definition at line 139 of file customfdialog.h.

Referenced by CustomFDialog().

QHBoxLayout* CustomFDialog::Layout1C [protected]

Definition at line 140 of file customfdialog.h.

Referenced by CustomFDialog().

QString CustomFDialog::ext [protected]

Property with default extension.

Definition at line 142 of file customfdialog.h.

Referenced by extension(), handleCompress(), and setExtension().

QString CustomFDialog::extZip [protected]

Property with default compress extension.

Definition at line 144 of file customfdialog.h.

Referenced by CustomFDialog(), handleCompress(), setZipExtension(), and zipExtension().

int CustomFDialog::optionFlags [protected]

Option flags given by user in ctore.

Definition at line 146 of file customfdialog.h.

Definition at line 147 of file customfdialog.h.

Referenced by CustomFDialog(), fileClicked(), setSelection(), and togglePreview().


The documentation for this class was generated from the following files:
Created with personalized Doxygen. This is documentation for GPL software Scribus - Open Source Desktop Publishing.