mnavigationitem.h

//
//                          IMPORTANT NOTICE
//
// The following open source license statement does not apply to any
// entity in the Exception List published by FMSoft.
//
// For more information, please visit:
//
// https://www.fmsoft.cn/exception-list
//
/*
 * \file 
 * \author FMSoft
 * \date 
 *
 \verbatim
 
    This file is part of mGNCS4Touch, one of MiniGUI components.
 
    Copyright (C) 2008-2018 FMSoft (http://www.fmsoft.cn).
 
    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 3 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, see <http://www.gnu.org/licenses/>.
 
    Or,
 
    As this program is a library, any link to this program must follow
    GNU General Public License version 3 (GPLv3). If you cannot accept
    GPLv3, you need to be licensed from FMSoft.
 
    If you have got a commercial license of this program, please use it
    under the terms and conditions of the commercial license.
 
    For more information about the commercial license, please refer to
    <http://www.minigui.com/blog/minigui-licensing-policy/>.
 
 \endverbatim
*/
 
#ifndef _MGNCS_MNAVIGATION_ITEM_H
#define _MGNCS_MNAVIGATION_ITEM_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
typedef struct _mNavigationItemClass mNavigationItemClass;
typedef struct _mNavigationItem mNavigationItem;
 
 
/* NavigationItem set and get properties */
#define NAVIGATIONITEM_PROP_BEGIN    USER_PIECE_PROP_BEGIN + 1
enum {
    NCSP_NAVIGATIONITEM_CONTENT = NAVIGATIONITEM_PROP_BEGIN,
    NCSP_NAVIGATIONITEM_BACKGROUND,
    NCSP_NAVIGATIONITEM_BAR_BKG,
    NCSP_NAVIGATIONITEM_TITLE,
    NCSP_NAVIGATIONITEM_STYLE,
    NCSP_NAVIGATIONITEM_LEFT_BUTTON,
    NCSP_NAVIGATIONITEM_TITLE_BUTTON,
    NCSP_NAVIGATIONITEM_RIGHT_BUTTON,
    NCSP_NAVIGATIONITEM_DEFAULT_BUTTON_FONT,
};
 
/* navigation bar style */
typedef enum {
    NAVIGATION_STYLE_NORMAL = 0x00,      /* normal: the bar not overlapped the view, not transparent */
    NAVIGATION_STYLE_FULLSCREEN = 0x01,  /* full screen: the bar overlapped the view, transparent */
    NAVIGATION_STYLE_HIDE_BAR = 0x02     /* full screen: the bar not show */
} navigation_bar_style;
 
 
/* NaviagtionItem methods */
#define mNavigationItemClassHeader(clss, superCls) \
    mObjectClassHeader(clss, superCls) \
    m3DButtonPiece* (*createDefaultButton)(clss*, const char*, DWORD); \
        BOOL (*setProperty)(clss*, int, DWORD); \
        DWORD(*getProperty)(clss*, int); 
    
/* static interface */
MGNCS_EXPORT extern mNavigationItem* ncsCreateNavigationItem (mHotPiece *content,
                            const char *title, unsigned int style);
MGNCS_EXPORT extern void ncsDestroyNavigationItem (mNavigationItem* item);
MGNCS_EXPORT extern void ncsAdjustNavigationItemRectWithTitle (mHotPiece *content, const char *title, PLOGFONT font);
 
struct _mNavigationItemClass
{   
    mNavigationItemClassHeader(mNavigationItem, mObject)
};
 
MGNCS_EXPORT extern mNavigationItemClass g_stmNavigationItemCls;
 
 
/* NaviagtioItem data members */
#define mNavigationItemHeader(clss) \
    mObjectHeader(clss) \
    mShapeTransRoundPiece* background; \
    mHotPiece* content; \
    mButtonPanelPiece* bar_left_button; \
    mTextPiece* bar_title_button; \
    mButtonPanelPiece* bar_right_button; \
    PLOGFONT default_button_font; \
    unsigned int style; \
    char* title;
 
struct _mNavigationItem
{   
    mNavigationItemHeader(mNavigationItem)
};
 
 
#ifdef __cplusplus
}
#endif
 
#endif /*_MGNCS_MNAVIGATION_ITEM_H*/