This repository has been archived on 2023-10-09. You can view files and clone it. You cannot open issues or pull requests or push a commit.
Files
blender-archive/source/blender/editors/space_info/textview.h
Campbell Barton c434782e3a File headers: SPDX License migration
Use a shorter/simpler license convention, stops the header taking so
much space.

Follow the SPDX license specification: https://spdx.org/licenses

- C/C++/objc/objc++
- Python
- Shell Scripts
- CMake, GNUmakefile

While most of the source tree has been included

- `./extern/` was left out.
- `./intern/cycles` & `./intern/atomic` are also excluded because they
  use different header conventions.

doc/license/SPDX-license-identifiers.txt has been added to list SPDX all
used identifiers.

See P2788 for the script that automated these edits.

Reviewed By: brecht, mont29, sergey

Ref D14069
2022-02-11 09:14:36 +11:00

74 lines
2.3 KiB
C++

/* SPDX-License-Identifier: GPL-2.0-or-later */
/** \file
* \ingroup spinfo
*/
#pragma once
enum eTextViewContext_LineFlag {
TVC_LINE_FG = (1 << 0),
TVC_LINE_BG = (1 << 1),
TVC_LINE_ICON = (1 << 2),
TVC_LINE_ICON_FG = (1 << 3),
TVC_LINE_ICON_BG = (1 << 4)
};
typedef struct TextViewContext {
/** Font size scaled by the interface size. */
int lheight;
/** Text selection, when a selection range is in use. */
int sel_start, sel_end;
int row_vpadding;
/** Area to draw text: (0, 0, winx, winy) with a margin applied and scroll-bar subtracted. */
rcti draw_rect;
/** Area to draw text background colors (extending beyond text in some cases). */
rcti draw_rect_outer;
/** Scroll offset in pixels. */
int scroll_ymin, scroll_ymax;
/* callbacks */
int (*begin)(struct TextViewContext *tvc);
void (*end)(struct TextViewContext *tvc);
const void *arg1;
const void *arg2;
/* iterator */
int (*step)(struct TextViewContext *tvc);
void (*line_get)(struct TextViewContext *tvc, const char **r_line, int *r_len);
enum eTextViewContext_LineFlag (*line_data)(struct TextViewContext *tvc,
uchar fg[4],
uchar bg[4],
int *r_icon,
uchar r_icon_fg[4],
uchar r_icon_bg[4]);
void (*draw_cursor)(struct TextViewContext *tvc, int cwidth, int columns);
/* constant theme colors */
void (*const_colors)(struct TextViewContext *tvc, unsigned char bg_sel[4]);
const void *iter;
int iter_index;
/** Used for internal multi-line iteration. */
int iter_char_begin;
/** The last character (not inclusive). */
int iter_char_end;
/** Internal iterator use. */
int iter_tmp;
} TextViewContext;
/**
* \param r_mval_pick_item: The resulting item clicked on using \a mval_init.
* Set from the void pointer which holds the current iterator.
* Its type depends on the data being iterated over.
* \param r_mval_pick_offset: The offset in bytes of the \a mval_init.
* Use for selection.
*/
int textview_draw(struct TextViewContext *tvc,
bool do_draw,
const int mval_init[2],
void **r_mval_pick_item,
int *r_mval_pick_offset);