Class mgr session::BaseSession::Banner

Материал из ISPWiki
Перейти к: навигация, поиск

Класс mgr_session::BaseSession::Banner

Пользовательское уведомление

#include <mgrsession.h> 

Описание:

class mgr_session::BaseSession::Banner


Родители:


Перечисления (кратко)

Перечисление Level { blUnknown , blWarning , blNotify , blInfo , } Перечисление LinkType { ltHelp , ltUrl , ltFunc , ltFormFunc , }

Открытые члены (кратко)

Banner & SetParam ( const string &name , const string &value )

Задать параметр


Banner & SetMessage ( const string &name )

Задать сообщение


Banner & SetLink ( const string &name , LinkType link = ltFunc , const string &elid = "" )

Задать ссылку

Приватные члены (кратко)

Перечисления (подробно)

Level

  • blUnknown
  • blWarning
  • blNotify
  • blInfo

LinkType

  • ltHelp
  • ltUrl
  • ltFunc
  • ltFormFunc

Методы

Banner &SetParam ( const string &name , const string &value )

Задать параметр

Если в текст уведомления необходимо подставить какое-либо значение, то это можно сделать с помощью данного метода. Для этого текст уведомления должен содержать в себе последовательность вида name. Где name - это значение поля name метода SetParam. В результате работы метода указанная последовательность будет заменена на значение параметра value.

Banner &SetMessage ( const string &name )

Задать сообщение

Если в текст уведомления необходимо подставить какое-либо сообщение, то это можно сделать с помощью данного метода. Для этого текст уведомления должен содержать в себе последовательность вида name. Где name - это значение поля name метода SetMessage. В результате работы метода указанная последовательность будет заменена на значение сообщения. Само сообщение должно быть прописано либо в секции сообщений списка, либо - в секции alert.

Banner &SetLink ( const string &name , LinkType link = ltFunc , const string &elid = "" )

Задать ссылку

Если необходимо, чтобы из баннера можно было перейти на функцию или форму, необходимо вызвать данный метод, передав в качестве параметра name имя функции, в качестве параметра link - тип сссылки (ltFunc - функция/список, ltFormFunc - форма). Если link = ltFormFunc, по необходимости можно передать elid редактируемого элемента.