CBSuggest Class Reference

Enum value for YCPCallaback response (PROCEED, RETRY, SKIP, CANCEL). More...

#include <PMCallbacks.h>

List of all members.

Public Types
enum	Action { PROCEED, RETRY, SKIP, CANCEL }
Public Member Functions
	CBSuggest (const Action &action_r=PROCEED)
	CBSuggest (const std::string &str_r)
	operator const Action & () const
Private Attributes
Action	action
Friends
std::ostream &	operator<< (std::ostream &str, const CBSuggest &obj)
std::ostream &	operator<< (std::ostream &str, const Action &obj)

---

Detailed Description

Enum value for YCPCallaback response (PROCEED, RETRY, SKIP, CANCEL).

CBSuggest is nothing more than an enum value of CBSuggest::Action. The only purpose for wraping it into a class is the construction from a std::string.

Use PROCEED if you've got no special suggestion.

---

Member Enumeration Documentation

enum CBSuggest::Action

Action values Enumerator: PROCEED  RETRY  SKIP  CANCEL

---

Constructor & Destructor Documentation

CBSuggest::CBSuggest (  const Action &  action_r = PROCEED  )  [inline]

Constructor. Defaults to PROCEED.

CBSuggest::CBSuggest (  const std::string &  str_r  )  [explicit]

Constructor. You may use any unique abbreviation of an enum value in upper, lower or mixed case. Empty or unknown values default to PROCEED.

---

Member Function Documentation

CBSuggest::operator const Action & (   )  const [inline]

Conversion to Action value.

---

Friends And Related Function Documentation

std::ostream& operator<< (  std::ostream &  str, const Action &  obj )  [friend]

std::ostream& operator<< (  std::ostream &  str, const CBSuggest &  obj )  [friend]

---

Member Data Documentation

Action CBSuggest::action [private]

Action value

---

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

• PMCallbacks.h

---