Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
CGUIViewControl Class Reference

#include <GUIViewControl.h>

Public Member Functions

 CGUIViewControl ()
 
virtual ~CGUIViewControl ()
 
void Reset ()
 
void SetParentWindow (int window)
 
void AddView (const CGUIControl *control)
 
void SetViewControlID (int control)
 
void SetCurrentView (int viewMode, bool bRefresh=false)
 
void SetItems (CFileItemList &items)
 
void SetSelectedItem (int item)
 
void SetSelectedItem (const std::string &itemPath)
 
int GetSelectedItem () const
 
std::string GetSelectedItemPath () const
 
void SetFocused ()
 
bool HasControl (int controlID) const
 
int GetNextViewMode (int direction=1) const
 
int GetViewModeNumber (int number) const
 
int GetViewModeCount () const
 
int GetViewModeByID (int id) const
 
int GetCurrentControl () const
 
void Clear ()
 

Protected Types

typedef std::vector< CGUIControl * >::const_iterator ciViews
 

Protected Member Functions

int GetSelectedItem (const CGUIControl *control) const
 
void UpdateContents (const CGUIControl *control, int currentItem) const
 
void UpdateView ()
 
void UpdateViewAsControl (const std::string &viewLabel)
 
void UpdateViewVisibility ()
 
int GetView (VIEW_TYPE type, int id) const
 

Protected Attributes

std::vector< CGUIControl * > m_allViews
 
std::vector< CGUIControl * > m_visibleViews
 
CFileItemListm_fileItems
 
int m_viewAsControl
 
int m_parentWindow
 
int m_currentView
 

Member Typedef Documentation

◆ ciViews

typedef std::vector<CGUIControl*>::const_iterator CGUIViewControl::ciViews
protected

Constructor & Destructor Documentation

◆ CGUIViewControl()

CGUIViewControl::CGUIViewControl ( void )

◆ ~CGUIViewControl()

CGUIViewControl::~CGUIViewControl ( )
virtualdefault

Member Function Documentation

◆ AddView()

void CGUIViewControl::AddView ( const CGUIControl * control)

◆ Clear()

void CGUIViewControl::Clear ( )

◆ GetCurrentControl()

int CGUIViewControl::GetCurrentControl ( ) const

◆ GetNextViewMode()

int CGUIViewControl::GetNextViewMode ( int direction = 1) const

◆ GetSelectedItem() [1/2]

int CGUIViewControl::GetSelectedItem ( ) const

◆ GetSelectedItem() [2/2]

int CGUIViewControl::GetSelectedItem ( const CGUIControl * control) const
protected

◆ GetSelectedItemPath()

std::string CGUIViewControl::GetSelectedItemPath ( ) const

◆ GetView()

int CGUIViewControl::GetView ( VIEW_TYPE type,
int id ) const
protected

◆ GetViewModeByID()

int CGUIViewControl::GetViewModeByID ( int id) const

◆ GetViewModeCount()

int CGUIViewControl::GetViewModeCount ( ) const

◆ GetViewModeNumber()

int CGUIViewControl::GetViewModeNumber ( int number) const

◆ HasControl()

bool CGUIViewControl::HasControl ( int controlID) const

◆ Reset()

void CGUIViewControl::Reset ( )

◆ SetCurrentView()

void CGUIViewControl::SetCurrentView ( int viewMode,
bool bRefresh = false )

◆ SetFocused()

void CGUIViewControl::SetFocused ( )

◆ SetItems()

void CGUIViewControl::SetItems ( CFileItemList & items)

◆ SetParentWindow()

void CGUIViewControl::SetParentWindow ( int window)

◆ SetSelectedItem() [1/2]

void CGUIViewControl::SetSelectedItem ( const std::string & itemPath)

◆ SetSelectedItem() [2/2]

void CGUIViewControl::SetSelectedItem ( int item)

◆ SetViewControlID()

void CGUIViewControl::SetViewControlID ( int control)

◆ UpdateContents()

void CGUIViewControl::UpdateContents ( const CGUIControl * control,
int currentItem ) const
protected

◆ UpdateView()

void CGUIViewControl::UpdateView ( )
protected

◆ UpdateViewAsControl()

void CGUIViewControl::UpdateViewAsControl ( const std::string & viewLabel)
protected

◆ UpdateViewVisibility()

void CGUIViewControl::UpdateViewVisibility ( )
protected

Member Data Documentation

◆ m_allViews

std::vector<CGUIControl*> CGUIViewControl::m_allViews
protected

◆ m_currentView

int CGUIViewControl::m_currentView
protected

◆ m_fileItems

CFileItemList* CGUIViewControl::m_fileItems
protected

◆ m_parentWindow

int CGUIViewControl::m_parentWindow
protected

◆ m_viewAsControl

int CGUIViewControl::m_viewAsControl
protected

◆ m_visibleViews

std::vector<CGUIControl*> CGUIViewControl::m_visibleViews
protected

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