AnyConnect Secure Mobility Client
4.10.06090
PreferenceInfo.h
1
/**************************************************************************
2
* Copyright © 2008, Cisco Systems, All Rights Reserved
3
***************************************************************************
4
*
5
* File: PreferenceInfo.h
6
* Date: 07/2008
7
*
8
***************************************************************************
9
*
10
* Preference Info class declaration for the Client API.
11
*
12
***************************************************************************/
13
14
#ifndef _PREFERENCEINFO_
15
#define _PREFERENCEINFO_
16
17
18
/**
19
* Class representing a collection of preferences that are grouped together.
20
* Provides the ability to retrieve an ordered list of preferences, as well as
21
* as a generic heading that describes this grouping of preferences.
22
*/
23
24
#include "PreferenceInfoBase.h"
25
26
27
class
VPN_VPNAPI
PreferenceInfo
:
public
PreferenceInfoBase
28
{
29
30
public
:
31
32
/**
33
* This method returns the count of any available Preference objects
34
* (both parent and child).
35
*/
36
unsigned
int
countPreferences
()
const
;
37
38
39
/**
40
* If there exists a Preference with the passed ::PreferenceId, returns
41
* a pointer to that Preference object in the passed rpPreference pointer.
42
* Returns false if no such preference could be found.
43
*/
44
bool
getPreference
(
const
PreferenceId
& preferenceId,
45
OUT
Preference
*& rpPreference)
const
;
46
47
48
/**
49
* Returns a vector of preferences. The order is significant, and
50
* represents the visual order with which prompts should be displayed.
51
* To access the child preferences of the returned preferences use
52
* Preference::getChildren()
53
*/
54
const
std::vector<Preference*>&
getListPreferences
()
const
;
55
56
57
/**
58
* Returns a string that describes the contents of this PreferenceInfo.
59
* User Interfaces should display this string at the top of the dialog
60
* or screen used to display preference controls/widgets.
61
*/
62
const
tstring
getPreferenceHeading
()
const
;
63
64
65
PreferenceInfo
();
66
};
67
68
#endif // _PREFERENCEINFO_
PreferenceInfo::getPreferenceHeading
const tstring getPreferenceHeading() const
PreferenceId
PreferenceId
Definition:
api.h:275
PreferenceInfo::countPreferences
unsigned int countPreferences() const
PreferenceInfo::getPreference
bool getPreference(const PreferenceId &preferenceId, OUT Preference *&rpPreference) const
tstring
#define tstring
Definition:
api.h:35
PreferenceInfo::getListPreferences
const std::vector< Preference * > & getListPreferences() const
Preference
Definition:
Preference.h:29
PreferenceInfoBase
Definition:
PreferenceInfoBase.h:39
PreferenceInfo
Definition:
PreferenceInfo.h:28
AnyConnect C++ API Documentation by
Cisco Systems