From fef846914f8db6dc117e206ef913d519bf6bb33e Mon Sep 17 00:00:00 2001 From: Michele Calgaro Date: Mon, 29 Jul 2024 12:43:23 +0900 Subject: Rename basic widget nt* related files to equivalent tq* Signed-off-by: Michele Calgaro --- doc/html/tqcombobox.html | 602 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 602 insertions(+) create mode 100644 doc/html/tqcombobox.html (limited to 'doc/html/tqcombobox.html') diff --git a/doc/html/tqcombobox.html b/doc/html/tqcombobox.html new file mode 100644 index 000000000..b6ced9342 --- /dev/null +++ b/doc/html/tqcombobox.html @@ -0,0 +1,602 @@ + + + + + +TQComboBox Class + + + + + + + +
+ +Home + | +All Classes + | +Main Classes + | +Annotated + | +Grouped Classes + | +Functions +

TQComboBox Class Reference

+ +

The TQComboBox widget is a combined button and popup list. +More... +

#include <tqcombobox.h> +

Inherits TQWidget. +

List of all member functions. +

Public Members

+ +

Public Slots

+ +

Signals

+ +

Properties

+ +

Detailed Description

+ + +The TQComboBox widget is a combined button and popup list. +

+ +

A combobox is a selection widget which displays the current item +and can pop up a list of items. A combobox may be editable in +which case the user can enter arbitrary strings. +

Comboboxes provide a means of showing the user's current choice +out of a list of options in a way that takes up the minimum amount +of screen space. +

TQComboBox supports three different display styles: Aqua/Motif 1.x, +Motif 2.0 and Windows. In Motif 1.x, a combobox was called +XmOptionMenu. In Motif 2.0, OSF introduced an improved combobox +and named that XmComboBox. TQComboBox provides both. +

TQComboBox provides two different constructors. The simplest +constructor creates an "old-style" combobox in Motif (or Aqua) +style: +

+        TQComboBox *c = new TQComboBox( this, "read-only combobox" );
+
+ +

The other constructor creates a new-style combobox in Motif style, +and can create both read-only and editable comboboxes: +

+        TQComboBox *c1 = new TQComboBox( FALSE, this, "read-only combobox" );
+        TQComboBox *c2 = new TQComboBox( TRUE, this, "editable combobox" );
+
+ +

New-style comboboxes use a list box in both Motif and Windows +styles, and both the content size and the on-screen size of the +list box can be limited with sizeLimit() and setMaxCount() +respectively. Old-style comboboxes use a popup in Aqua and Motif +style, and that popup will happily grow larger than the desktop if +you put enough data into it. +

The two constructors create identical-looking comboboxes in +Windows style. +

Comboboxes can contain pixmaps as well as strings; the +insertItem() and changeItem() functions are suitably overloaded. +For editable comboboxes, the function clearEdit() is provided, +to clear the displayed string without changing the combobox's +contents. +

A combobox emits two signals, activated() and highlighted(), when +a new item has been activated (selected) or highlighted (made +current). Both signals exist in two versions, one with a TQString argument and one with an int argument. If the user +highlights or activates a pixmap, only the int signals are +emitted. Whenever the text of an editable combobox is changed the +textChanged() signal is emitted. +

When the user enters a new string in an editable combobox, the +widget may or may not insert it, and it can insert it in several +locations. The default policy is is AtBottom but you can change +this using setInsertionPolicy(). +

It is possible to constrain the input to an editable combobox +using TQValidator; see setValidator(). By default, any input is +accepted. +

If the combobox is not editable then it has a default +focusPolicy() of TabFocus, i.e. it will not grab focus if +clicked. This differs from both Windows and Motif. If the combobox +is editable then it has a default focusPolicy() of StrongFocus, +i.e. it will grab focus if clicked. +

A combobox can be populated using the insert functions, +insertStringList() and insertItem() for example. Items can be +changed with changeItem(). An item can be removed with +removeItem() and all items can be removed with clear(). The text +of the current item is returned by currentText(), and the text of +a numbered item is returned with text(). The current item can be +set with setCurrentItem() or setCurrentText(). The number of items +in the combobox is returned by count(); the maximum number of +items can be set with setMaxCount(). You can allow editing using +setEditable(). For editable comboboxes you can set auto-completion +using setAutoCompletion() and whether or not the user can add +duplicates is set with setDuplicatesEnabled(). +

(Motif 1, read-only)
+(Motif 2, editable)
+(Motif 2, read-only)
+(Windows style) +

Depending on the style, TQComboBox will use a TQListBox or a +TQPopupMenu to display the list of items. See setListBox() for +more information. +

See also TQLineEdit, TQListBox, TQSpinBox, TQRadioButton, TQButtonGroup, GUI Design Handbook: Combo Box, GUI Design Handbook: Drop-Down List Box, and Basic Widgets. + +

Member Type Documentation

+

TQComboBox::Policy

+ +

This enum specifies what the TQComboBox should do when a new string +is entered by the user. +

activated() is always emitted when the string is entered. +

If inserting the new string would cause the combobox to breach its +content size limit, the item at the other end of the list is +deleted. The definition of "other end" is +implementation-dependent. + +

Member Function Documentation

+

TQComboBox::TQComboBox ( TQWidget * parent = 0, const char * name = 0 ) +

+Constructs a combobox widget with parent parent called name. +

This constructor creates a popup list if the program uses Motif +(or Aqua) look and feel; this is compatible with Motif 1.x and +Aqua. +

Note: If you use this constructor to create your TQComboBox, then +the pixmap() function will always return 0. To workaround this, +use the other constructor. +

+

TQComboBox::TQComboBox ( bool rw, TQWidget * parent = 0, const char * name = 0 ) +

+Constructs a combobox with a maximum size and either Motif 2.0 or +Windows look and feel. +

The input field can be edited if rw is TRUE, otherwise the user +may only choose one of the items in the combobox. +

The parent and name arguments are passed on to the TQWidget +constructor. + +

TQComboBox::~TQComboBox () +

+Destroys the combobox. + +

void TQComboBox::activated ( int index ) [signal] +

+ +

This signal is emitted when a new item has been activated +(selected). The index is the position of the item in the +combobox. +

This signal is not emitted if the item is changed +programmatically, e.g. using setCurrentItem(). + +

Examples: fileiconview/mainwindow.cpp, helpviewer/helpwindow.cpp, lineedits/lineedits.cpp, listboxcombo/listboxcombo.cpp, and qmag/qmag.cpp. +

void TQComboBox::activated ( const TQString & string ) [signal] +

+This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +

This signal is emitted when a new item has been activated +(selected). string is the selected string. +

You can also use the activated(int) signal, but be aware that its +argument is meaningful only for selected strings, not for user +entered strings. + +

bool TQComboBox::autoCompletion () const +

Returns TRUE if auto-completion is enabled; otherwise returns FALSE. +See the "autoCompletion" property for details. +

bool TQComboBox::autoResize () const +

Returns TRUE if auto resize is enabled; otherwise returns FALSE. +See the "autoResize" property for details. +

void TQComboBox::changeItem ( const TQString & t, int index ) +

+Replaces the item at position index with the text t. + +

void TQComboBox::changeItem ( const TQPixmap & im, int index ) +

+This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +

Replaces the item at position index with the pixmap im, +unless the combobox is editable. +

See also insertItem(). + +

void TQComboBox::changeItem ( const TQPixmap & im, const TQString & t, int index ) +

+This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +

Replaces the item at position index with the pixmap im and +the text t. +

See also insertItem(). + +

void TQComboBox::clear () [slot] +

+Removes all combobox items. + +

void TQComboBox::clearEdit () [slot] +

+Clears the line edit without changing the combobox's contents. +Does nothing if the combobox isn't editable. +

This is particularly useful when using a combobox as a line edit +with history. For example you can connect the combobox's +activated() signal to clearEdit() in order to present the user +with a new, empty line as soon as Enter is pressed. +

See also setEditText(). + +

void TQComboBox::clearValidator () [slot] +

+This slot is equivalent to setValidator( 0 ). + +

int TQComboBox::count () const +

Returns the number of items in the combobox. +See the "count" property for details. +

int TQComboBox::currentItem () const +

Returns the index of the current item in the combobox. +See the "currentItem" property for details. +

TQString TQComboBox::currentText () const +

Returns the text of the combobox's current item. +See the "currentText" property for details. +

bool TQComboBox::duplicatesEnabled () const +

Returns TRUE if duplicates are allowed; otherwise returns FALSE. +See the "duplicatesEnabled" property for details. +

bool TQComboBox::editable () const +

Returns TRUE if the combobox is editable; otherwise returns FALSE. +See the "editable" property for details. +

void TQComboBox::highlighted ( int index ) [signal] +

+ +

This signal is emitted when a new item has been set to be the +current item. The index is the position of the item in the +combobox. +

This signal is not emitted if the item is changed +programmatically, e.g. using setCurrentItem(). + +

void TQComboBox::highlighted ( const TQString & string ) [signal] +

+This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +

This signal is emitted when a new item has been set to be the +current item. string is the item's text. +

You can also use the highlighted(int) signal. + +

void TQComboBox::insertItem ( const TQString & t, int index = -1 ) +

+Inserts a text item with text t, at position index. The item +will be appended if index is negative. + +

Examples: chart/optionsform.cpp, fileiconview/mainwindow.cpp, helpviewer/helpwindow.cpp, lineedits/lineedits.cpp, listboxcombo/listboxcombo.cpp, regexptester/regexptester.cpp, and tictac/tictac.cpp. +

void TQComboBox::insertItem ( const TQPixmap & pixmap, int index = -1 ) +

+This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +

Inserts a pixmap item at position index. The item will be +appended if index is negative. + +

void TQComboBox::insertItem ( const TQPixmap & pixmap, const TQString & text, int index = -1 ) +

+This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +

Inserts a pixmap item with additional text text at position +index. The item will be appended if index is negative. + +

void TQComboBox::insertStrList ( const char ** strings, int numStrings = -1, int index = -1 ) +

+Inserts the array of char * strings at position index in the +combobox. +

The numStrings argument is the number of strings. If numStrings is -1 (default), the strings array must be +terminated with 0. +

Example: +

+        static const char* items[] = { "red", "green", "blue", 0 };
+        combo->insertStrList( items );
+
+ +

See also insertStringList(). + +

Example: qmag/qmag.cpp. +

void TQComboBox::insertStrList ( const TQStrList & list, int index = -1 ) +

+This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +

Inserts the list of strings at position index in the +combobox. +

This is only for compatibility since it does not support Unicode +strings. See insertStringList(). + +

void TQComboBox::insertStrList ( const TQStrList * list, int index = -1 ) +

+This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +

Inserts the list of strings at position index in the +combobox. +

This is only for compatibility since it does not support Unicode +strings. See insertStringList(). + +

void TQComboBox::insertStringList ( const TQStringList & list, int index = -1 ) +

+Inserts the list of strings at position index in the +combobox. + +

Policy TQComboBox::insertionPolicy () const +

Returns the position of the items inserted by the user. +See the "insertionPolicy" property for details. +

TQLineEdit * TQComboBox::lineEdit () const +

+Returns the line edit, or 0 if there is no line edit. +

Only editable listboxes have a line editor. + +

TQListBox * TQComboBox::listBox () const +

+Returns the current list box, or 0 if there is no list box. +(TQComboBox can use TQPopupMenu instead of TQListBox.) Provided to +match setListBox(). +

See also setListBox(). + +

Example: listboxcombo/listboxcombo.cpp. +

int TQComboBox::maxCount () const +

Returns the maximum number of items allowed in the combobox. +See the "maxCount" property for details. +

const TQPixmap * TQComboBox::pixmap ( int index ) const +

+Returns the pixmap item at position index, or 0 if the item is +not a pixmap. + +

void TQComboBox::popup () [virtual] +

+Pops up the combobox popup list. +

If the list is empty, no items appear. + +

void TQComboBox::removeItem ( int index ) +

+Removes the item at position index. + +

void TQComboBox::setAutoCompletion ( bool ) [virtual] +

Sets whether auto-completion is enabled. +See the "autoCompletion" property for details. +

void TQComboBox::setAutoResize ( bool ) [virtual] +

Sets whether auto resize is enabled. +See the "autoResize" property for details. +

void TQComboBox::setCurrentItem ( int index ) [virtual] +

Sets the index of the current item in the combobox to index. +See the "currentItem" property for details. +

void TQComboBox::setCurrentText ( const TQString & ) [virtual] +

Sets the text of the combobox's current item. +See the "currentText" property for details. +

void TQComboBox::setDuplicatesEnabled ( bool enable ) +

Sets whether duplicates are allowed to enable. +See the "duplicatesEnabled" property for details. +

void TQComboBox::setEditText ( const TQString & newText ) [virtual slot] +

+Sets the text in the line edit to newText without changing the +combobox's contents. Does nothing if the combobox isn't editable. +

This is useful e.g. for providing a good starting point for the +user's editing and entering the change in the combobox only when +the user presses Enter. +

See also clearEdit() and insertItem(). + +

void TQComboBox::setEditable ( bool ) +

Sets whether the combobox is editable. +See the "editable" property for details. +

void TQComboBox::setFont ( const TQFont & font ) [virtual] +

+Sets the font for both the combobox button and the combobox popup +list to font. + +

Reimplemented from TQWidget. +

void TQComboBox::setInsertionPolicy ( Policy policy ) [virtual] +

Sets the position of the items inserted by the user to policy. +See the "insertionPolicy" property for details. +

void TQComboBox::setLineEdit ( TQLineEdit * edit ) [virtual] +

+Sets the line edit to use edit instead of the current line edit. + +

void TQComboBox::setListBox ( TQListBox * newListBox ) [virtual] +

+Sets the combobox to use newListBox instead of the current list +box or popup. As a side effect, it clears the combobox of its +current contents. +

Warning: TQComboBox assumes that newListBox->text(n) returns +non-null for 0 <= n < newListbox->count(). This assumption is +necessary because of the line edit in TQComboBox. + +

void TQComboBox::setMaxCount ( int ) [virtual] +

Sets the maximum number of items allowed in the combobox. +See the "maxCount" property for details. +

void TQComboBox::setPalette ( const TQPalette & palette ) [virtual] +

+Sets the palette for both the combobox button and the combobox +popup list to palette. + +

Reimplemented from TQWidget. +

void TQComboBox::setSizeLimit ( int ) [virtual] +

Sets the maximum on-screen size of the combobox. +See the "sizeLimit" property for details. +

void TQComboBox::setValidator ( const TQValidator * v ) [virtual] +

+Applies the validator v to the combobox so that only text which +is valid according to v is accepted. +

This function does nothing if the combobox is not editable. +

See also validator(), clearValidator(), and TQValidator. + +

int TQComboBox::sizeLimit () const +

Returns the maximum on-screen size of the combobox. +See the "sizeLimit" property for details. +

TQString TQComboBox::text ( int index ) const +

+Returns the text item at position index, or TQString::null if +the item is not a string. +

See also currentText. + +

Examples: fileiconview/mainwindow.cpp and helpviewer/helpwindow.cpp. +

void TQComboBox::textChanged ( const TQString & string ) [signal] +

+ +

This signal is used for editable comboboxes. It is emitted +whenever the contents of the text entry field changes. string +contains the new text. + +

const TQValidator * TQComboBox::validator () const +

+Returns the validator which constrains editing for this combobox +if there is one; otherwise returns 0. +

See also setValidator(), clearValidator(), and TQValidator. + +

Property Documentation

+

bool autoCompletion

+

This property holds whether auto-completion is enabled. +

This property can only be set for editable comboboxes, for +non-editable comboboxes it has no effect. It is FALSE by default. + +

Set this property's value with setAutoCompletion() and get this property's value with autoCompletion(). +

bool autoMask

+

This property holds whether the combobox is automatically masked. +

See also TQWidget::autoMask. + +

bool autoResize

This property holds whether auto resize is enabled. +

This property is obsolete. It is provided to keep old source working. We strongly advise against using it in new code. +

If this property is set to TRUE then the combobox will resize itself +whenever its contents change. The default is FALSE. + +

Set this property's value with setAutoResize() and get this property's value with autoResize(). +

int count

+

This property holds the number of items in the combobox. +

+

Get this property's value with count(). +

int currentItem

+

This property holds the index of the current item in the combobox. +

Note that the activated() and highlighted() signals are only +emitted when the user changes the current item, not when it is +changed programmatically. + +

Set this property's value with setCurrentItem() and get this property's value with currentItem(). +

TQString currentText

+

This property holds the text of the combobox's current item. +

+

Set this property's value with setCurrentText() and get this property's value with currentText(). +

bool duplicatesEnabled

+

This property holds whether duplicates are allowed. +

If the combobox is editable and the user enters some text in the +combobox's lineedit and presses Enter (and the insertionPolicy() +is not NoInsertion), then what happens is this: +

+

This property only affects user-interaction. You can use +insertItem() to insert duplicates if you wish regardless of this +setting. + +

Set this property's value with setDuplicatesEnabled() and get this property's value with duplicatesEnabled(). +

bool editable

+

This property holds whether the combobox is editable. +

This property's default is FALSE. Note that the combobox will be +cleared if this property is set to TRUE for a 1.x Motif style +combobox. To avoid this, use setEditable() before inserting any +items. Also note that the 1.x version of Motif didn't have any +editable comboboxes, so the combobox will change it's appearance +to a 2.0 style Motif combobox is it is set to be editable. + +

Set this property's value with setEditable() and get this property's value with editable(). +

Policy insertionPolicy

+

This property holds the position of the items inserted by the user. +

The default insertion policy is AtBottom. See Policy. + +

Set this property's value with setInsertionPolicy() and get this property's value with insertionPolicy(). +

int maxCount

+

This property holds the maximum number of items allowed in the combobox. +

+

Set this property's value with setMaxCount() and get this property's value with maxCount(). +

int sizeLimit

+

This property holds the maximum on-screen size of the combobox. +

This property is ignored for both Motif 1.x style and non-editable +comboboxes in Mac style. The default limit is ten +lines. If the number of items in the combobox is or grows larger +than lines, a scrollbar is added. + +

Set this property's value with setSizeLimit() and get this property's value with sizeLimit(). + +

+This file is part of the TQt toolkit. +Copyright © 1995-2007 +Trolltech. All Rights Reserved.

+ +
Copyright © 2007 +TrolltechTrademarks +
TQt 3.3.8
+
+ -- cgit v1.2.1