From 0881ed5059c46ce73e8241e6260b82b92f6d0e55 Mon Sep 17 00:00:00 2001 From: Michele Calgaro Date: Thu, 6 Jun 2024 12:20:38 +0900 Subject: Rename ptr nt* related files to equivalent tq* Signed-off-by: Michele Calgaro --- doc/html/tqptrlistiterator.html | 234 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 234 insertions(+) create mode 100644 doc/html/tqptrlistiterator.html (limited to 'doc/html/tqptrlistiterator.html') diff --git a/doc/html/tqptrlistiterator.html b/doc/html/tqptrlistiterator.html new file mode 100644 index 00000000..555aa4d8 --- /dev/null +++ b/doc/html/tqptrlistiterator.html @@ -0,0 +1,234 @@ + + + + + +TQPtrListIterator Class + + + + + + + +

TQPtrListIterator Class Reference

+ +

The TQPtrListIterator class provides an iterator for +TQPtrList collections. +More... +

#include <tqptrlist.h> +

Inherited by TQObjectListIterator and TQStrListIterator. +

List of all member functions. +

Public Members

TQPtrListIterator ( const TQPtrList<type> & list )
~TQPtrListIterator ()
uint count () const
bool isEmpty () const
bool atFirst () const
bool atLast () const
type * toFirst ()
type * toLast ()
operator type * () const
type * operator* ()
type * current () const
type * operator() ()
type * operator++ ()
type * operator+= ( uint jump )
type * operator-- ()
type * operator-= ( uint jump )
TQPtrListIterator<type> & operator= ( const TQPtrListIterator<type> & it )

Detailed Description

+ + +The TQPtrListIterator class provides an iterator for +TQPtrList collections. +

+ +

Define a template instance TQPtrListIterator<X> to create a list +iterator that operates on TQPtrList<X> (list of X*). +

The following example is similar to the example in the TQPtrList class documentation, but it uses TQPtrListIterator. The class Employee is +defined there. +

+    TQPtrList<Employee> list;
+
+    list.append( new Employee("John", "Doe", 50000) );
+    list.append( new Employee("Jane", "Williams", 80000) );
+    list.append( new Employee("Tom", "Jones", 60000) );
+
+    TQPtrListIterator<Employee> it( list );
+    Employee *employee;
+    while ( (employee = it.current()) != 0 ) {
+        ++it;
+        cout << employee->surname().latin1() << ", " <<
+                employee->forename().latin1() << " earns " <<
+                employee->salary() << endl;
+    }
+

+ +

The output is +

+    Doe, John earns 50000
+    Williams, Jane earns 80000
+    Jones, Tom earns 60000
+

+ +

Using a list iterator is a more robust way of traversing the list +than using the TQPtrList member functions first(), next(), current(), etc., as many iterators can +traverse the same list independently. +

An iterator has its own current list item and can get the next and +previous list items. It doesn't modify the list in any way. +

When an item is removed from the list, all iterators that point to +that item are updated to point to TQPtrList::current() instead to +avoid dangling references. +

See also TQPtrList, Collection Classes, and Non-GUI Classes. + +

Member Function Documentation

TQPtrListIterator::TQPtrListIterator ( const TQPtrList<type> & list ) +

+ +

Constructs an iterator for list. The current iterator item is +set to point on the first item in the list. + +

TQPtrListIterator::~TQPtrListIterator () +

+ +

Destroys the iterator. + +

bool TQPtrListIterator::atFirst () const +

+ +

Returns TRUE if the current iterator item is the first list item; +otherwise returns FALSE. +

bool TQPtrListIterator::atLast () const +

+ +

Returns TRUE if the current iterator item is the last list item; +otherwise returns FALSE. +

uint TQPtrListIterator::count () const +

+ +

Returns the number of items in the list this iterator operates on. +

type * TQPtrListIterator::current () const +

+ +

Returns a pointer to the current iterator item. If the iterator is +positioned before the first item in the list or after the last +item in the list, 0 is returned. + +

Examples: canvas/canvas.cpp, customlayout/card.cpp, and customlayout/flow.cpp. +

bool TQPtrListIterator::isEmpty () const +

+ +

Returns TRUE if the list is empty; otherwise returns FALSE. +

TQPtrListIterator::operator type * () const +

+ +

Cast operator. Returns a pointer to the current iterator item. +Same as current(). + +

type * TQPtrListIterator::operator() () +

+ +

Makes the succeeding item current and returns the original current +item. +

If the current iterator item was the last item in the list or if +it was 0, 0 is returned. + +

type * TQPtrListIterator::operator* () +

+ +

Asterisk operator. Returns a pointer to the current iterator item. +Same as current(). + +

type * TQPtrListIterator::operator++ () +

+ +

Prefix ++ makes the succeeding item current and returns the new +current item. +

If the current iterator item was the last item in the list or if +it was 0, 0 is returned. + +

type * TQPtrListIterator::operator+= ( uint jump ) +

+ +

Sets the current item to the item jump positions after the +current item and returns a pointer to that item. +

If that item is beyond the last item or if the list is empty, it +sets the current item to 0 and returns 0 + +

type * TQPtrListIterator::operator-- () +

+ +

Prefix - makes the preceding item current and returns the new +current item. +

If the current iterator item was the first item in the list or if +it was 0, 0 is returned. + +

type * TQPtrListIterator::operator-= ( uint jump ) +

+ +

Returns the item jump positions before the current item or 0 +if it is beyond the first item. Makes this the current item. + +

TQPtrListIterator<type> & TQPtrListIterator::operator= ( const TQPtrListIterator<type> & it ) +

+ +

Assignment. Makes a copy of the iterator it and returns a +reference to this iterator. + +

type * TQPtrListIterator::toFirst () +

+ +

Sets the current iterator item to point to the first list item and +returns a pointer to the item. Sets the current item to 0 and +returns 0 if the list is empty. +

type * TQPtrListIterator::toLast () +

+ +

Sets the current iterator item to point to the last list item and +returns a pointer to the item. Sets the current item to 0 and +returns 0 if the list is empty. +