Kross::FormModule Class Reference
The FormModule provides access to UI functionality like dialogs or widgets.
More...
#include <form.h>
List of all members.
Public Slots |
QWidget * | activeModalWidget () |
QWidget * | activeWindow () |
QAction * | createAction (QObject *parent) |
QWidget * | createAssistant (const QString &caption) |
QWidget * | createDialog (const QString &caption) |
QWidget * | createFileWidget (QWidget *parent, const QString &startDirOrVariable=QString()) |
QObject * | createLayout (QWidget *parent, const QString &layout) |
QWidget * | createListView (QWidget *parent) |
QWidget * | createWidget (QWidget *parent, const QString &className, const QString &name=QString()) |
QWidget * | createWidget (const QString &className) |
QWidget * | createWidgetFromUI (QWidget *parent, const QString &xml) |
QWidget * | createWidgetFromUIFile (QWidget *parent, const QString &filename) |
QObject * | loadPart (QWidget *parent, const QString &name, const QUrl &url=QUrl()) |
QString | showMessageBox (const QString &dialogtype, const QString &caption, const QString &message, const QString &details=QString()) |
QWidget * | showProgressDialog (const QString &caption, const QString &labelText) |
QString | tr (const QString &str, const QString &comment) |
QString | tr (const QString &str) |
Public Member Functions |
| FormModule () |
virtual | ~FormModule () |
Detailed Description
The FormModule provides access to UI functionality like dialogs or widgets.
Example (in Python) :
import Kross
forms = Kross.module("forms")
dialog = forms.createDialog("My Dialog")
dialog.setButtons("Ok|Cancel")
page = dialog.addPage("Welcome","Welcome Page","document-open")
label = forms.createWidget(page,"QLabel")
label.text = "Hello World Label"
if dialog.exec_loop():
forms.showMessageBox("Information", "Okay...", "The Ok-button was pressed")
Definition at line 525 of file form.h.
Constructor & Destructor Documentation
FormModule::FormModule |
( |
|
) |
[explicit] |
FormModule::~FormModule |
( |
|
) |
[virtual] |
Member Function Documentation
QWidget * FormModule::activeModalWidget |
( |
|
) |
[slot] |
- Returns:
- the active modal widget. Modal widgets are special top-level widgets which are subclasses of QDialog and are modal.
Definition at line 636 of file form.cpp.
QWidget * FormModule::activeWindow |
( |
|
) |
[slot] |
- Returns:
- the application top-level window that has the keyboard input focus, or NULL if no application window has the focus.
Definition at line 641 of file form.cpp.
Create and return a new QAction instance.
- Parameters:
-
- Returns:
- the new QAction instance or NULL.
Definition at line 803 of file form.cpp.
QWidget * FormModule::createAssistant |
( |
const QString & |
caption |
) |
[slot] |
Create and return a new FormAssistant instance.
- Parameters:
-
| caption | The displayed caption of the dialog. |
Definition at line 690 of file form.cpp.
Create and return a new FormDialog instance.
- Parameters:
-
| caption | The displayed caption of the dialog. |
Definition at line 685 of file form.cpp.
Create and return a new QWidget instance.
- Parameters:
-
| parent | the parent QWidget the new QWidget is a child of. |
| layout | the layout style the widget has. This could be one of the following strings;
- QVBoxLayout
- QHBoxLayout
- QStackedLayout
|
- Returns:
- the new QLayout instance or NULL.
Definition at line 695 of file form.cpp.
Create and return a new QWidget instance.
- Parameters:
-
| parent | the parent QWidget the new QWidget is a child of. |
| className | the name of the class that should be created and returned. For example "QLabel" or "QForm". |
| name | the objectName the new widget has. |
- Returns:
- the new QWidget instance or NULL.
Definition at line 716 of file form.cpp.
QWidget * FormModule::createWidget |
( |
const QString & |
className |
) |
[slot] |
Create and return a new QWidget instance.
- Parameters:
-
| parent | the parent QWidget the new QWidget is a child of. |
| className | the name of the class that should be created and returned. For example "QLabel" or "QForm". |
| name | the objectName the new widget has. |
- Returns:
- the new QWidget instance or NULL.
Definition at line 709 of file form.cpp.
Create and return a new QWidget instance.
- Parameters:
-
| parent | the new QWidget is a child of parent. |
| xml | the UI XML string used to construct the new widget. |
- Returns:
- the new QWidget instance or NULL.
Definition at line 735 of file form.cpp.
Create and return a new QWidget instance.
- Parameters:
-
| parent | the parent QWidget the new QWidget is a child of. |
| filename | the full filename of the UI file which is readed and its UI XML content is used to construct the new widget. |
Definition at line 771 of file form.cpp.
Load and return a KPart component.
- Parameters:
-
| parent | The parent QWidget the KPart's widget will be child of. |
| name | The name of the KPart library like e.g. "libkhtmlpart". |
| url | Optional Url that should be opened on load. |
Definition at line 808 of file form.cpp.
Show a messagebox.
- Parameters:
-
| dialogtype | The type of the dialog which could be one of the following;
- Sorry
- Error
- Information
- QuestionYesNo
- WarningYesNo
- WarningContinueCancel
- WarningYesNoCancel
- QuestionYesNoCancel
|
| caption | The caption the messagedialog displays. |
| message | The message that is displayed in the messagedialog. |
| details | The optional details |
- Returns:
- The buttoncode which chould be one of the following;
- Ok
- Cancel
- Yes
- No
- Continue
Definition at line 646 of file form.cpp.
Show a progressdialog to provide visible feedback on the progress of a slow operation.
- Parameters:
-
| caption | The caption the progressdialog displays. |
| labelText | The displayed label. |
- Returns:
- The QProgressDialog widget instance.
Definition at line 680 of file form.cpp.
- Returns:
- i18n'ed version of the string, differentiated by the comment text (like '@title:window')
Definition at line 730 of file form.cpp.
- Returns:
- i18n'ed version of the string
Definition at line 726 of file form.cpp.
The documentation for this class was generated from the following files: