STLSoft - ... Robust, Lightweight, Cross-platform, Template Software ... ATLSTL - Template Software for the Active Template Library COMSTL - The Standard Template Library meets the Component Object Model .netSTL - Standard Template Library meets the Microsoft.NET Common Language Runtime InetSTL - The Standard Template Library meets WinInet MFCSTL - Template Software for the Microsoft Foundation Classes UNIXSTL - Template Software for the UNIX Operating System WinSTL - where the Standard Template Library meets the Win32 API

Main Page   Modules   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

clipboard_format_sequence Class Reference

This class provides an STL-like sequence for iterating the clipboard formats for the current process. More...

#include <winstl_clipboard_format_sequence.h>

List of all members.

Public Types

typedef clipboard_format_sequence class_type
 The type.

typedef UINT value_type
 The value type.

typedef ws_size_t size_type
 The size type.

typedef ws_ptrdiff_t difference_type
 The difference type.


Public Methods

Construction
 clipboard_format_sequence ()
 Constructs a sequence object, attempting to open the clipboard.

 ~clipboard_format_sequence ()
 Release any resources aquired.

Iteration
const_iterator begin () const
 Begins the iteration.

const_iterator end () const
 Ends the iteration.

ws_bool_t empty () const
 Indicates whether the search sequence is empty.

size_type size () const
 Returns the number of elements in the sequence.

ws_bool_t inaccessible () const
 Indicates whether the search sequence is valid.


Detailed Description

This class provides an STL-like sequence for iterating the clipboard formats for the current process.


Member Typedef Documentation

typedef clipboard_format_sequence class_type
 

The type.

typedef ws_ptrdiff_t difference_type
 

The difference type.

typedef ws_size_t size_type
 

The size type.

typedef UINT value_type
 

The value type.


Constructor & Destructor Documentation

clipboard_format_sequence   [inline]
 

Constructs a sequence object, attempting to open the clipboard.

~clipboard_format_sequence   [inline]
 

Release any resources aquired.


Member Function Documentation

const_iterator begin   const [inline]
 

Begins the iteration.

Returns:
An iterator representing the start of the sequence

ws_bool_t empty   const [inline]
 

Indicates whether the search sequence is empty.

const_iterator end   const [inline]
 

Ends the iteration.

Returns:
An iterator representing the end of the sequence

ws_bool_t inaccessible   const [inline]
 

Indicates whether the search sequence is valid.

Note:
The sequence may not be able to access the clipboard formats if another window is currently holding the clipboard via a call to OpenClipboard()

size_type size   const [inline]
 

Returns the number of elements in the sequence.


The documentation for this class was generated from the following file:

STLSoft Libraries documentation © Synesis Software Pty Ltd, 2001-2004