1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
|
/*
Crystal Space Windowing System: notebook class
Copyright (C) 2000 by Andrew Zabolotny <bit@eltech.ru>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library 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
Library General Public License for more details.
You should have received a copy of the GNU Library General Public
License along with this library; if not, write to the Free
Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#ifndef __CSNOTEBK_H__
#define __CSNOTEBK_H__
#include "cscomp.h"
#include "csbutton.h"
/**
* Notebook styles.
* There are various styles of notebooks. The position of the tabs,
* the border style and so on can be different. The masks below
* can be ORed together to form a compound notebook style; only
* one value from each group can be choosed.
*/
/// The mask for tab position bits
#define CSNBS_TABPOS_MASK 0x00000003
/// Use tabs along the top side of notebook (default value)
#define CSNBS_TABPOS_TOP 0x00000000
/// Use tabs along the bottom side of notebook
#define CSNBS_TABPOS_BOTTOM 0x00000001
/// Use tabs along the left side of notebook
#define CSNBS_TABPOS_LEFT 0x00000002
/// Use tabs along the right side of notebook
#define CSNBS_TABPOS_RIGHT 0x00000003
/// Draw a thin 3D frame around page dialogs
#define CSNBS_PAGEFRAME 0x00000010
/// Display page information on the top of notebook
#define CSNBS_PAGEINFO 0x00000020
/// Display a flat thin border around tabs instead of 3D look
#define CSNBS_THINTABS 0x00000040
#define CSNBS_DEFAULTVALUE CSNBS_TABPOS_TOP | \
CSNBS_PAGEFRAME | \
CSNBS_PAGEINFO
/**
* Notebook messages.
*/
enum
{
/**
* Sent to parent component to notify that the notebook is going
* to leave a page. The parent can abort this process by returning
* NULL in Event.Command.Info field.
* <pre>
* IN: (csComponent *)page
* OUT: unchanged or NULL
* </pre>
*/
cscmdNotebookLeavePage = 0x00000c00,
/**
* Notify parent window that a page is going to be selected.
* The parent can abort this process by returning NULL in the
* Event.Command.Info field or set the address of another component
* to be selected instead.
* <pre>
* IN: (csComponent *)page
* OUT: (csComponent *)page_to_select or NULL
* </pre>
*/
cscmdNotebookSelectPage,
/**
* Tell notebook to switch to next page
* <pre>
* IN: nothing
* OUT: nothing
* </pre>
*/
cscmdNotebookNextPage,
/**
* Tell notebook to switch to previous page
* <pre>
* IN: nothing
* OUT: nothing
* </pre>
*/
cscmdNotebookPrevPage,
/**
* Tell notebook to scroll tab line forward
* <pre>
* IN: nothing
* OUT: nothing
* </pre>
*/
cscmdNotebookScrollTabsForward,
/**
* Tell notebook to scroll tab line backward
* <pre>
* IN: nothing
* OUT: nothing
* </pre>
*/
cscmdNotebookScrollTabsBackward
};
class cspNotebookButton;
/**
* A notebook (OS/2 term, Windows term "property shit") is a collection
* of dialogs enclosed in a single window. The dialogs are divided into
* several groups, each group gets its own "tab" on one of the sides
* of the notebook. By clicking the "tab" you switch to that group of
* dialogs, every group can consist of several dialogs that are switched
* with a minor arrow control in one of the corners of the notebook.
*/
class csNotebook : public csComponent
{
// Structure used to keep per-page private information
struct cspPageData
{
// The page component
csComponent *page;
// Tab bounds (empty if not visible)
csRect bound;
// The Z-order of this tab (-1 if not visible)
int zorder;
// Notebook page flags (see NOTEBOOK_PAGE_XXX)
unsigned char flags;
// The image on this tab (only primary pages)
csPixmap *image;
// The text on this tab
char *text;
// The underline position
int underline_pos;
// Constructor
cspPageData (csComponent *ipage, unsigned char iflags);
// Destructor
~cspPageData ();
// Check if this character is the hotkey for this tab
bool IsHotKey (int iKey);
};
/// Notebook style
int style;
/// The next/previous page buttons
csButton *nextpage, *prevpage;
/// Tab line scroll forward/backward buttons
cspNotebookButton *tabfor, *taback;
/// Shared pixmaps on notebook buttons
static csPixmap *sprites [12];
/// Flag: true if we should re-position knobs
bool fReposition;
/// The first visible tab and the active tab
int firsttab, activetab;
/// This array contains the per-page information
CS_DECLARE_TYPED_VECTOR (cspPageDataVector, cspPageData) pages;
public:
/// Create a notebook component with given parent and style
csNotebook (csComponent *iParent, int iStyle = CSNBS_DEFAULTVALUE);
/// Destroy the notebook object
virtual ~csNotebook ();
/// Draw the notebook
virtual void Draw ();
/// Handle external events
virtual bool HandleEvent (iEvent &Event);
/// Reposition knobs on resize
virtual bool SetRect (int xmin, int ymin, int xmax, int ymax);
/// Query notebook style
int GetStyle () { return style; }
/// Change notebook style on-the-fly
void SetStyle (int iStyle);
/// Add a primary tab: page info can differ from page title
bool AddPrimaryTab (csComponent *iComponent, const char *iText,
const char *iInfo = NULL, csComponent *iBefore = NULL);
/// Add a secondary tab (no page title)
bool AddSecondaryTab (csComponent *iComponent, const char *iInfo,
csComponent *iBefore = NULL);
/// Same but use a pixmap as tab label rather than a text string
bool AddPrimaryTab (csComponent *iComponent, csPixmap *iPixmap,
bool iDeletePixmap = true, const char *iInfo = NULL,
csComponent *iBefore = NULL);
/// Delete a tab and associated component by index
bool DeleteTab (int iIndex);
/// Delete a tab and associated component
bool DeleteTab (csComponent *iComponent);
/// Select a particular tab (by index)
bool SelectTab (int iIndex);
/// Select a particular tab (by component)
bool SelectTab (csComponent *iComponent);
protected:
/// Secondary data (can be derived from other data but is cached for speed)
int tabx, taby, tabw, tabh, lasttab, lastpos, primary;
/// Reposition current page, forward/backward buttons etc
void PlaceGadgets ();
/// Common part for AddXXXTab ()
bool AddTab (cspPageData *iPageData, const char *iInfo,
csComponent *iBefore);
/// Compute client rectangle size
void GetClientRect (csRect &oRect);
/// Compute the height of information line
int InfoHeight ();
/// Compute the size of a single tab
bool GetTabSize (int iTab, int &oW, int &oH);
/// Check if given x,y lies inside a tab
bool InsideTab (int iIndex, int x, int y);
/// Find page index given page pointer
int FindPage (csComponent *iComponent);
};
#endif // __CSNOTEBK_H__
|