atlstl Namespace Reference


Detailed Description

The atlstl namespace contains all components in the ATLSTL project.

By default, the atlstl namespace is actually an alias for the namespace stlsoft::atlstl_project, which is where all the ATLSTL components actually reside. This measure allows all components within the main the STLSoft project (which are defined within the stlsoft namespace) to be visible to all components "within" the atlstl namespace. (Otherwise, there would be a whole lot of onerous qualification throughout the code of all sub-projects.)

Note:
If either/both of the symbols _STLSOFT_NO_NAMESPACES and _ATLSTL_NO_NAMESPACE are defined, all ATLSTL components will be defined in the global namespace. Conversely, if the _STLSOFT_NO_NAMESPACE symbol (not to be confused with the _STLSOFT_NO_NAMESPACES symbol!) is defined - meaning that all main project components are to be defined in the global namespace, and _ATLSTL_NO_NAMESPACE is not defined, then all ATLSTL components will be defined within a bona fide atlstl namespace.

This is a vestige of compatibility with compilers with no (or no sensible) namespace support that is maintained for reasons of backwards compatiblity and because it is, in rare circumstances, a useful facility.


Classes

class  generic_collection_base
class  generic_automation_collection
 Class for defining COM Automation collections. More...
struct  copy_policy
 A policy that indicates that values should be copied between internal and external representations in the enumerator. More...
class  copy_enumerator
 Modifiable, copying enumerator class template. More...
class  IDispatchImpl2
 Class template that enables the methods and properties exhibited through two IDispatch interfaces to be visible to scripting clients. More...
class  IDispatchImpl3
 Class template that enables the methods and properties exhibited through three IDispatch interfaces to be visible to scripting clients. More...
class  IDispatchImpl4
 Class template that enables the methods and properties exhibited through four IDispatch interfaces to be visible to scripting clients. More...
class  SupportErrorInfoImpl
 Provides implementation of ISupportErrorInfo for support for errors on one interface. More...
class  SupportErrorInfoImpl2
 Provides implementation of ISupportErrorInfo for support for errors on two interfaces. More...
class  SupportErrorInfoImpl3
 Provides implementation of ISupportErrorInfo for support for errors on three interfaces. More...
class  SupportErrorInfoImpl4
 Provides implementation of ISupportErrorInfo for support for errors on four interfaces. More...
class  SupportErrorInfoImpl5
 Provides implementation of ISupportErrorInfo for support for errors on five interfaces. More...
struct  c_str_ptr_null_CWindow_proxy
 This class provides an intermediary object that may be returned by the c_str_ptr_null() function, such that the window text of a given window may be accessed as a null-terminated string. More...
struct  c_str_ptr_CWindow_proxy
 This class provides an intermediary object that may be returned by the c_str_ptr() function, such that the window text of a given window may be accessed as a null-terminated string. More...
class  ccombstr_veneer
 Applies standard string (std::basic_string) interface to the CComBSTR class. More...
class  module_scope
 Scopes the initialisation and uninitialisation of an ATL module. More...
struct  IDD_to_type
 Turns an integral value into a type. More...
class  AboutDialog
 About dialog class based on a type that specifies an Id, and a parent window type. More...
class  AboutDialogId
 About dialog class based from an Id. More...
class  EnhancedWindow
 This template is a veneer that provides various useful (and usually missing) member functions of dialogs and parent windows. More...
class  Window
 This class inherits from ATL's CWindow, and provides enhanced string operations (using string access shims) and additional functionality (via the EnhancedWindow mixin class template). More...

Functions

bool InlineIsEqualGUID (REFGUID rguid1, REFGUID rguid2)
 This function is needed since there are ambiguities between COM headers and ATL headers.
template<typename I1, typename I2, typename I3>
LPUNKNOWN get_clone (I1 *instance, HRESULT(STDAPICALLTYPE I3::*pfn)(I2 **), HRESULT &hr)
template<class C, typename T>
HRESULT get_MemberValue (C *const cls, T *ret, T C::*mem)
 Inline retrieval of member variable value.
template<class C, typename T>
HRESULT get_MemberValue (C *const cls, T **ret, T *C::*mem)
 Ghost overload to prevent use of get_MemberValue with pointer types.
template<class C>
HRESULT get_MemberValue (C *const cls, BSTR *ret, CComBSTR C::*mem)
 Inline retrieval of a CComBSTR member variable value.
template<class C>
HRESULT get_MemberValue (C *const cls, VARIANT *ret, CComVariant C::*mem)
 Inline retrieval of a VARIANT member variable value.
template<class C, typename T, typename T2>
HRESULT get_MemberValue (C *const cls, T *ret, T2(C::*pfn)() const)
 Inline retrieval of method value.
template<typename C, typename T>
HRESULT put_MemberValue (C *const cls, T const &newVal, T C::*mem)
 Inline assignment of a member variable value.
template<typename C>
HRESULT put_MemberValue (C *const cls, BSTR newVal, CComBSTR C::*mem)
 Inline assignment of a CComBSTR member variable value.
template<typename C>
HRESULT put_MemberValue (C *const cls, CComBSTR const &newVal, CComBSTR C::*mem)
 Inline assignment of a CComBSTR member variable value.
template<typename C>
HRESULT put_MemberValue (C *const cls, CComVariant const &newVal, CComVariant C::*mem)
 Inline assignment of a CComVariant member variable value.
template<typename T1, typename T2>
HRESULT get_ConstantValue (T1 *ret, T2 const &value)
 Shorthand for implementing methods that return a constant value.
LPCOLESTR c_str_data (atlstl_ns_qual_atl(CComBSTR) const &s)
 c_str_data String Access Shim for CComBSTR
size_t c_str_len (atlstl_ns_qual_atl(CComBSTR) const &s)
 c_str_len String Access Shim for CComBSTR
LPCOLESTR c_str_ptr (atlstl_ns_qual_atl(CComBSTR) const &s)
 c_str_ptr String Access Shim for CComBSTR
LPCOLESTR c_str_ptr_null (atlstl_ns_qual_atl(CComBSTR) const &s)
 c_str_ptr_null String Access Shim for CComBSTR
bool operator== (LPCTSTR lhs, c_str_ptr_null_CWindow_proxy const &rhs)
bool operator== (c_str_ptr_null_CWindow_proxy const &lhs, LPCTSTR rhs)
bool operator!= (LPCTSTR lhs, c_str_ptr_null_CWindow_proxy const &rhs)
bool operator!= (c_str_ptr_null_CWindow_proxy const &lhs, LPCTSTR rhs)
template<typename S>
S & operator<< (S &s, c_str_ptr_null_CWindow_proxy const &shim)
template<typename S>
S & operator<< (S &s, c_str_ptr_CWindow_proxy const &shim)
c_str_ptr_CWindow_proxy c_str_data (atlstl_ns_qual_atl(CWindow) const &w)
 c_str_data String Access Shim for CWindow
size_t c_str_len (atlstl_ns_qual_atl(CWindow) const &w)
 c_str_len String Access Shim for CWindow
c_str_ptr_CWindow_proxy c_str_ptr (atlstl_ns_qual_atl(CWindow) const &w)
 c_str_ptr String Access Shim for CWindow
c_str_ptr_null_CWindow_proxy c_str_ptr_null (atlstl_ns_qual_atl(CWindow) const &w)
 c_str_ptr_null String Access Shim for CWindow
HWND get_HWND (CWindow const &w)
 Access the HWND of the given CWindow instance.
bool operator== (ccombstr_veneer const &lhs, ccombstr_veneer const &rhs)
bool operator== (LPCSTR lhs, ccombstr_veneer const &rhs)
bool operator== (ccombstr_veneer const &lhs, LPCSTR rhs)
bool operator== (LPCWSTR lhs, ccombstr_veneer const &rhs)
bool operator== (ccombstr_veneer const &lhs, LPCWSTR rhs)
bool operator!= (ccombstr_veneer const &lhs, ccombstr_veneer const &rhs)
bool operator!= (LPCSTR lhs, ccombstr_veneer const &rhs)
bool operator!= (ccombstr_veneer const &lhs, LPCSTR rhs)
bool operator!= (LPCWSTR lhs, ccombstr_veneer const &rhs)
bool operator!= (ccombstr_veneer const &lhs, LPCWSTR rhs)
void swap (ccombstr_veneer &lhs, ccombstr_veneer &rhs)
LPCOLESTR c_str_data (atlstl_ns_qual(ccombstr_veneer) const &str)
 c_str_data String Access Shim for comstl::ccombstr_veneer
size_t c_str_len (atlstl_ns_qual(ccombstr_veneer) const &str)
 c_str_len String Access Shim for comstl::ccombstr_veneer
LPCOLESTR c_str_ptr (atlstl_ns_qual(ccombstr_veneer) const &str)
 c_str_ptr String Access Shim for comstl::ccombstr_veneer
LPCOLESTR c_str_ptr_null (atlstl_ns_qual(ccombstr_veneer) const &str)
 c_str_ptr_null String Access Shim for comstl::ccombstr_veneer
template<typename S>
S & operator<< (S &s, atlstl_ns_qual(ccombstr_veneer) const &str)
 stream insertion shim for comstl::ccombstr_veneer


Function Documentation

HWND atlstl::get_HWND ( CWindow const &  w  )  [inline]

Access the HWND of the given CWindow instance.

This access shim retrieves the HWND window handle for the given CWindow instance.

Parameters:
w A reference to the CWindow instance whose HWND will be retrieved
Returns:
The HWND corresponding to the given CWindow instance w

bool atlstl::InlineIsEqualGUID ( REFGUID  rguid1,
REFGUID  rguid2 
) [inline]

This function is needed since there are ambiguities between COM headers and ATL headers.


Generated on Thu Jun 10 08:58:23 2010 for STLSoft by  doxygen 1.5.6