mirror of
https://github.com/ultimatepp/ultimatepp.git
synced 2026-08-31 07:12:39 -06:00
Bazaar/HelpViewer : added Back and forward buttons, backlink to tree and window title
git-svn-id: svn://ultimatepp.org/upp/trunk@4117 f0d560ea-af0d-0410-9eb7-867de7ffcac7
This commit is contained in:
micio
parent
dff68a2c1e
commit
e63f3009d5
4 changed files with 392 additions and 213 deletions
|
|
@ -1,154 +1,232 @@
|
|||
#include "HelpViewer.h"
|
||||
|
||||
/*
|
||||
#define IMAGEFILE <HelpViewer/HelpViewer.iml>
|
||||
#include <Draw/iml_source.h>
|
||||
*/
|
||||
|
||||
const char *TOPICLINK = "^topic`:`/`/";
|
||||
|
||||
HelpViewer::HelpViewer()
|
||||
{
|
||||
// setups splitter and its contents
|
||||
Add(splitter);
|
||||
splitter.Horz(tocPane, contentsPane).SetPos(2500);
|
||||
contentsPane.AutoHideSb();
|
||||
contentsPane.SetZoom(Zoom(1,1));
|
||||
contentsPane.HMargins(20);
|
||||
|
||||
tocPane.Add(mainTocTree.NoRoot().SizePos());
|
||||
|
||||
// setup TOC link callback
|
||||
mainTocTree.WhenSel = THISBACK(tocLinkCb);
|
||||
contentsPane.WhenLink << THISBACK(contentLinkCb);
|
||||
|
||||
zoom.m = 160;
|
||||
zoom.d = 1000;
|
||||
|
||||
Sizeable().Zoomable();
|
||||
}
|
||||
|
||||
// appends a treeCtrl to main tocCtrl
|
||||
void HelpViewer::AppendTOC(TreeCtrl const &t, int curId, int destId)
|
||||
{
|
||||
// adds root node of current level
|
||||
int destChild = mainTocTree.Add(destId, t.GetNode(curId));
|
||||
|
||||
// recursively add all children
|
||||
for(int i = 0; i < t.GetChildCount(curId); i++)
|
||||
AppendTOC(t, t.GetChild(curId, i), destChild);
|
||||
|
||||
// opens all content tree and display first item
|
||||
mainTocTree.OpenDeep(0);
|
||||
mainTocTree.SelectOne(2);
|
||||
mainTocTree.SetCursor(2);
|
||||
mainTocTree.WhenSel();
|
||||
}
|
||||
|
||||
// Parses TOC and fills tocTree control
|
||||
bool HelpViewer::LoadTOC(String const &tocLink)
|
||||
{
|
||||
// TOC is composed by QTF lines with a TOC link and label text
|
||||
// lines not containing the TOC link are simply ignored
|
||||
// TOC level is represented by number of TABS contained
|
||||
// inside a line; zero tabs means toplevel, id 0 of tocTree
|
||||
Vector<int>ids;
|
||||
ids.Add(0);
|
||||
int curLevel = 0;
|
||||
int curId = 0;
|
||||
TreeCtrl tocTree;
|
||||
|
||||
Topic t = GetTopic(tocLink);
|
||||
if(IsNull(t.text))
|
||||
return false;
|
||||
|
||||
String label = t.label;
|
||||
String topic = t.link;
|
||||
|
||||
// sets toc root string from topic ticle
|
||||
tocTree.SetRoot(Null, t.title);
|
||||
|
||||
// converts QTF to RichTxt, easier to analyze
|
||||
RichText txt = ParseQTF(t.text);
|
||||
|
||||
// extract all paragraphs from RichTxt, skip other objects
|
||||
for(int iPart = 0; iPart < txt.GetPartCount(); iPart++)
|
||||
{
|
||||
String tocLine;
|
||||
String lineLink;
|
||||
if(!txt.IsPara(iPart))
|
||||
continue;
|
||||
RichPara p = txt.Get(iPart);
|
||||
for(int iParaPart = 0; iParaPart < p.GetCount(); iParaPart++)
|
||||
{
|
||||
RichPara::Part ¶Part = p.part[iParaPart];
|
||||
if(paraPart.format.link != "")
|
||||
lineLink = paraPart.format.link;
|
||||
if(paraPart.NonText())
|
||||
continue;
|
||||
tocLine += paraPart.text.ToString();
|
||||
}
|
||||
// if part contains no text nor link to topic stuffs, simply skip it
|
||||
if(tocLine == "" || lineLink == "" || !lineLink.StartsWith("topic:"))
|
||||
continue;
|
||||
|
||||
// now we should count tabls to get TOC indent level
|
||||
int level = 0;
|
||||
int j;
|
||||
while( (j = tocLine.Find(0x09)) >= 0)
|
||||
{
|
||||
level++;
|
||||
tocLine.Remove(j);
|
||||
}
|
||||
// allows just SINGLE UPPER level change, i.e., deeper ONE level from current
|
||||
// for each step; backleveling is possible at any depth
|
||||
if(level > curLevel+1)
|
||||
return false;
|
||||
if(level > curLevel)
|
||||
{
|
||||
ids.Add(curId);
|
||||
curLevel++;
|
||||
}
|
||||
else while(curLevel > level)
|
||||
{
|
||||
curLevel--;
|
||||
ids.Pop();
|
||||
}
|
||||
|
||||
// add the line to correct tree node
|
||||
curId = tocTree.Add(ids.Top(), Null, Value(lineLink), Value(tocLine));
|
||||
}
|
||||
|
||||
// if the tree control is non empty, appends it to the main TOC TreeCtrl
|
||||
if(tocTree.GetChildCount(0))
|
||||
AppendTOC(tocTree);
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
// reacts on link selection inside content pane
|
||||
void HelpViewer::contentLinkCb(String const &link)
|
||||
{
|
||||
Topic t = GetTopic(link);
|
||||
if(!IsNull(t.text))
|
||||
{
|
||||
String label = t.label;
|
||||
RichText txt = ParseQTF(t.text);
|
||||
contentsPane.Pick(txt, zoom);
|
||||
contentsPane.GotoLabel(label, true);
|
||||
current_link = link;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
void HelpViewer::tocLinkCb()
|
||||
{
|
||||
int id = mainTocTree.GetCursor();
|
||||
if(id < 0)
|
||||
return;
|
||||
|
||||
// gets link
|
||||
String link = mainTocTree.Get(id);
|
||||
|
||||
contentLinkCb(link);
|
||||
}
|
||||
#include "HelpViewer.h"
|
||||
|
||||
#define IMAGECLASS HelpImg
|
||||
#define IMAGEFILE <HelpViewer/HelpViewer.iml>
|
||||
#include <Draw/iml_source.h>
|
||||
|
||||
const char *TOPICLINK = "^topic`:`/`/";
|
||||
|
||||
HelpViewer::HelpViewer()
|
||||
{
|
||||
// adds toolbar
|
||||
AddFrame(toolBar);
|
||||
|
||||
// setups splitter and its contents
|
||||
Add(splitter);
|
||||
splitter.Horz(tocPane, contentsPane).SetPos(2500);
|
||||
contentsPane.AutoHideSb();
|
||||
contentsPane.SetZoom(Zoom(1,1));
|
||||
contentsPane.HMargins(20);
|
||||
|
||||
tocPane.Add(mainTocTree.NoRoot().SizePos());
|
||||
|
||||
// setup TOC link callback
|
||||
mainTocTree.WhenSel = THISBACK(tocLinkCb);
|
||||
contentsPane.WhenLink << THISBACK(contentLinkCb);
|
||||
|
||||
// initialize link stack
|
||||
stack.Clear();
|
||||
tos = -1;
|
||||
|
||||
Sizeable().Zoomable();
|
||||
|
||||
// loads toolbar
|
||||
toolBar.Set(THISBACK(toolBarCb));
|
||||
}
|
||||
|
||||
// appends a treeCtrl to main tocCtrl
|
||||
void HelpViewer::AppendTOC(TreeCtrl const &t, int curId, int destId)
|
||||
{
|
||||
// adds root node of current level
|
||||
int destChild = mainTocTree.Add(destId, t.GetNode(curId));
|
||||
|
||||
// recursively add all children
|
||||
for(int i = 0; i < t.GetChildCount(curId); i++)
|
||||
AppendTOC(t, t.GetChild(curId, i), destChild);
|
||||
}
|
||||
|
||||
// Parses TOC and fills tocTree control
|
||||
bool HelpViewer::LoadTOC(String const &tocLink)
|
||||
{
|
||||
// TOC is composed by QTF lines with a TOC link and label text
|
||||
// lines not containing the TOC link are simply ignored
|
||||
// TOC level is represented by number of TABS contained
|
||||
// inside a line; zero tabs means toplevel, id 0 of tocTree
|
||||
Vector<int>ids;
|
||||
ids.Add(0);
|
||||
int curLevel = 0;
|
||||
int curId = 0;
|
||||
TreeCtrl tocTree;
|
||||
|
||||
Topic t = GetTopic(tocLink);
|
||||
if(IsNull(t.text))
|
||||
return false;
|
||||
|
||||
String label = t.label;
|
||||
String topic = t.link;
|
||||
|
||||
// sets toc root string from topic ticle
|
||||
tocTree.SetRoot(Null, t.title);
|
||||
|
||||
// converts QTF to RichTxt, easier to analyze
|
||||
RichText txt = ParseQTF(t.text);
|
||||
|
||||
// extract all paragraphs from RichTxt, skip other objects
|
||||
for(int iPart = 0; iPart < txt.GetPartCount(); iPart++)
|
||||
{
|
||||
String tocLine;
|
||||
String lineLink;
|
||||
if(!txt.IsPara(iPart))
|
||||
continue;
|
||||
RichPara p = txt.Get(iPart);
|
||||
for(int iParaPart = 0; iParaPart < p.GetCount(); iParaPart++)
|
||||
{
|
||||
RichPara::Part ¶Part = p.part[iParaPart];
|
||||
if(paraPart.format.link != "")
|
||||
lineLink = paraPart.format.link;
|
||||
if(paraPart.NonText())
|
||||
continue;
|
||||
tocLine += paraPart.text.ToString();
|
||||
}
|
||||
// if part contains no text nor link to topic stuffs, simply skip it
|
||||
if(tocLine == "" || lineLink == "" || !lineLink.StartsWith("topic:"))
|
||||
continue;
|
||||
|
||||
// now we should count tabls to get TOC indent level
|
||||
int level = 0;
|
||||
int j;
|
||||
while( (j = tocLine.Find(0x09)) >= 0)
|
||||
{
|
||||
level++;
|
||||
tocLine.Remove(j);
|
||||
}
|
||||
// allows just SINGLE UPPER level change, i.e., deeper ONE level from current
|
||||
// for each step; backleveling is possible at any depth
|
||||
if(level > curLevel+1)
|
||||
return false;
|
||||
if(level > curLevel)
|
||||
{
|
||||
ids.Add(curId);
|
||||
curLevel++;
|
||||
}
|
||||
else while(curLevel > level)
|
||||
{
|
||||
curLevel--;
|
||||
ids.Pop();
|
||||
}
|
||||
|
||||
// add the line to correct tree node
|
||||
curId = tocTree.Add(ids.Top(), Null, Value(lineLink), Value(tocLine));
|
||||
}
|
||||
|
||||
// if the tree control is non empty, appends it to the main TOC TreeCtrl
|
||||
if(tocTree.GetChildCount(0))
|
||||
AppendTOC(tocTree);
|
||||
|
||||
|
||||
// opens all content tree and display first item
|
||||
mainTocTree.OpenDeep(0);
|
||||
mainTocTree.SetCursor(2);
|
||||
|
||||
// stores first topic at top of stack
|
||||
String curLink = mainTocTree.Get();
|
||||
stack.Clear();
|
||||
stack.Add(curLink);
|
||||
tos = 0;
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
// go to a selected link
|
||||
void HelpViewer::showLink(String const &link)
|
||||
{
|
||||
Topic t = GetTopic(link);
|
||||
if(!IsNull(t.text))
|
||||
{
|
||||
Zoom zoom;
|
||||
zoom.m = 160;
|
||||
zoom.d = 1000;
|
||||
|
||||
String label = t.label;
|
||||
RichText txt = ParseQTF(t.text);
|
||||
contentsPane.Pick(txt, zoom);
|
||||
contentsPane.GotoLabel(label, true);
|
||||
int tocId = mainTocTree.Find(link);
|
||||
if(tocId >= 0)
|
||||
{
|
||||
// disable tocTree action on selecting cursor
|
||||
// otherwise we've got a recursive call
|
||||
mainTocTree.WhenSel.Clear();
|
||||
mainTocTree.SetCursor(tocId);
|
||||
|
||||
// re-enable tocTree action
|
||||
mainTocTree.WhenSel = THISBACK(tocLinkCb);
|
||||
|
||||
// setup window title
|
||||
Title(mainTocTree.GetValue());
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// reacts on link selection inside content pane
|
||||
void HelpViewer::contentLinkCb(String const &link)
|
||||
{
|
||||
// clear forward buffer
|
||||
stack.Trim(tos+1);
|
||||
|
||||
// updates history
|
||||
int tocId = mainTocTree.GetCursor();
|
||||
if(tocId > 0)
|
||||
{
|
||||
String curLink = mainTocTree.Get();
|
||||
stack.Add(curLink);
|
||||
tos++;
|
||||
toolBar.Set(THISBACK(toolBarCb));
|
||||
|
||||
}
|
||||
|
||||
// shows link inside main pane
|
||||
showLink(link);
|
||||
}
|
||||
|
||||
|
||||
void HelpViewer::tocLinkCb()
|
||||
{
|
||||
int id = mainTocTree.GetCursor();
|
||||
if(id < 0)
|
||||
return;
|
||||
|
||||
// gets link
|
||||
String link = mainTocTree.Get(id);
|
||||
|
||||
// follow link
|
||||
contentLinkCb(link);
|
||||
}
|
||||
|
||||
// go previous/next
|
||||
void HelpViewer::backCb(void)
|
||||
{
|
||||
if(--tos >= 0)
|
||||
{
|
||||
String link = stack[tos];
|
||||
showLink(link);
|
||||
}
|
||||
toolBar.Set(THISBACK(toolBarCb));
|
||||
}
|
||||
|
||||
void HelpViewer::fwCb(void)
|
||||
{
|
||||
if(tos < stack.GetCount() - 1)
|
||||
{
|
||||
String link = stack[++tos];
|
||||
showLink(link);
|
||||
}
|
||||
toolBar.Set(THISBACK(toolBarCb));
|
||||
}
|
||||
|
||||
// toolbar construction
|
||||
void HelpViewer::toolBarCb(Bar &bar)
|
||||
{
|
||||
bar.Add(tos > 0, "Back", HelpImg::Back(), THISBACK(backCb));
|
||||
bar.Add(tos < stack.GetCount() - 1, "Forward", HelpImg::Forward(), THISBACK(fwCb));
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue