• Skip to content
  • Skip to link menu
KDE 4.3 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KDEUI

KStandardGuiItem Namespace Reference

Provides a set of standardized KGuiItems. More...

Enumerations

enum  BidiMode { UseRTL = 0, IgnoreRTL }
enum  StandardItem {
  Ok = 1, Cancel, Yes, No,
  Discard, Save, DontSave, SaveAs,
  Apply, Clear, Help, Defaults,
  Close, Back, Forward, Print,
  Continue, Open, Quit, AdminMode,
  Reset, Delete, Insert, Configure,
  Find, Stop, Add, Remove,
  Test, Properties, Overwrite, CloseWindow,
  CloseDocument
}

Functions

KGuiItem add ()
KGuiItem adminMode ()
KGuiItem apply ()
KGuiItem back (BidiMode useBidi=IgnoreRTL)
QPair< KGuiItem, KGuiItem > backAndForward ()
KGuiItem cancel ()
KGuiItem clear ()
KGuiItem close ()
KGuiItem closeDocument ()
KGuiItem closeWindow ()
KGuiItem configure ()
KGuiItem cont ()
KGuiItem defaults ()
KGuiItem del ()
KGuiItem discard ()
KGuiItem dontSave ()
KGuiItem find ()
KGuiItem forward (BidiMode useBidi=IgnoreRTL)
KGuiItem guiItem (StandardItem id)
KGuiItem help ()
KGuiItem insert ()
KGuiItem no ()
KGuiItem ok ()
KGuiItem open ()
KGuiItem overwrite ()
KGuiItem print ()
KGuiItem properties ()
KGuiItem quit ()
KGuiItem remove ()
KGuiItem reset ()
KGuiItem save ()
KGuiItem saveAs ()
QString standardItem (StandardItem id)
KGuiItem stop ()
KGuiItem test ()
KGuiItem yes ()

Detailed Description

Provides a set of standardized KGuiItems.

The various KDEUI_EXPORT methods returns standardized KGuiItem's conforming to the KDE UI Standards. Use them instead of creating your own.

Author:
Holger Freyther <freyther@kde.org>

Enumeration Type Documentation

enum KStandardGuiItem::BidiMode

The back and forward items by default use the RTL settings for Hebrew and Arab countries.

If you want those actions to ignore the RTL value and force 'Western' behavior instead, use the IgnoreRTL value instead.

Enumerator:
UseRTL 
IgnoreRTL 

Definition at line 46 of file kstandardguiitem.h.

enum KStandardGuiItem::StandardItem
Enumerator:
Ok 
Cancel 
Yes 
No 
Discard 
Save 
DontSave 
SaveAs 
Apply 
Clear 
Help 
Defaults 
Close 
Back 
Forward 
Print 
Continue 
Open 
Quit 
AdminMode 
Reset 
Delete 
Insert 
Configure 
Find 
Stop 
Add 
Remove 
Test 
Properties 
Overwrite 
CloseWindow 
CloseDocument 

Definition at line 48 of file kstandardguiitem.h.


Function Documentation

KGuiItem KStandardGuiItem::add (  ) 

Returns the 'Add' gui item.

KGuiItem KStandardGuiItem::adminMode (  ) 

Returns a KGuiItem suiting for cases where code or functionality runs under root privileges.

Used in conjunction with KConfig Modules.

KGuiItem KStandardGuiItem::apply (  ) 

Returns the 'Apply' gui item.

KGuiItem KStandardGuiItem::back ( BidiMode  useBidi = IgnoreRTL  ) 

Returns the 'Back' gui item, like Konqueror's back button.

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 backAndForward() method.

QPair< KGuiItem, KGuiItem > KStandardGuiItem::backAndForward (  ) 

Return both a back and a forward gui item.

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 back() and forward() items instead.

KGuiItem KStandardGuiItem::cancel (  ) 

Returns the 'Cancel' gui item.

KGuiItem KStandardGuiItem::clear (  ) 

Returns the 'Clear' gui item.

KGuiItem KStandardGuiItem::close (  ) 

Returns the 'Close' gui item.

KGuiItem KStandardGuiItem::closeDocument (  ) 

Returns the 'CloseDocument' gui item.

Since:
4.3
KGuiItem KStandardGuiItem::closeWindow (  ) 

Returns the 'CloseWindow' gui item.

Since:
4.3
KGuiItem KStandardGuiItem::configure (  ) 

Returns the 'Configure' gui item.

KGuiItem KStandardGuiItem::cont (  ) 

Returns the 'Continue' gui item.

The short name is due to 'continue' being a reserved word in the C++ language.

KGuiItem KStandardGuiItem::defaults (  ) 

Returns the 'Defaults' gui item.

KGuiItem KStandardGuiItem::del (  ) 

Returns the 'Delete' gui item.

The short name is due to 'delete' being a reserved word in the C++ language.

KGuiItem KStandardGuiItem::discard (  ) 

Returns the 'Discard' gui item.

KGuiItem KStandardGuiItem::dontSave (  ) 

Returns the 'DontSave' gui item.

KGuiItem KStandardGuiItem::find (  ) 

Returns the 'Find' gui item.

KGuiItem KStandardGuiItem::forward ( BidiMode  useBidi = IgnoreRTL  ) 

Returns the 'Forward' gui item, like Konqueror's forward button.

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 backAndForward() method.

KGuiItem KStandardGuiItem::guiItem ( StandardItem  id  ) 

Returns the gui item for the given identifier.

Parameters:
id. 
id the identifier to search for
KGuiItem KStandardGuiItem::help (  ) 

Returns the 'Help' gui item.

KGuiItem KStandardGuiItem::insert (  ) 

Returns the 'Insert' gui item.

Toggle insert/overwrite (with visual feedback, e.g.

KGuiItem KStandardGuiItem::no (  ) 

Returns the 'No' gui item.

KGuiItem KStandardGuiItem::ok (  ) 

Returns the 'Ok' gui item.

KGuiItem KStandardGuiItem::open (  ) 

Returns the 'Open' gui item.

KGuiItem KStandardGuiItem::overwrite (  ) 

Returns the 'Overwrite' gui item.

KGuiItem KStandardGuiItem::print (  ) 

Returns the 'Print' gui item.

KGuiItem KStandardGuiItem::properties (  ) 

Returns the 'Properties' gui item.

KGuiItem KStandardGuiItem::quit (  ) 

Returns the 'Quit' gui item.

KGuiItem KStandardGuiItem::remove (  ) 

Returns the 'Remove' gui item.

KGuiItem KStandardGuiItem::reset (  ) 

Returns the 'Reset' gui item.

KGuiItem KStandardGuiItem::save (  ) 

Returns the 'Save' gui item.

KGuiItem KStandardGuiItem::saveAs (  ) 

Returns the 'SaveAs' gui item.

QString KStandardGuiItem::standardItem ( StandardItem  id  ) 

Returns the name of the gui item for the given identifier.

Parameters:
id. 
id the identifier to search for
KGuiItem KStandardGuiItem::stop (  ) 

Returns the 'Stop' gui item.

KGuiItem KStandardGuiItem::test (  ) 

Returns the 'Test' gui item.

KGuiItem KStandardGuiItem::yes (  ) 

Returns the 'Yes' gui item.

KDEUI

Skip menu "KDEUI"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.6.1
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal