Classes | Public Member Functions

pl7::console::HintBox Class Reference

#include <HintBox.h>

Inheritance diagram for pl7::console::HintBox:
fl7::faces::Popup fl7::faces::Window fl7::faces::Fusion fl7::faces::Collection fl7::faces::Face

List of all members.

Classes

struct  HintData

Public Member Functions

size_t GetHintCount () const
signed GetSelectedIndex () const
void SetSelectedIndex (signed index)
const cl7::string_typeGetSelectedHint () const
const cl7::string_typeGetHint (signed index) const
void UpdateAndOpen ()
void SelectNext ()
void SelectPrev ()
void CommitSelectedHint ()

Detailed Description

The popup window class providing certain hints for the (debug) console.


Member Function Documentation

void pl7::console::HintBox::CommitSelectedHint (  ) 

Commits the currently selected hint to the console input (if any hint selected).

const cl7::string_type & pl7::console::HintBox::GetHint ( signed  index  )  const

Returns the "content" of the hint with the given index.

size_t pl7::console::HintBox::GetHintCount (  )  const [inline]

Returns the number of provided hints.

const cl7::string_type & pl7::console::HintBox::GetSelectedHint (  )  const

Returns the "content" of the currently selected hint.

signed pl7::console::HintBox::GetSelectedIndex (  )  const [inline]

Returns the index of the currently selected hint (or -1).

void pl7::console::HintBox::SelectNext (  ) 

Selects the next hint (or the first one, if none selected).

void pl7::console::HintBox::SelectPrev (  ) 

Selects the previous hint (or the last one, if none selected).

void pl7::console::HintBox::SetSelectedIndex ( signed  index  ) 

Sets the index of the currently selected hint (or -1).

void pl7::console::HintBox::UpdateAndOpen (  ) 

Updates the content of this hint box and shows it (if any hints provided).


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines