• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • tdeui
 

tdeui

Public Slots | Signals | Public Member Functions | Protected Slots | Protected Member Functions

TDESelectAction Class Reference

Action for selecting one of several items. More...

#include <tdeactionclasses.h>

Inheritance diagram for TDESelectAction:
TDEAction TQObject TDEListAction TDERecentFilesAction

List of all members.

Public Slots

virtual void setCurrentItem (int index)
virtual void setItems (const TQStringList &lst)
virtual void clear ()
virtual void setEditable (bool)
virtual void setComboWidth (int width)

Signals

void activated (int index)
void activated (const TQString &text)

Public Member Functions

 TDESelectAction (const TQString &text, const TDEShortcut &cut=TDEShortcut(), TQObject *parent=0, const char *name=0)
 TDESelectAction (const TQString &text, const TDEShortcut &cut, const TQObject *receiver, const char *slot, TQObject *parent, const char *name=0)
 TDESelectAction (const TQString &text, const TQIconSet &pix, const TDEShortcut &cut=TDEShortcut(), TQObject *parent=0, const char *name=0)
 TDESelectAction (const TQString &text, const TQString &pix, const TDEShortcut &cut=TDEShortcut(), TQObject *parent=0, const char *name=0)
 TDESelectAction (const TQString &text, const TQIconSet &pix, const TDEShortcut &cut, const TQObject *receiver, const char *slot, TQObject *parent, const char *name=0)
 TDESelectAction (const TQString &text, const TQString &pix, const TDEShortcut &cut, const TQObject *receiver, const char *slot, TQObject *parent, const char *name=0)
 TDESelectAction (TQObject *parent=0, const char *name=0)
virtual ~TDESelectAction ()
virtual int plug (TQWidget *widget, int index=-1)
virtual bool isEditable () const
virtual TQStringList items () const
virtual void changeItem (int index, const TQString &text)
virtual TQString currentText () const
virtual int currentItem () const
virtual int comboWidth () const
void setMaxComboViewCount (int n)
TQPopupMenu * popupMenu () const
void setRemoveAmpersandsInCombo (bool b) KDE_DEPRECATED
bool removeAmpersandsInCombo () const
void setMenuAccelsEnabled (bool b)
bool menuAccelsEnabled () const
virtual bool isShortcutConfigurable () const

Protected Slots

virtual void slotActivated (int id)
virtual void slotActivated (const TQString &text)
virtual void slotActivated ()

Protected Member Functions

virtual void changeItem (int id, int index, const TQString &text)
TQStringList comboItems () const
virtual void updateCurrentItem (int id)
virtual void updateComboWidth (int id)
virtual void updateItems (int id)
virtual void updateClear (int id)
virtual void virtual_hook (int id, void *data)

Detailed Description

Action for selecting one of several items.

Action for selecting one of several items.

This action shows up a submenu with a list of items. One of them can be checked. If the user clicks on an item this item will automatically be checked, the formerly checked item becomes unchecked. There can be only one item checked at a time.

Definition at line 331 of file tdeactionclasses.h.


Constructor & Destructor Documentation

TDESelectAction::TDESelectAction ( const TQString &  text,
const TDEShortcut &  cut = TDEShortcut(),
TQObject *  parent = 0,
const char *  name = 0 
)

Constructs a select action with text and potential keyboard accelerator but nothing else.

Use this only if you really know what you are doing.

Parameters:
text The text that will be displayed.
cut The corresponding keyboard accelerator (shortcut).
parent This action's parent.
name An internal name for this action.

Definition at line 376 of file tdeactionclasses.cpp.

TDESelectAction::TDESelectAction ( const TQString &  text,
const TDEShortcut &  cut,
const TQObject *  receiver,
const char *  slot,
TQObject *  parent,
const char *  name = 0 
)
Parameters:
text The text that will be displayed.
cut The corresponding keyboard accelerator (shortcut).
receiver The SLOT's parent.
slot The TQT_SLOT to invoke to execute this action.
parent This action's parent.
name An internal name for this action.

Definition at line 383 of file tdeactionclasses.cpp.

TDESelectAction::TDESelectAction ( const TQString &  text,
const TQIconSet &  pix,
const TDEShortcut &  cut = TDEShortcut(),
TQObject *  parent = 0,
const char *  name = 0 
)
Parameters:
text The text that will be displayed.
pix The icons that go with this action.
cut The corresponding keyboard accelerator (shortcut).
parent This action's parent.
name An internal name for this action.

Definition at line 391 of file tdeactionclasses.cpp.

TDESelectAction::TDESelectAction ( const TQString &  text,
const TQString &  pix,
const TDEShortcut &  cut = TDEShortcut(),
TQObject *  parent = 0,
const char *  name = 0 
)
Parameters:
text The text that will be displayed.
pix The dynamically loaded icon that goes with this action.
cut The corresponding keyboard accelerator (shortcut).
parent This action's parent.
name An internal name for this action.

Definition at line 399 of file tdeactionclasses.cpp.

TDESelectAction::TDESelectAction ( const TQString &  text,
const TQIconSet &  pix,
const TDEShortcut &  cut,
const TQObject *  receiver,
const char *  slot,
TQObject *  parent,
const char *  name = 0 
)
Parameters:
text The text that will be displayed.
pix The icons that go with this action.
cut The corresponding keyboard accelerator (shortcut).
receiver The SLOT's parent.
slot The TQT_SLOT to invoke to execute this action.
parent This action's parent.
name An internal name for this action.

Definition at line 407 of file tdeactionclasses.cpp.

TDESelectAction::TDESelectAction ( const TQString &  text,
const TQString &  pix,
const TDEShortcut &  cut,
const TQObject *  receiver,
const char *  slot,
TQObject *  parent,
const char *  name = 0 
)
Parameters:
text The text that will be displayed.
pix The dynamically loaded icon that goes with this action.
cut The corresponding keyboard accelerator (shortcut).
receiver The SLOT's parent.
slot The TQT_SLOT to invoke to execute this action.
parent This action's parent.
name An internal name for this action.

Definition at line 417 of file tdeactionclasses.cpp.

TDESelectAction::TDESelectAction ( TQObject *  parent = 0,
const char *  name = 0 
)
Parameters:
parent This action's parent.
name An internal name for this action.

Definition at line 427 of file tdeactionclasses.cpp.

TDESelectAction::~TDESelectAction (  )  [virtual]

Destructor.

Definition at line 433 of file tdeactionclasses.cpp.


Member Function Documentation

void TDESelectAction::activated ( int  index  )  [signal]

This signal is emitted when an item is selected;.

Parameters:
index indicated the item selected.
void TDESelectAction::activated ( const TQString &  text  )  [signal]

This signal is emitted when an item is selected;.

Parameters:
text indicates the item selected.
void TDESelectAction::changeItem ( int  index,
const TQString &  text 
) [virtual]

Changes the text of item.

Parameters:
index to
text .

Definition at line 516 of file tdeactionclasses.cpp.

void TDESelectAction::clear (  )  [virtual, slot]

Clears up all the items in this action.

Definition at line 744 of file tdeactionclasses.cpp.

TQStringList TDESelectAction::comboItems (  )  const [protected]

Depending on the menuAccelsEnabled property this method will return the actions items in a way for inclusion in a combobox with the ampersand character removed from all items or not.

Since:
3.1

Definition at line 725 of file tdeactionclasses.cpp.

int TDESelectAction::comboWidth (  )  const [virtual]

When this action is plugged into a toolbar, it creates a combobox.

This returns the maximum width set by setComboWidth

Definition at line 599 of file tdeactionclasses.cpp.

int TDESelectAction::currentItem (  )  const [virtual]

Returns the index of the current item.

See also:
setCurrentItem

Reimplemented in TDEListAction.

Definition at line 579 of file tdeactionclasses.cpp.

TQString TDESelectAction::currentText (  )  const [virtual]

Returns the text of the currently selected item.

Reimplemented in TDEListAction.

Definition at line 571 of file tdeactionclasses.cpp.

bool TDESelectAction::isEditable (  )  const [virtual]

When this action is plugged into a toolbar, it creates a combobox.

Returns:
true if the combo editable.

Definition at line 812 of file tdeactionclasses.cpp.

virtual bool TDESelectAction::isShortcutConfigurable (  )  const [inline, virtual]

Returns true if this action's shortcut is configurable.

Reimplemented from TDEAction.

Definition at line 500 of file tdeactionclasses.h.

TQStringList TDESelectAction::items (  )  const [virtual]
Returns:
the items that can be selected with this action. Use setItems to set them.

Reimplemented in TDERecentFilesAction.

Definition at line 566 of file tdeactionclasses.cpp.

bool TDESelectAction::menuAccelsEnabled (  )  const
Since:
3.1

Definition at line 832 of file tdeactionclasses.cpp.

int TDESelectAction::plug ( TQWidget *  widget,
int  index = -1 
) [virtual]

"Plug" or insert this action into a given widget.

This will typically be a menu or a toolbar. From this point on, you will never need to directly manipulate the item in the menu or toolbar. You do all enabling/disabling/manipulation directly with your TDESelectAction object.

Parameters:
widget The GUI element to display this action.
index The index of the item.

Reimplemented from TDEAction.

Reimplemented in TDERecentFilesAction.

Definition at line 639 of file tdeactionclasses.cpp.

TQPopupMenu * TDESelectAction::popupMenu (  )  const

Returns a pointer to the popup menu used by this action.

Definition at line 486 of file tdeactionclasses.cpp.

bool TDESelectAction::removeAmpersandsInCombo (  )  const
Since:
3.1

Definition at line 822 of file tdeactionclasses.cpp.

void TDESelectAction::setComboWidth ( int  width  )  [virtual, slot]

When this action is plugged into a toolbar, it creates a combobox.

This gives a _maximum_ size to the combobox. The minimum size is automatically given by the contents (the items).

Definition at line 467 of file tdeactionclasses.cpp.

void TDESelectAction::setCurrentItem ( int  index  )  [virtual, slot]

Sets the currently checked item.

Parameters:
index Index of the item (remember the first item is zero).

Reimplemented in TDEListAction.

Definition at line 440 of file tdeactionclasses.cpp.

void TDESelectAction::setEditable ( bool  edit  )  [virtual, slot]

When this action is plugged into a toolbar, it creates a combobox.

This makes the combo editable or read-only.

Definition at line 807 of file tdeactionclasses.cpp.

void TDESelectAction::setItems ( const TQStringList &  lst  )  [virtual, slot]

Sets the items to be displayed in this action You need to call this.

Definition at line 551 of file tdeactionclasses.cpp.

void TDESelectAction::setMaxComboViewCount ( int  n  ) 

Sets the maximum items that are visible at once if the action is a combobox, that is the number of items in the combobox's viewport Only works before the action is plugged.

Since:
3.5

Definition at line 481 of file tdeactionclasses.cpp.

void TDESelectAction::setMenuAccelsEnabled ( bool  b  ) 

Sets whether any occurrence of the ampersand character ( & ) in items should be interpreted as keyboard accelerator for items displayed in a menu or not.

Since:
3.1

Definition at line 827 of file tdeactionclasses.cpp.

void TDESelectAction::setRemoveAmpersandsInCombo ( bool  b  ) 
Deprecated:
See setMenuAccelsEnabled .
Since:
3.1

Definition at line 817 of file tdeactionclasses.cpp.


The documentation for this class was generated from the following files:
  • tdeactionclasses.h
  • tdeactionclasses.cpp

tdeui

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

tdeui

Skip menu "tdeui"
  • arts
  • dcop
  • dnssd
  • interfaces
  •   kspeech
  •     interface
  •     library
  •   tdetexteditor
  • kate
  • kded
  • kdoctools
  • kimgio
  • kjs
  • libtdemid
  • libtdescreensaver
  • tdeabc
  • tdecmshell
  • tdecore
  • tdefx
  • tdehtml
  • tdeinit
  • tdeio
  •   bookmarks
  •   httpfilter
  •   kpasswdserver
  •   kssl
  •   tdefile
  •   tdeio
  •   tdeioexec
  • tdeioslave
  •   http
  • tdemdi
  •   tdemdi
  • tdenewstuff
  • tdeparts
  • tdeprint
  • tderandr
  • tderesources
  • tdespell2
  • tdesu
  • tdeui
  • tdeunittest
  • tdeutils
  • tdewallet
Generated for tdeui by doxygen 1.7.1
This website is maintained by Timothy Pearson.