GUI::SelectHymnWindow Class Reference

A window where a hymn can be selected. More...

#include <SelectHymnWindow.hpp>

Public Member Functions
	SelectHymnWindow ()
	Constructor. More...
void	Scan ()
	Scan the save directory for hymns. More...
void	Show ()
	Show the window and let the user select a hymn. More...
void	SetClosedCallback (const std::function< void(const std::string &)> &callback)
	Set function to call when closed. More...
bool	IsVisible () const
	Get whether the window is visible. More...
void	SetVisible (bool visible)
	Set whether the window should be visible. More...
void	SetTitle (const char *title)
	Set window title. More...
void	SetOpenButtonName (const char *openButtonName)
	Set the name of the open button. More...

Detailed Description

A window where a hymn can be selected.

Constructor & Destructor Documentation

SelectHymnWindow()

SelectHymnWindow::SelectHymnWindow

(

)

Constructor.

Member Function Documentation

IsVisible()

bool SelectHymnWindow::IsVisible

(

)

const

Get whether the window is visible.

Returns

Whether the window is visible.

Scan()

void SelectHymnWindow::Scan

(

)

Scan the save directory for hymns.

SetClosedCallback()

void SelectHymnWindow::SetClosedCallback

(

const std::function< void(const std::string &)> &

callback

)

Set function to call when closed.

Parameters

callback

Function to call when window is closed.

SetOpenButtonName()

void SelectHymnWindow::SetOpenButtonName

(

const char *

openButtonName

)

Set the name of the open button.

Parameters

openButtonName

The name of the open button.

SetTitle()

void SelectHymnWindow::SetTitle

(

const char *

title

)

Set window title.

Parameters

title

Window title.

SetVisible()

void SelectHymnWindow::SetVisible

(

bool

visible

)

Set whether the window should be visible.

Parameters

visible

Whether the window should be visible.

Show()

void SelectHymnWindow::Show

(

)

Show the window and let the user select a hymn.

---

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

• src/Editor/GUI/SelectHymnWindow.hpp
• src/Editor/GUI/SelectHymnWindow.cpp