• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • applications API Reference
  • KDE Home
  • Contact Us
 

Konsole

  • kde-4.14
  • applications
  • konsole
  • src
  • settings
KonsoleSettings.h
Go to the documentation of this file.
1 // This file is generated by kconfig_compiler from konsole.kcfg.
2 // All changes you do to this file will be lost.
3 #ifndef KONSOLE_KONSOLESETTINGS_H
4 #define KONSOLE_KONSOLESETTINGS_H
5 
6 #include <kconfigskeleton.h>
7 #include <kdebug.h>
8 
9 namespace Konsole {
10 
11 class KonsoleSettings : public KConfigSkeleton
12 {
13  public:
14  enum EnumTabBarVisibility { AlwaysShowTabBar, ShowTabBarWhenNeeded, AlwaysHideTabBar };
15  enum EnumTabBarPosition { Top, Bottom };
16  enum EnumNewTabBehavior { PutNewTabAtTheEnd, PutNewTabAfterCurrentTab };
17 
18  static KonsoleSettings *self();
19  ~KonsoleSettings();
20 
24  static
25  void setShowMenuBarByDefault( bool v )
26  {
27  if (!self()->isImmutable( QString::fromLatin1( "ShowMenuBarByDefault" ) ))
28  self()->mShowMenuBarByDefault = v;
29  }
30 
34  static
35  bool showMenuBarByDefault()
36  {
37  return self()->mShowMenuBarByDefault;
38  }
39 
43  ItemBool *showMenuBarByDefaultItem()
44  {
45  return mShowMenuBarByDefaultItem;
46  }
47 
51  static
52  void setShowWindowTitleOnTitleBar( bool v )
53  {
54  if (!self()->isImmutable( QString::fromLatin1( "ShowWindowTitleOnTitleBar" ) ))
55  self()->mShowWindowTitleOnTitleBar = v;
56  }
57 
61  static
62  bool showWindowTitleOnTitleBar()
63  {
64  return self()->mShowWindowTitleOnTitleBar;
65  }
66 
70  ItemBool *showWindowTitleOnTitleBarItem()
71  {
72  return mShowWindowTitleOnTitleBarItem;
73  }
74 
78  static
79  void setShowAppNameOnTitleBar( bool v )
80  {
81  if (!self()->isImmutable( QString::fromLatin1( "ShowAppNameOnTitleBar" ) ))
82  self()->mShowAppNameOnTitleBar = v;
83  }
84 
88  static
89  bool showAppNameOnTitleBar()
90  {
91  return self()->mShowAppNameOnTitleBar;
92  }
93 
97  ItemBool *showAppNameOnTitleBarItem()
98  {
99  return mShowAppNameOnTitleBarItem;
100  }
101 
105  static
106  void setAllowMenuAccelerators( bool v )
107  {
108  if (!self()->isImmutable( QString::fromLatin1( "AllowMenuAccelerators" ) ))
109  self()->mAllowMenuAccelerators = v;
110  }
111 
115  static
116  bool allowMenuAccelerators()
117  {
118  return self()->mAllowMenuAccelerators;
119  }
120 
124  ItemBool *allowMenuAcceleratorsItem()
125  {
126  return mAllowMenuAcceleratorsItem;
127  }
128 
132  static
133  void setShowTerminalSizeHint( bool v )
134  {
135  if (!self()->isImmutable( QString::fromLatin1( "ShowTerminalSizeHint" ) ))
136  self()->mShowTerminalSizeHint = v;
137  }
138 
142  static
143  bool showTerminalSizeHint()
144  {
145  return self()->mShowTerminalSizeHint;
146  }
147 
151  ItemBool *showTerminalSizeHintItem()
152  {
153  return mShowTerminalSizeHintItem;
154  }
155 
159  static
160  void setSaveGeometryOnExit( bool v )
161  {
162  if (!self()->isImmutable( QString::fromLatin1( "SaveGeometryOnExit" ) ))
163  self()->mSaveGeometryOnExit = v;
164  }
165 
169  static
170  bool saveGeometryOnExit()
171  {
172  return self()->mSaveGeometryOnExit;
173  }
174 
178  ItemBool *saveGeometryOnExitItem()
179  {
180  return mSaveGeometryOnExitItem;
181  }
182 
186  static
187  void setTabBarVisibility( int v )
188  {
189  if (!self()->isImmutable( QString::fromLatin1( "TabBarVisibility" ) ))
190  self()->mTabBarVisibility = v;
191  }
192 
196  static
197  int tabBarVisibility()
198  {
199  return self()->mTabBarVisibility;
200  }
201 
205  ItemEnum *tabBarVisibilityItem()
206  {
207  return mTabBarVisibilityItem;
208  }
209 
213  static
214  void setTabBarPosition( int v )
215  {
216  if (!self()->isImmutable( QString::fromLatin1( "TabBarPosition" ) ))
217  self()->mTabBarPosition = v;
218  }
219 
223  static
224  int tabBarPosition()
225  {
226  return self()->mTabBarPosition;
227  }
228 
232  ItemEnum *tabBarPositionItem()
233  {
234  return mTabBarPositionItem;
235  }
236 
240  static
241  void setTabBarStyleSheet( const QString & v )
242  {
243  if (!self()->isImmutable( QString::fromLatin1( "TabBarStyleSheet" ) ))
244  self()->mTabBarStyleSheet = v;
245  }
246 
250  static
251  QString tabBarStyleSheet()
252  {
253  return self()->mTabBarStyleSheet;
254  }
255 
259  ItemString *tabBarStyleSheetItem()
260  {
261  return mTabBarStyleSheetItem;
262  }
263 
267  static
268  void setTabBarUseUserStyleSheet( bool v )
269  {
270  if (!self()->isImmutable( QString::fromLatin1( "TabBarUseUserStyleSheet" ) ))
271  self()->mTabBarUseUserStyleSheet = v;
272  }
273 
277  static
278  bool tabBarUseUserStyleSheet()
279  {
280  return self()->mTabBarUseUserStyleSheet;
281  }
282 
286  ItemBool *tabBarUseUserStyleSheetItem()
287  {
288  return mTabBarUseUserStyleSheetItem;
289  }
290 
294  static
295  void setTabBarUserStyleSheetFile( const KUrl & v )
296  {
297  if (!self()->isImmutable( QString::fromLatin1( "TabBarUserStyleSheetFile" ) ))
298  self()->mTabBarUserStyleSheetFile = v;
299  }
300 
304  static
305  KUrl tabBarUserStyleSheetFile()
306  {
307  return self()->mTabBarUserStyleSheetFile;
308  }
309 
313  ItemUrl *tabBarUserStyleSheetFileItem()
314  {
315  return mTabBarUserStyleSheetFileItem;
316  }
317 
321  static
322  void setShowQuickButtons( bool v )
323  {
324  if (!self()->isImmutable( QString::fromLatin1( "ShowQuickButtons" ) ))
325  self()->mShowQuickButtons = v;
326  }
327 
331  static
332  bool showQuickButtons()
333  {
334  return self()->mShowQuickButtons;
335  }
336 
340  ItemBool *showQuickButtonsItem()
341  {
342  return mShowQuickButtonsItem;
343  }
344 
348  static
349  void setNewTabBehavior( int v )
350  {
351  if (!self()->isImmutable( QString::fromLatin1( "NewTabBehavior" ) ))
352  self()->mNewTabBehavior = v;
353  }
354 
358  static
359  int newTabBehavior()
360  {
361  return self()->mNewTabBehavior;
362  }
363 
367  ItemEnum *newTabBehaviorItem()
368  {
369  return mNewTabBehaviorItem;
370  }
371 
375  static
376  void setPrinterFriendly( bool v )
377  {
378  if (!self()->isImmutable( QString::fromLatin1( "PrinterFriendly" ) ))
379  self()->mPrinterFriendly = v;
380  }
381 
385  static
386  bool printerFriendly()
387  {
388  return self()->mPrinterFriendly;
389  }
390 
394  ItemBool *printerFriendlyItem()
395  {
396  return mPrinterFriendlyItem;
397  }
398 
402  static
403  void setScaleOutput( bool v )
404  {
405  if (!self()->isImmutable( QString::fromLatin1( "ScaleOutput" ) ))
406  self()->mScaleOutput = v;
407  }
408 
412  static
413  bool scaleOutput()
414  {
415  return self()->mScaleOutput;
416  }
417 
421  ItemBool *scaleOutputItem()
422  {
423  return mScaleOutputItem;
424  }
425 
426  protected:
427  KonsoleSettings();
428  friend class KonsoleSettingsHelper;
429 
430 
431  // KonsoleWindow
432  bool mShowMenuBarByDefault;
433  bool mShowWindowTitleOnTitleBar;
434  bool mShowAppNameOnTitleBar;
435  bool mAllowMenuAccelerators;
436  bool mShowTerminalSizeHint;
437  bool mSaveGeometryOnExit;
438 
439  // TabBar
440  int mTabBarVisibility;
441  int mTabBarPosition;
442  QString mTabBarStyleSheet;
443  bool mTabBarUseUserStyleSheet;
444  KUrl mTabBarUserStyleSheetFile;
445  bool mShowQuickButtons;
446  int mNewTabBehavior;
447 
448  // PrintOptions
449  bool mPrinterFriendly;
450  bool mScaleOutput;
451 
452  private:
453  ItemBool *mShowMenuBarByDefaultItem;
454  ItemBool *mShowWindowTitleOnTitleBarItem;
455  ItemBool *mShowAppNameOnTitleBarItem;
456  ItemBool *mAllowMenuAcceleratorsItem;
457  ItemBool *mShowTerminalSizeHintItem;
458  ItemBool *mSaveGeometryOnExitItem;
459  ItemEnum *mTabBarVisibilityItem;
460  ItemEnum *mTabBarPositionItem;
461  ItemString *mTabBarStyleSheetItem;
462  ItemBool *mTabBarUseUserStyleSheetItem;
463  ItemUrl *mTabBarUserStyleSheetFileItem;
464  ItemBool *mShowQuickButtonsItem;
465  ItemEnum *mNewTabBehaviorItem;
466  ItemBool *mPrinterFriendlyItem;
467  ItemBool *mScaleOutputItem;
468 };
469 
470 }
471 
472 #endif
473 
Konsole::KonsoleSettings::tabBarUserStyleSheetFileItem
ItemUrl * tabBarUserStyleSheetFileItem()
Get Item object corresponding to TabBarUserStyleSheetFile()
Definition: KonsoleSettings.h:313
Konsole::KonsoleSettings::EnumTabBarPosition
EnumTabBarPosition
Definition: KonsoleSettings.h:15
Konsole::KonsoleSettings::printerFriendly
static bool printerFriendly()
Get Printer &friendly mode (black text, no background)
Definition: KonsoleSettings.h:386
Konsole::KonsoleSettings::tabBarStyleSheetItem
ItemString * tabBarStyleSheetItem()
Get Item object corresponding to TabBarStyleSheet()
Definition: KonsoleSettings.h:259
Konsole::KonsoleSettings::setShowWindowTitleOnTitleBar
static void setShowWindowTitleOnTitleBar(bool v)
Set Show window title on the titlebar.
Definition: KonsoleSettings.h:52
Konsole::KonsoleSettings::tabBarPosition
static int tabBarPosition()
Get Control the position of the tab bar.
Definition: KonsoleSettings.h:224
Konsole::KonsoleSettings::PutNewTabAtTheEnd
Definition: KonsoleSettings.h:16
Konsole::KonsoleSettings::setShowAppNameOnTitleBar
static void setShowAppNameOnTitleBar(bool v)
Set Show "- Konsole" on the titlebar.
Definition: KonsoleSettings.h:79
Konsole::KonsoleSettings::KonsoleSettingsHelper
friend class KonsoleSettingsHelper
Definition: KonsoleSettings.h:428
Konsole::KonsoleSettings::tabBarPositionItem
ItemEnum * tabBarPositionItem()
Get Item object corresponding to TabBarPosition()
Definition: KonsoleSettings.h:232
Konsole::KonsoleSettings::ShowTabBarWhenNeeded
Definition: KonsoleSettings.h:14
Konsole::KonsoleSettings::showTerminalSizeHint
static bool showTerminalSizeHint()
Get Show hint for terminal size after resizing.
Definition: KonsoleSettings.h:143
Konsole::KonsoleSettings::AlwaysShowTabBar
Definition: KonsoleSettings.h:14
Konsole::KonsoleSettings::showMenuBarByDefaultItem
ItemBool * showMenuBarByDefaultItem()
Get Item object corresponding to ShowMenuBarByDefault()
Definition: KonsoleSettings.h:43
Konsole::KonsoleSettings
Definition: KonsoleSettings.h:11
Konsole::KonsoleSettings::mNewTabBehavior
int mNewTabBehavior
Definition: KonsoleSettings.h:446
Konsole::KonsoleSettings::tabBarUseUserStyleSheet
static bool tabBarUseUserStyleSheet()
Get Use a user-defined .css file for the tab bar.
Definition: KonsoleSettings.h:278
Konsole::KonsoleSettings::AlwaysHideTabBar
Definition: KonsoleSettings.h:14
Konsole::KonsoleSettings::showQuickButtons
static bool showQuickButtons()
Get Control the visibility of quick buttons on the tab bar.
Definition: KonsoleSettings.h:332
Konsole::KonsoleSettings::mTabBarUserStyleSheetFile
KUrl mTabBarUserStyleSheetFile
Definition: KonsoleSettings.h:444
Konsole::KonsoleSettings::tabBarVisibilityItem
ItemEnum * tabBarVisibilityItem()
Get Item object corresponding to TabBarVisibility()
Definition: KonsoleSettings.h:205
KConfigSkeleton
Konsole::KonsoleSettings::mAllowMenuAccelerators
bool mAllowMenuAccelerators
Definition: KonsoleSettings.h:435
Konsole::KonsoleSettings::setTabBarVisibility
static void setTabBarVisibility(int v)
Set Control the visibility of the whole tab bar.
Definition: KonsoleSettings.h:187
Konsole::KonsoleSettings::setScaleOutput
static void setScaleOutput(bool v)
Set &Scale output.
Definition: KonsoleSettings.h:403
Konsole::KonsoleSettings::tabBarStyleSheet
static QString tabBarStyleSheet()
Get Control the visual style of the tab bar.
Definition: KonsoleSettings.h:251
Konsole::KonsoleSettings::setTabBarUseUserStyleSheet
static void setTabBarUseUserStyleSheet(bool v)
Set Use a user-defined .css file for the tab bar.
Definition: KonsoleSettings.h:268
Konsole::KonsoleSettings::showWindowTitleOnTitleBar
static bool showWindowTitleOnTitleBar()
Get Show window title on the titlebar.
Definition: KonsoleSettings.h:62
Konsole::KonsoleSettings::mTabBarVisibility
int mTabBarVisibility
Definition: KonsoleSettings.h:440
Konsole::KonsoleSettings::mShowWindowTitleOnTitleBar
bool mShowWindowTitleOnTitleBar
Definition: KonsoleSettings.h:433
Konsole::KonsoleSettings::printerFriendlyItem
ItemBool * printerFriendlyItem()
Get Item object corresponding to PrinterFriendly()
Definition: KonsoleSettings.h:394
Konsole::KonsoleSettings::mShowMenuBarByDefault
bool mShowMenuBarByDefault
Definition: KonsoleSettings.h:432
Konsole::KonsoleSettings::mShowQuickButtons
bool mShowQuickButtons
Definition: KonsoleSettings.h:445
Konsole::KonsoleSettings::mShowAppNameOnTitleBar
bool mShowAppNameOnTitleBar
Definition: KonsoleSettings.h:434
Konsole::KonsoleSettings::mScaleOutput
bool mScaleOutput
Definition: KonsoleSettings.h:450
Konsole::KonsoleSettings::mShowTerminalSizeHint
bool mShowTerminalSizeHint
Definition: KonsoleSettings.h:436
Konsole::KonsoleSettings::setShowQuickButtons
static void setShowQuickButtons(bool v)
Set Control the visibility of quick buttons on the tab bar.
Definition: KonsoleSettings.h:322
Konsole::KonsoleSettings::PutNewTabAfterCurrentTab
Definition: KonsoleSettings.h:16
Konsole::KonsoleSettings::tabBarUserStyleSheetFile
static KUrl tabBarUserStyleSheetFile()
Get The .css file to use for the tab bar style.
Definition: KonsoleSettings.h:305
Konsole::KonsoleSettings::mTabBarPosition
int mTabBarPosition
Definition: KonsoleSettings.h:441
Konsole::KonsoleSettings::EnumTabBarVisibility
EnumTabBarVisibility
Definition: KonsoleSettings.h:14
QString
Konsole::KonsoleSettings::setAllowMenuAccelerators
static void setAllowMenuAccelerators(bool v)
Set Enable menu accelerators.
Definition: KonsoleSettings.h:106
Konsole::KonsoleSettings::Top
Definition: KonsoleSettings.h:15
Konsole::KonsoleSettings::showAppNameOnTitleBarItem
ItemBool * showAppNameOnTitleBarItem()
Get Item object corresponding to ShowAppNameOnTitleBar()
Definition: KonsoleSettings.h:97
Konsole::KonsoleSettings::setShowTerminalSizeHint
static void setShowTerminalSizeHint(bool v)
Set Show hint for terminal size after resizing.
Definition: KonsoleSettings.h:133
Konsole::KonsoleSettings::showAppNameOnTitleBar
static bool showAppNameOnTitleBar()
Get Show "- Konsole" on the titlebar.
Definition: KonsoleSettings.h:89
Konsole::KonsoleSettings::setNewTabBehavior
static void setNewTabBehavior(int v)
Set Control where to put the new tab.
Definition: KonsoleSettings.h:349
Konsole::KonsoleSettings::newTabBehavior
static int newTabBehavior()
Get Control where to put the new tab.
Definition: KonsoleSettings.h:359
Konsole::KonsoleSettings::scaleOutputItem
ItemBool * scaleOutputItem()
Get Item object corresponding to ScaleOutput()
Definition: KonsoleSettings.h:421
Konsole::KonsoleSettings::newTabBehaviorItem
ItemEnum * newTabBehaviorItem()
Get Item object corresponding to NewTabBehavior()
Definition: KonsoleSettings.h:367
Konsole::KonsoleSettings::setTabBarUserStyleSheetFile
static void setTabBarUserStyleSheetFile(const KUrl &v)
Set The .css file to use for the tab bar style.
Definition: KonsoleSettings.h:295
Konsole::KonsoleSettings::scaleOutput
static bool scaleOutput()
Get &Scale output.
Definition: KonsoleSettings.h:413
Konsole::KonsoleSettings::tabBarUseUserStyleSheetItem
ItemBool * tabBarUseUserStyleSheetItem()
Get Item object corresponding to TabBarUseUserStyleSheet()
Definition: KonsoleSettings.h:286
Konsole::KonsoleSettings::mSaveGeometryOnExit
bool mSaveGeometryOnExit
Definition: KonsoleSettings.h:437
Konsole::KonsoleSettings::KonsoleSettings
KonsoleSettings()
Definition: KonsoleSettings.cpp:35
Konsole::KonsoleSettings::allowMenuAccelerators
static bool allowMenuAccelerators()
Get Enable menu accelerators.
Definition: KonsoleSettings.h:116
Konsole::KonsoleSettings::mTabBarStyleSheet
QString mTabBarStyleSheet
Definition: KonsoleSettings.h:442
Konsole::KonsoleSettings::setSaveGeometryOnExit
static void setSaveGeometryOnExit(bool v)
Set Use current window size on next startup.
Definition: KonsoleSettings.h:160
Konsole::KonsoleSettings::Bottom
Definition: KonsoleSettings.h:15
Konsole::KonsoleSettings::EnumNewTabBehavior
EnumNewTabBehavior
Definition: KonsoleSettings.h:16
Konsole::KonsoleSettings::setTabBarPosition
static void setTabBarPosition(int v)
Set Control the position of the tab bar.
Definition: KonsoleSettings.h:214
Konsole::KonsoleSettings::showQuickButtonsItem
ItemBool * showQuickButtonsItem()
Get Item object corresponding to ShowQuickButtons()
Definition: KonsoleSettings.h:340
Konsole::KonsoleSettings::setShowMenuBarByDefault
static void setShowMenuBarByDefault(bool v)
Set Show menubar by default.
Definition: KonsoleSettings.h:25
Konsole::KonsoleSettings::mPrinterFriendly
bool mPrinterFriendly
Definition: KonsoleSettings.h:449
Konsole::KonsoleSettings::setPrinterFriendly
static void setPrinterFriendly(bool v)
Set Printer &friendly mode (black text, no background)
Definition: KonsoleSettings.h:376
Konsole::KonsoleSettings::showWindowTitleOnTitleBarItem
ItemBool * showWindowTitleOnTitleBarItem()
Get Item object corresponding to ShowWindowTitleOnTitleBar()
Definition: KonsoleSettings.h:70
Konsole::KonsoleSettings::saveGeometryOnExitItem
ItemBool * saveGeometryOnExitItem()
Get Item object corresponding to SaveGeometryOnExit()
Definition: KonsoleSettings.h:178
Konsole::KonsoleSettings::setTabBarStyleSheet
static void setTabBarStyleSheet(const QString &v)
Set Control the visual style of the tab bar.
Definition: KonsoleSettings.h:241
QString::fromLatin1
QString fromLatin1(const char *str, int size)
Konsole::KonsoleSettings::~KonsoleSettings
~KonsoleSettings()
Definition: KonsoleSettings.cpp:139
Konsole::KonsoleSettings::tabBarVisibility
static int tabBarVisibility()
Get Control the visibility of the whole tab bar.
Definition: KonsoleSettings.h:197
Konsole::KonsoleSettings::mTabBarUseUserStyleSheet
bool mTabBarUseUserStyleSheet
Definition: KonsoleSettings.h:443
Konsole::KonsoleSettings::showTerminalSizeHintItem
ItemBool * showTerminalSizeHintItem()
Get Item object corresponding to ShowTerminalSizeHint()
Definition: KonsoleSettings.h:151
Konsole::KonsoleSettings::saveGeometryOnExit
static bool saveGeometryOnExit()
Get Use current window size on next startup.
Definition: KonsoleSettings.h:170
Konsole::KonsoleSettings::showMenuBarByDefault
static bool showMenuBarByDefault()
Get Show menubar by default.
Definition: KonsoleSettings.h:35
Konsole::KonsoleSettings::allowMenuAcceleratorsItem
ItemBool * allowMenuAcceleratorsItem()
Get Item object corresponding to AllowMenuAccelerators()
Definition: KonsoleSettings.h:124
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Sat May 9 2020 03:56:27 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

Konsole

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

applications API Reference

Skip menu "applications API Reference"
  •   kate
  •       kate
  •   KTextEditor
  •   Kate
  • Konsole

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal