AIFileDialogFilters Struct Reference

These functions manage a collection of file type specifiers for dialog functions in AIUserSuite, which show drop-down lists for each file type. More...

#include <AIUser.h>

List of all members.

Public Member Functions
void	AddFilter (const ai::UnicodeString &desc)
	Adds a file-type filter with default pattern (*.
void	AddFilter (const ai::UnicodeString &desc, const ai::UnicodeString &pattern)
	Adds a file-type filter with a UnicodeString pattern.
const ai::UnicodeString &	GetFilter () const
	Retrieves a single string containing type descriptions and patterns.

---

Detailed Description

These functions manage a collection of file type specifiers for dialog functions in AIUserSuite, which show drop-down lists for each file type.

---

Member Function Documentation

void AIFileDialogFilters::AddFilter	(	const ai::UnicodeString &	desc,
		const ai::UnicodeString &	pattern
	)			[inline]

Adds a file-type filter with a UnicodeString pattern.

(Note that this function does not return an error code.)

Parameters:

	desc	Description of file type.
	pattern	One or more Windows wildcard patterns to filter for the file type, separated with semicolons (;). For example, Addfilter("JPEG Files", "*.jpg;*.jpeg");

References ai::UnicodeString::append(), ai::UnicodeString::empty(), ai::UnicodeString::erase(), and ai::UnicodeString::length().

void AIFileDialogFilters::AddFilter

(

const ai::UnicodeString &

desc

)

[inline]

Adds a file-type filter with default pattern (*.

*) (Note that this function does not return an error code.)

Parameters:

desc

Description of file type.

const ai::UnicodeString & AIFileDialogFilters::GetFilter

(

)

const [inline]

Retrieves a single string containing type descriptions and patterns.

(Note that this function returns a string value, not an error code.)

Returns:

A string containing a series of null-delimited descriptions and patterns, terminated by a double-null. For example: "first description\0first pattern\0...last description\0last pattern\0\0"

---

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

• AIUser.h