.TH "KStdGuiItem" kde3 "11 Jun 2005" "Version Version 3.4.1" "kdeui Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KStdGuiItem \- Provides a set of standardized KGuiItems.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <kstdguiitem.h>\fP
.PP
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum \fBBidiMode\fP { \fBUseRTL\fP =  0, \fBIgnoreRTL\fP }"
.br
.ti -1c
.RI "enum \fBStdItem\fP { \fBOk\fP = 1, \fBCancel\fP, \fBYes\fP, \fBNo\fP, \fBDiscard\fP, \fBSave\fP, \fBDontSave\fP, \fBSaveAs\fP, \fBApply\fP, \fBClear\fP, \fBHelp\fP, \fBDefaults\fP, \fBClose\fP, \fBBack\fP, \fBForward\fP, \fBPrint\fP, \fBContinue\fP, \fBOpen\fP, \fBQuit\fP, \fBAdminMode\fP, \fBReset\fP, \fBDelete\fP, \fBInsert\fP, \fBConfigure\fP, \fBFind\fP, \fBStop\fP, \fBAdd\fP, \fBRemove\fP, \fBTest\fP, \fBProperties\fP }"
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "static \fBKGuiItem\fP \fBguiItem\fP (\fBStdItem\fP ui_enum)"
.br
.ti -1c
.RI "static \fBQString\fP \fBstdItem\fP (\fBStdItem\fP ui_enum)"
.br
.ti -1c
.RI "static \fBKGuiItem\fP \fBok\fP ()"
.br
.ti -1c
.RI "static \fBKGuiItem\fP \fBcancel\fP ()"
.br
.ti -1c
.RI "static \fBKGuiItem\fP \fByes\fP ()"
.br
.ti -1c
.RI "static \fBKGuiItem\fP \fBno\fP ()"
.br
.ti -1c
.RI "static \fBKGuiItem\fP \fBinsert\fP ()"
.br
.ti -1c
.RI "static \fBKGuiItem\fP \fBdiscard\fP ()"
.br
.ti -1c
.RI "static \fBKGuiItem\fP \fBsave\fP ()"
.br
.ti -1c
.RI "static \fBKGuiItem\fP \fBhelp\fP ()"
.br
.ti -1c
.RI "static \fBKGuiItem\fP \fBdontSave\fP ()"
.br
.ti -1c
.RI "static \fBKGuiItem\fP \fBsaveAs\fP ()"
.br
.ti -1c
.RI "static \fBKGuiItem\fP \fBapply\fP ()"
.br
.ti -1c
.RI "static \fBKGuiItem\fP \fBclear\fP ()"
.br
.ti -1c
.RI "static \fBKGuiItem\fP \fBdefaults\fP ()"
.br
.ti -1c
.RI "static \fBKGuiItem\fP \fBclose\fP ()"
.br
.ti -1c
.RI "static \fBKGuiItem\fP \fBprint\fP ()"
.br
.ti -1c
.RI "static \fBKGuiItem\fP \fBproperties\fP ()"
.br
.ti -1c
.RI "static \fBKGuiItem\fP \fBreset\fP ()"
.br
.ti -1c
.RI "static \fBKGuiItem\fP \fBadminMode\fP ()"
.br
.ti -1c
.RI "static \fBKGuiItem\fP \fBcont\fP ()"
.br
.ti -1c
.RI "static \fBKGuiItem\fP \fBdel\fP ()"
.br
.ti -1c
.RI "static \fBKGuiItem\fP \fBopen\fP ()"
.br
.ti -1c
.RI "static \fBKGuiItem\fP \fBback\fP (\fBBidiMode\fP useBidi=IgnoreRTL)"
.br
.ti -1c
.RI "static \fBKGuiItem\fP \fBforward\fP (\fBBidiMode\fP useBidi=IgnoreRTL)"
.br
.ti -1c
.RI "static \fBKGuiItem\fP \fBconfigure\fP ()"
.br
.ti -1c
.RI "static \fBQPair\fP< \fBKGuiItem\fP, \fBKGuiItem\fP > \fBbackAndForward\fP ()"
.br
.ti -1c
.RI "static \fBKGuiItem\fP \fBquit\fP ()"
.br
.ti -1c
.RI "static \fBKGuiItem\fP \fBfind\fP ()"
.br
.ti -1c
.RI "static \fBKGuiItem\fP \fBstop\fP ()"
.br
.ti -1c
.RI "static \fBKGuiItem\fP \fBadd\fP ()"
.br
.ti -1c
.RI "static \fBKGuiItem\fP \fBremove\fP ()"
.br
.ti -1c
.RI "static \fBKGuiItem\fP \fBtest\fP ()"
.br
.in -1c
.SH "Detailed Description"
.PP 
Provides a set of standardized KGuiItems. 

The various static methods returns standardized \fBKGuiItem\fP's conforming to the \fBKDE\fP UI Standards. Use them instead of creating your own.
.PP
\fBAuthor:\fP
.RS 4
Holger Freyther <freyther@kde.org> 
.RE
.PP

.PP
Definition at line 37 of file kstdguiitem.h.
.SH "Member Enumeration Documentation"
.PP 
.SS "enum \fBKStdGuiItem::BidiMode\fP"
.PP
The back and forward items by default use the RTL settings for Hebrew and Arab countries. 
.PP
If you want those actions to ignore the RTL value and force 'Western' behavior instead, use the IgnoreRTL value instead. 
.PP
Definition at line 45 of file kstdguiitem.h.
.SS "enum \fBKStdGuiItem::StdItem\fP"
.PP
\fBEnumeration values: \fP
.in +1c
.TP
\fB\fIConfigure \fP\fP
\fBSince:\fP
.RS 4
3.4 
.RE
.PP

.TP
\fB\fIFind \fP\fP
\fBSince:\fP
.RS 4
3.4 
.RE
.PP

.TP
\fB\fIStop \fP\fP
\fBSince:\fP
.RS 4
3.4 
.RE
.PP

.TP
\fB\fIAdd \fP\fP
\fBSince:\fP
.RS 4
3.4 
.RE
.PP

.TP
\fB\fIRemove \fP\fP
\fBSince:\fP
.RS 4
3.4 
.RE
.PP

.TP
\fB\fITest \fP\fP
\fBSince:\fP
.RS 4
3.4 
.RE
.PP

.TP
\fB\fIProperties \fP\fP
\fBSince:\fP
.RS 4
3.4 
.RE
.PP

.PP
Definition at line 47 of file kstdguiitem.h.
.SH "Member Function Documentation"
.PP 
.SS "\fBKGuiItem\fP KStdGuiItem::properties ()\fC [static]\fP"
.PP
\fBSince:\fP
.RS 4
3.4 
.RE
.PP

.PP
Definition at line 275 of file kstdguiitem.cpp.
.SS "\fBKGuiItem\fP KStdGuiItem::adminMode ()\fC [static]\fP"
.PP
Returns a \fBKGuiItem\fP suiting for cases where code or functionality runs under root privileges. 
.PP
Used in conjunction with \fBKConfig\fP Modules. 
.PP
Definition at line 149 of file kstdguiitem.cpp.
.SS "\fBKGuiItem\fP KStdGuiItem::cont ()\fC [static]\fP"
.PP
Returns a 'continue' item. 
.PP
The short name is due to 'continue' being a reserved word in the C++ language. 
.PP
Definition at line 210 of file kstdguiitem.cpp.
.SS "\fBKGuiItem\fP KStdGuiItem::del ()\fC [static]\fP"
.PP
Returns a 'delete' item. 
.PP
The short name is due to 'delete' being a reserved word in the C++ language. 
.PP
\fBSince:\fP
.RS 4
3.3 
.RE
.PP

.PP
Definition at line 216 of file kstdguiitem.cpp.
.SS "\fBKGuiItem\fP KStdGuiItem::back (\fBBidiMode\fP useBidi = \fCIgnoreRTL\fP)\fC [static]\fP"
.PP
Return a GUI item for a 'back' action, like Konqueror's back button. 
.PP
This GUI item can optionally honor the user's setting for BiDi, so the icon for right-to-left languages (Hebrew and Arab) has the arrow pointing in the opposite direction. By default the arrow points in the Western 'back' direction (i.e. to the left). This is because usually you only want the Bidi aware GUI item if you also want the 'forward' item. Those two are available in the separate \fBbackAndForward()\fP method. 
.PP
Definition at line 182 of file kstdguiitem.cpp.
.PP
References QApplication::reverseLayout().
.PP
Referenced by backAndForward(), and KWizard::KWizard().
.SS "\fBKGuiItem\fP KStdGuiItem::forward (\fBBidiMode\fP useBidi = \fCIgnoreRTL\fP)\fC [static]\fP"
.PP
Return a GUI item for a 'forward' action, like Konqueror's forward button. 
.PP
This GUI item can optionally honor the user's setting for BiDi, so the icon for right-to-left languages (Hebrew and Arab) has the arrow pointing in the opposite direction. By default the arrow points in the Western 'forward' direction (i.e. to the right). This is because usually you only want the Bidi aware GUI item if you also want the 'back' item. Those two are available in the separate \fBbackAndForward()\fP method. 
.PP
Definition at line 190 of file kstdguiitem.cpp.
.PP
References QApplication::reverseLayout().
.PP
Referenced by backAndForward(), and KWizard::KWizard().
.SS "\fBKGuiItem\fP KStdGuiItem::configure ()\fC [static]\fP"
.PP
Returns a 'configure' item. 
.PP
\fBSince:\fP
.RS 4
3.4 
.RE
.PP

.PP
Definition at line 245 of file kstdguiitem.cpp.
.SS "\fBQPair\fP< \fBKGuiItem\fP, \fBKGuiItem\fP > KStdGuiItem::backAndForward ()\fC [static]\fP"
.PP
Return both a back and a forward item. 
.PP
This function always returns items that are aware of the Right-to-Left setting for Arab and Hebrew locales. If you have a reason for wanting the 'Western' back/forward buttons, please use the \fBback()\fP and \fBforward()\fP items instead. 
.PP
Definition at line 198 of file kstdguiitem.cpp.
.PP
References back(), and forward().
.SS "\fBKGuiItem\fP KStdGuiItem::find ()\fC [static]\fP"
.PP
Returns a 'find' item. 
.PP
\fBSince:\fP
.RS 4
3.4 
.RE
.PP

.PP
Definition at line 250 of file kstdguiitem.cpp.
.SS "\fBKGuiItem\fP KStdGuiItem::stop ()\fC [static]\fP"
.PP
Returns a 'stop' item. 
.PP
\fBSince:\fP
.RS 4
3.4 
.RE
.PP

.PP
Definition at line 255 of file kstdguiitem.cpp.
.SS "\fBKGuiItem\fP KStdGuiItem::add ()\fC [static]\fP"
.PP
Returns a 'add' item. 
.PP
\fBSince:\fP
.RS 4
3.4 
.RE
.PP

.PP
Definition at line 260 of file kstdguiitem.cpp.
.SS "\fBKGuiItem\fP KStdGuiItem::remove ()\fC [static]\fP"
.PP
Returns a 'remove' item. 
.PP
\fBSince:\fP
.RS 4
3.4 
.RE
.PP

.PP
Definition at line 265 of file kstdguiitem.cpp.
.SS "\fBKGuiItem\fP KStdGuiItem::test ()\fC [static]\fP"
.PP
Returns a 'test' item. 
.PP
\fBSince:\fP
.RS 4
3.4 
.RE
.PP

.PP
Definition at line 270 of file kstdguiitem.cpp.

.SH "Author"
.PP 
Generated automatically by Doxygen for kdeui Library from the source code.
