Choco OS  V.0.16.9.0
Join to the chocolate world
oc_screenman.h File Reference

The file with interface of the Screen Manager module. More...

#include <oc_errors.h>
#include <oc_screen.h>
#include <oc_list.h>

Go to the source code of this file.

Functions

oC_ErrorCode_t oC_ScreenMan_TurnOn (void)
 turns on the screen manager module More...
 
oC_ErrorCode_t oC_ScreenMan_TurnOff (void)
 turns off screen manager More...
 
void oC_ScreenMan_ConfigureAll (void)
 configures all screens More...
 
void oC_ScreenMan_UnconfigureAll (void)
 unconfigures all screens More...
 
oC_Screen_t oC_ScreenMan_GetDefaultScreen (void)
 returns default screen More...
 
 oC_List (oC_Screen_t) oC_ScreenMan_GetList(void)
 returns screens list More...
 
oC_Screen_t oC_ScreenMan_GetScreen (const char *Name)
 returns selected screen More...
 
oC_ErrorCode_t oC_ScreenMan_AddScreen (oC_Screen_t Screen)
 adds screen to the screens list More...
 
oC_ErrorCode_t oC_ScreenMan_RemoveScreen (oC_Screen_t Screen)
 removes screen from the screens list More...
 

Detailed Description


Author
Patryk Kubiak - (Created on: 21.07.2016 20:07:14)
Note
Copyright (C) 2016 Patryk Kubiak patry.nosp@m.k.ku.nosp@m.biak9.nosp@m.0@gm.nosp@m.ail.c.nosp@m.om
           This program is free software; you can redistribute it and/or modify
           it under the terms of the GNU General Public License as published by
           the Free Software Foundation; either version 2 of the License, or
           (at your option) any later version.

           This program is distributed in the hope that it will be useful,
           but WITHOUT ANY WARRANTY; without even the implied warranty of
           MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
           GNU General Public License for more details.

           You should have received a copy of the GNU General Public License
           along with this program; if not, write to the Free Software
           Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

Definition in file oc_screenman.h.

Function Documentation

oC_List ( oC_Screen_t  )

The function returns list of screens available in the system. It also can return NULL if the module did not start yet.

Warning
This function returns real list of the screens (IT IS NOT A COPY!!!) You can read it, but don't change anything in this list - otherwise it may cause undefined behavior.
Returns
List of screens

Definition at line 242 of file oc_screenman.c.