#include <scrollview.h>

Public Types
enum	Color { NONE, BLACK, WHITE, RED, YELLOW, GREEN, CYAN, BLUE, MAGENTA, AQUAMARINE, DARK_SLATE_BLUE, LIGHT_BLUE, MEDIUM_BLUE, MIDNIGHT_BLUE, NAVY_BLUE, SKY_BLUE, SLATE_BLUE, STEEL_BLUE, CORAL, BROWN, SANDY_BROWN, GOLD, GOLDENROD, DARK_GREEN, DARK_OLIVE_GREEN, FOREST_GREEN, LIME_GREEN, PALE_GREEN, YELLOW_GREEN, LIGHT_GREY, DARK_SLATE_GREY, DIM_GREY, GREY, KHAKI, MAROON, ORANGE, ORCHID, PINK, PLUM, INDIAN_RED, ORANGE_RED, VIOLET_RED, SALMON, TAN, TURQUOISE, DARK_TURQUOISE, VIOLET, WHEAT, GREEN_YELLOW }

Public Member Functions
	~ScrollView ()

	ScrollView (const char *name, int x_pos, int y_pos, int x_size, int y_size, int x_canvas_size, int y_canvas_size)
	Calls Initialize with default argument for server_name_ & y_axis_reversed. More...

	ScrollView (const char *name, int x_pos, int y_pos, int x_size, int y_size, int x_canvas_size, int y_canvas_size, bool y_axis_reversed)
	Calls Initialize with default argument for server_name_. More...

	ScrollView (const char name, int x_pos, int y_pos, int x_size, int y_size, int x_canvas_size, int y_canvas_size, bool y_axis_reversed, const char server_name)
	Calls Initialize with all arguments given. More...

void	AddEventHandler (SVEventHandler *listener)
	Add an Event Listener to this ScrollView Window. More...

SVEvent *	AwaitEvent (SVEventType type)

SVEvent *	AwaitEventAnyWindow ()

const char *	GetName ()

int	GetId ()

void	Image (struct Pix *image, int x_pos, int y_pos)

void	UpdateWindow ()

void	Clear ()

void	Pen (Color color)

void	Pen (int red, int green, int blue)

void	Pen (int red, int green, int blue, int alpha)

void	Brush (Color color)

void	Brush (int red, int green, int blue)

void	Brush (int red, int green, int blue, int alpha)

void	TextAttributes (const char *font, int pixel_size, bool bold, bool italic, bool underlined)

void	Line (int x1, int y1, int x2, int y2)

void	Stroke (float width)

void	Rectangle (int x1, int y1, int x2, int y2)

void	Ellipse (int x, int y, int width, int height)

void	Text (int x, int y, const char *mystring)

void	Image (const char *image, int x_pos, int y_pos)

void	SetCursor (int x, int y)

void	DrawTo (int x, int y)

void	SetVisible (bool visible)

void	AlwaysOnTop (bool b)

int	ShowYesNoDialog (const char *msg)

char *	ShowInputDialog (const char *msg)

void	AddMessageBox ()

void	AddMessage (const char *format,...)

void	ZoomToRectangle (int x1, int y1, int x2, int y2)

void	SendMsg (const char *msg,...)
	Send a message to the server, attaching the window id. More...

void	MenuItem (const char parent, const char name)

void	MenuItem (const char parent, const char name, int cmdEvent)

void	MenuItem (const char parent, const char name, int cmdEvent, bool flagged)

void	PopupItem (const char parent, const char name)

void	PopupItem (const char parent, const char name, int cmdEvent, const char value, const char desc)

int	TranslateYCoordinate (int y)

Static Public Member Functions
static void	Update ()

static void	Exit ()

static void	SendRawMessage (const char *msg)

Detailed Description

Definition at line 97 of file scrollview.h.

Member Enumeration Documentation

◆ Color

enum ScrollView::Color

Enumerator
NONE
BLACK
WHITE
RED
YELLOW
GREEN
CYAN
BLUE
MAGENTA
AQUAMARINE
DARK_SLATE_BLUE
LIGHT_BLUE
MEDIUM_BLUE
MIDNIGHT_BLUE
NAVY_BLUE
SKY_BLUE
SLATE_BLUE
STEEL_BLUE
CORAL
BROWN
SANDY_BROWN
GOLD
GOLDENROD
DARK_GREEN
DARK_OLIVE_GREEN
FOREST_GREEN
LIME_GREEN
PALE_GREEN
YELLOW_GREEN
LIGHT_GREY
DARK_SLATE_GREY
DIM_GREY
GREY
KHAKI
MAROON
ORANGE
ORCHID
PINK
PLUM
INDIAN_RED
ORANGE_RED
VIOLET_RED
SALMON
TAN
TURQUOISE
DARK_TURQUOISE
VIOLET
WHEAT
GREEN_YELLOW

Definition at line 100 of file scrollview.h.

              {
     NONE,
     BLACK,
     WHITE,
     RED,
     YELLOW,
     GREEN,
     CYAN,
     BLUE,
     MAGENTA,
     AQUAMARINE,
     DARK_SLATE_BLUE,
     LIGHT_BLUE,
     MEDIUM_BLUE,
     MIDNIGHT_BLUE,
     NAVY_BLUE,
     SKY_BLUE,
     SLATE_BLUE,
     STEEL_BLUE,
     CORAL,
     BROWN,
     SANDY_BROWN,
     GOLD,
     GOLDENROD,
     DARK_GREEN,
     DARK_OLIVE_GREEN,
     FOREST_GREEN,
     LIME_GREEN,
     PALE_GREEN,
     YELLOW_GREEN,
     LIGHT_GREY,
     DARK_SLATE_GREY,
     DIM_GREY,
     GREY,
     KHAKI,
     MAROON,
     ORANGE,
     ORCHID,
     PINK,
     PLUM,
     INDIAN_RED,
     ORANGE_RED,
     VIOLET_RED,
     SALMON,
     TAN,
     TURQUOISE,
     DARK_TURQUOISE,
     VIOLET,
     WHEAT,
     GREEN_YELLOW  // Make sure this one is last.
 };

Constructor & Destructor Documentation

◆ ~ScrollView()

ScrollView::~ScrollView ( )

Definition at line 360 of file scrollview.cpp.

                         {
   #ifndef GRAPHICS_DISABLED
   svmap_mu->lock();
   if (svmap[window_id_] != nullptr) {
     svmap_mu->unlock();
     // So the event handling thread can quit.
     SendMsg("destroy()");
  
     SVEvent* sve = AwaitEvent(SVET_DESTROY);
     delete sve;
     svmap_mu->lock();
     svmap[window_id_] = nullptr;
     svmap_mu->unlock();
     // The event handler thread for this window *must* receive the
     // destroy event and set its pointer to this to nullptr before we allow
     // the destructor to exit.
     while (!event_handler_ended_)
       Update();
   } else {
     svmap_mu->unlock();
   }
   delete mutex_;
   delete semaphore_;
   delete points_;
   for (auto & i : event_table_) {
     delete i;
   }
   #endif  // GRAPHICS_DISABLED

◆ ScrollView() [1/3]

ScrollView::ScrollView	(	const char *	name,
		int	x_pos,
		int	y_pos,
		int	x_size,
		int	y_size,
		int	x_canvas_size,
		int	y_canvas_size
	)

Calls Initialize with default argument for server_name_ & y_axis_reversed.

Definition at line 260 of file scrollview.cpp.

                                                                          {
   Initialize(name, x_pos, y_pos, x_size, y_size, x_canvas_size, y_canvas_size,
              false, "localhost");

◆ ScrollView() [2/3]

ScrollView::ScrollView	(	const char *	name,
		int	x_pos,
		int	y_pos,
		int	x_size,
		int	y_size,
		int	x_canvas_size,
		int	y_canvas_size,
		bool	y_axis_reversed
	)

Calls Initialize with default argument for server_name_.

Definition at line 252 of file scrollview.cpp.

                                              {
   Initialize(name, x_pos, y_pos, x_size, y_size, x_canvas_size, y_canvas_size,
              y_axis_reversed, "localhost");

◆ ScrollView() [3/3]

ScrollView::ScrollView	(	const char *	name,
		int	x_pos,
		int	y_pos,
		int	x_size,
		int	y_size,
		int	x_canvas_size,
		int	y_canvas_size,
		bool	y_axis_reversed,
		const char *	server_name
	)

Calls Initialize with all arguments given.

Definition at line 245 of file scrollview.cpp.

248 {

249 Initialize(name, x_pos, y_pos, x_size, y_size, x_canvas_size, y_canvas_size,

Member Function Documentation

◆ AddEventHandler()

void ScrollView::AddEventHandler ( SVEventHandler * listener )

Add an Event Listener to this ScrollView Window.

Definition at line 415 of file scrollview.cpp.

416 {

417 event_handler_ = listener;

◆ AddMessage()

void ScrollView::AddMessage	(	const char *	format,
			...
	)

Definition at line 560 of file scrollview.cpp.

                                                    {
   va_list args;
   char message[kMaxMsgSize - 4];
  
   va_start(args, format);  // variable list
   vsnprintf(message, sizeof(message), format, args);
   va_end(args);
  
   char form[kMaxMsgSize];
   snprintf(form, sizeof(form), "w%u:%s", window_id_, message);
  
   char* esc = AddEscapeChars(form);
   SendMsg("addMessage(\"%s\")", esc);

◆ AddMessageBox()

void ScrollView::AddMessageBox ( )

Definition at line 577 of file scrollview.cpp.

579 {

◆ AlwaysOnTop()

void ScrollView::AlwaysOnTop ( bool b )

Definition at line 554 of file scrollview.cpp.

556 {

557 if (b) { SendMsg("setAlwaysOnTop(true)");

◆ AwaitEvent()

SVEvent * ScrollView::AwaitEvent ( SVEventType type )

Block until an event of the given type is received. Note: The calling function is responsible for deleting the returned SVEvent afterwards!

Definition at line 443 of file scrollview.cpp.

                                                 {
   // Initialize the waiting semaphore.
   auto* sem = new SVSemaphore();
   std::pair<ScrollView*, SVEventType> ea(this, type);
   waiting_for_events_mu->lock();
   waiting_for_events[ea] = std::pair<SVSemaphore*, SVEvent*> (sem, (SVEvent*)nullptr);
   waiting_for_events_mu->unlock();
   // Wait on it, but first flush.
   stream_->Flush();
   sem->Wait();
   // Process the event we got woken up for (its in waiting_for_events pair).
   waiting_for_events_mu->lock();
   SVEvent* ret = waiting_for_events[ea].second;
   waiting_for_events.erase(ea);
   delete sem;
   waiting_for_events_mu->unlock();
   return ret;

◆ AwaitEventAnyWindow()

SVEvent * ScrollView::AwaitEventAnyWindow ( )

Definition at line 464 of file scrollview.cpp.

                                          {
   // Initialize the waiting semaphore.
   auto* sem = new SVSemaphore();
   std::pair<ScrollView*, SVEventType> ea((ScrollView*)nullptr, SVET_ANY);
   waiting_for_events_mu->lock();
   waiting_for_events[ea] = std::pair<SVSemaphore*, SVEvent*> (sem, (SVEvent*)nullptr);
   waiting_for_events_mu->unlock();
   // Wait on it.
   stream_->Flush();
   sem->Wait();
   // Process the event we got woken up for (its in waiting_for_events pair).
   waiting_for_events_mu->lock();
   SVEvent* ret = waiting_for_events[ea].second;
   waiting_for_events.erase(ea);
   waiting_for_events_mu->unlock();
   return ret;

◆ Brush() [1/3]

void ScrollView::Brush ( Color color )

Definition at line 723 of file scrollview.cpp.

                                   {
   Brush(table_colors[color][0],
         table_colors[color][1],
         table_colors[color][2],

◆ Brush() [2/3]

void ScrollView::Brush	(	int	red,
		int	green,
		int	blue
	)

Definition at line 624 of file scrollview.cpp.

626 {

◆ Brush() [3/3]

void ScrollView::Brush	(	int	red,
		int	green,
		int	blue,
		int	alpha
	)

Definition at line 629 of file scrollview.cpp.

631 {

◆ Clear()

void ScrollView::Clear ( )

Definition at line 588 of file scrollview.cpp.

590 {

◆ DrawTo()

void ScrollView::DrawTo	(	int	x,
		int	y
	)

Definition at line 524 of file scrollview.cpp.

                                     {
   points_->xcoords.push_back(x);
   points_->ycoords.push_back(TranslateYCoordinate(y));

◆ Ellipse()

void ScrollView::Ellipse	(	int	x,
		int	y,
		int	width,
		int	height
	)

Definition at line 608 of file scrollview.cpp.

610 {

611 SendMsg("drawEllipse(%d,%d,%u,%u)",

◆ Exit()

void ScrollView::Exit ( )

static

Definition at line 582 of file scrollview.cpp.

584 {

585 SendRawMessage("svmain:exit()");

◆ GetId()

int ScrollView::GetId ( )

inline

Definition at line 190 of file scrollview.h.

192 { return window_id_; }

◆ GetName()

const char* ScrollView::GetName ( )

inline

Definition at line 187 of file scrollview.h.

189 { return window_name_; }

◆ Image() [1/2]

void ScrollView::Image	(	const char *	image,
		int	x_pos,
		int	y_pos
	)

Definition at line 656 of file scrollview.cpp.

                                                               {
   SendMsg("openImage('%s')", image);
   SendMsg("drawImage('%s',%d,%d)",

◆ Image() [2/2]

void ScrollView::Image	(	struct Pix *	image,
		int	x_pos,
		int	y_pos
	)

Definition at line 763 of file scrollview.cpp.

                                                               {
   l_uint8* data;
   size_t size;
   pixWriteMem(&data, &size, image, IFF_PNG);
   int base64_len = (size + 2) / 3 * 4;
   y_pos = TranslateYCoordinate(y_pos);
   SendMsg("readImage(%d,%d,%d)", x_pos, y_pos, base64_len);
   // Base64 encode the data.
   const char kBase64Table[64] = {
     'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H',
     'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P',
     'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X',
     'Y', 'Z', 'a', 'b', 'c', 'd', 'e', 'f',
     'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n',
     'o', 'p', 'q', 'r', 's', 't', 'u', 'v',
     'w', 'x', 'y', 'z', '0', '1', '2', '3',
     '4', '5', '6', '7', '8', '9', '+', '/',
   };
   char* base64 = new char[base64_len + 1];
   memset(base64, '=', base64_len);
   base64[base64_len] = '\0';
   int remainder = 0;
   int bits_left = 0;
   int code_len = 0;
   for (size_t i = 0; i < size; ++i) {
     int code = (data[i] >> (bits_left + 2)) | remainder;
     base64[code_len++] = kBase64Table[code & 63];
     bits_left += 2;
     remainder = data[i] << (6 - bits_left);
     if (bits_left == 6) {
       base64[code_len++] = kBase64Table[remainder & 63];
       bits_left = 0;
       remainder = 0;
     }
   }
   if (bits_left > 0)
     base64[code_len++] = kBase64Table[remainder & 63];
   SendRawMessage(base64);
   delete [] base64;

◆ Line()

void ScrollView::Line	(	int	x1,
		int	y1,
		int	x2,
		int	y2
	)

Definition at line 531 of file scrollview.cpp.

                                                     {
   if (!points_->xcoords.empty() && x1 == points_->xcoords.back() &&
       TranslateYCoordinate(y1) == points_->ycoords.back()) {
     // We are already at x1, y1, so just draw to x2, y2.
     DrawTo(x2, y2);
   } else if (!points_->xcoords.empty() && x2 == points_->xcoords.back() &&
       TranslateYCoordinate(y2) == points_->ycoords.back()) {
     // We are already at x2, y2, so just draw to x1, y1.
     DrawTo(x1, y1);
   } else {
     // This is a new line.
     SetCursor(x1, y1);
     DrawTo(x2, y2);

◆ MenuItem() [1/3]

void ScrollView::MenuItem	(	const char *	parent,
		const char *	name
	)

Definition at line 679 of file scrollview.cpp.

681 {

682 if (parent == nullptr) { parent = ""; }

◆ MenuItem() [2/3]

void ScrollView::MenuItem	(	const char *	parent,
		const char *	name,
		int	cmdEvent
	)

Definition at line 673 of file scrollview.cpp.

675 {

676 if (parent == nullptr) { parent = ""; }

◆ MenuItem() [3/3]

void ScrollView::MenuItem	(	const char *	parent,
		const char *	name,
		int	cmdEvent,
		bool	flagged
	)

Definition at line 663 of file scrollview.cpp.

                                                    {
   if (parent == nullptr) { parent = ""; }
   if (flag) { SendMsg("addMenuBarItem('%s','%s',%d,true)",
                       parent, name, cmdEvent);
   } else { SendMsg("addMenuBarItem('%s','%s',%d,false)",

◆ Pen() [1/3]

void ScrollView::Pen ( Color color )

Definition at line 717 of file scrollview.cpp.

719 {

720 Pen(table_colors[color][0], table_colors[color][1],

◆ Pen() [2/3]

void ScrollView::Pen	(	int	red,
		int	green,
		int	blue
	)

Definition at line 614 of file scrollview.cpp.

616 {

◆ Pen() [3/3]

void ScrollView::Pen	(	int	red,
		int	green,
		int	blue,
		int	alpha
	)

Definition at line 619 of file scrollview.cpp.

621 {

◆ PopupItem() [1/2]

void ScrollView::PopupItem	(	const char *	parent,
		const char *	name
	)

Definition at line 685 of file scrollview.cpp.

687 {

688 if (parent == nullptr) { parent = ""; }

◆ PopupItem() [2/2]

void ScrollView::PopupItem	(	const char *	parent,
		const char *	name,
		int	cmdEvent,
		const char *	value,
		const char *	desc
	)

Definition at line 691 of file scrollview.cpp.

                                                                               {
   if (parent == nullptr) { parent = ""; }
   char* esc = AddEscapeChars(value);
   char* esc2 = AddEscapeChars(desc);
   SendMsg("addPopupMenuItem('%s','%s',%d,'%s','%s')", parent, name,
           cmdEvent, esc, esc2);
   delete[] esc;

◆ Rectangle()

void ScrollView::Rectangle	(	int	x1,
		int	y1,
		int	x2,
		int	y2
	)

Definition at line 599 of file scrollview.cpp.

                                                          {
   if (x1 == x2 && y1 == y2)
     return;  // Scrollviewer locks up.
   SendMsg("drawRectangle(%d,%d,%d,%d)",

◆ SendMsg()

void ScrollView::SendMsg	(	const char *	msg,
			...
	)

Send a message to the server, attaching the window id.

Definition at line 392 of file scrollview.cpp.

                                                 {
   if (!points_->empty)
     SendPolygon();
   va_list args;
   char message[kMaxMsgSize - 4];
  
   va_start(args, format);  // variable list
   vsnprintf(message, sizeof(message), format, args);
   va_end(args);
  
   char form[kMaxMsgSize];
   snprintf(form, sizeof(form), "w%u:%s\n", window_id_, message);
  
   stream_->Send(form);

◆ SendRawMessage()

void ScrollView::SendRawMessage ( const char * msg )

static

Send a message to the server without a window id. Used for global events like exit().

Definition at line 410 of file scrollview.cpp.

411 {

412 stream_->Send(msg);

◆ SetCursor()

void ScrollView::SetCursor	(	int	x,
		int	y
	)

Definition at line 518 of file scrollview.cpp.

520 {

521 SendPolygon();

◆ SetVisible()

void ScrollView::SetVisible ( bool visible )

Definition at line 548 of file scrollview.cpp.

550 {

551 if (visible) { SendMsg("setVisible(true)");

◆ ShowInputDialog()

char * ScrollView::ShowInputDialog ( const char * msg )

Definition at line 731 of file scrollview.cpp.

                                                  {
   SendMsg("showInputDialog(\"%s\")", msg);
   SVEvent* ev;
   // wait till an input event (all others are thrown away)
   ev = AwaitEvent(SVET_INPUT);
   char* p = new char[strlen(ev->parameter) + 1];
   strcpy(p, ev->parameter);
   delete ev;

◆ ShowYesNoDialog()

int ScrollView::ShowYesNoDialog ( const char * msg )

Definition at line 743 of file scrollview.cpp.

                                                {
   SendMsg("showYesNoDialog(\"%s\")", msg);
   SVEvent* ev;
   // Wait till an input event (all others are thrown away)
   ev = AwaitEvent(SVET_INPUT);
   int a = ev->parameter[0];
   delete ev;

◆ Stroke()

void ScrollView::Stroke ( float width )

Definition at line 593 of file scrollview.cpp.

595 {

◆ Text()

void ScrollView::Text	(	int	x,
		int	y,
		const char *	mystring
	)

Definition at line 651 of file scrollview.cpp.

653 {

◆ TextAttributes()

void ScrollView::TextAttributes	(	const char *	font,
		int	pixel_size,
		bool	bold,
		bool	italic,
		bool	underlined
	)

Definition at line 634 of file scrollview.cpp.

                                                                          {
   const char* b;
   const char* i;
   const char* u;
  
   if (bold) { b = "true";
   } else { b = "false"; }
   if (italic) { i = "true";
   } else { i = "false"; }
   if (underlined) { u = "true";
   } else { u = "false"; }
   SendMsg("textAttributes('%s',%u,%s,%s,%s)", font, pixel_size,

◆ TranslateYCoordinate()

int ScrollView::TranslateYCoordinate ( int y )

Definition at line 825 of file scrollview.cpp.

827 {

828 if (!y_axis_is_reversed_) { return y;

◆ Update()

void ScrollView::Update ( )

static

Definition at line 708 of file scrollview.cpp.

                         {
   std::lock_guard<std::mutex> guard(*svmap_mu);
   for (auto & iter : svmap) {
     if (iter.second != nullptr)
       iter.second->UpdateWindow();

◆ UpdateWindow()

void ScrollView::UpdateWindow ( )

Definition at line 703 of file scrollview.cpp.

705 {

◆ ZoomToRectangle()

void ScrollView::ZoomToRectangle	(	int	x1,
		int	y1,
		int	x2,
		int	y2
	)

Definition at line 755 of file scrollview.cpp.

                                                                {
   y1 = TranslateYCoordinate(y1);
   y2 = TranslateYCoordinate(y2);
   SendMsg("zoomRectangle(%d,%d,%d,%d)",

The documentation for this class was generated from the following files:

/tesseract/src/viewer/scrollview.h
/tesseract/src/viewer/scrollview.cpp

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ Color

Constructor & Destructor Documentation

◆ ~ScrollView()

◆ ScrollView() [1/3]

◆ ScrollView() [2/3]

◆ ScrollView() [3/3]

Member Function Documentation

◆ AddEventHandler()

◆ AddMessage()

◆ AddMessageBox()

◆ AlwaysOnTop()

◆ AwaitEvent()

◆ AwaitEventAnyWindow()

◆ Brush() [1/3]

◆ Brush() [2/3]

◆ Brush() [3/3]

◆ Clear()

◆ DrawTo()

◆ Ellipse()

◆ Exit()

◆ GetId()

◆ GetName()

◆ Image() [1/2]

◆ Image() [2/2]

◆ Line()

◆ MenuItem() [1/3]

◆ MenuItem() [2/3]

◆ MenuItem() [3/3]

◆ Pen() [1/3]

◆ Pen() [2/3]

◆ Pen() [3/3]

◆ PopupItem() [1/2]

◆ PopupItem() [2/2]

◆ Rectangle()

◆ SendMsg()

◆ SendRawMessage()

◆ SetCursor()

◆ SetVisible()

◆ ShowInputDialog()

◆ ShowYesNoDialog()

◆ Stroke()

◆ Text()

◆ TextAttributes()

◆ TranslateYCoordinate()

◆ Update()

◆ UpdateWindow()

◆ ZoomToRectangle()