File: import_interface_underline.hpp

package info (click to toggle)
liborcus 0.20.2-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 16,872 kB
  • sloc: xml: 78,842; cpp: 75,171; sh: 4,626; makefile: 2,838; python: 2,614
file content (72 lines) | stat: -rw-r--r-- 1,945 bytes parent folder | download | duplicates (3)
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
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */

#pragma once

#include "../env.hpp"
#include "types.hpp"

namespace orcus { namespace spreadsheet { namespace iface {

/**
 * Interface for importing underline attributes of a text.
 */
class ORCUS_DLLPUBLIC import_underline
{
public:
    ~import_underline();

    /**
     * Set the style of an underline.
     *
     * @param e underline style of a font.
     */
    virtual void set_style(underline_style_t e) = 0;

    /**
     * Set the thickness of an underline.
     *
     * @param e Thickness of the underline.
     */
    virtual void set_thickness(underline_thickness_t e) = 0;

    /**
     * Set the spacing of an underline with respect to the text it is applied
     * to.
     *
     * @param e Spacing of an underline.
     */
    virtual void set_spacing(underline_spacing_t e) = 0;

    /**
     * Set the number of vertically-stacked lines in an underline.
     *
     * @param e Number of vertically-stacked lines in an underline.
     */
    virtual void set_count(underline_count_t e) = 0;

    /**
     * Specify the color of an underline in ARGB format.
     *
     * @param alpha alpha component of the color.
     * @param red red component of the color.
     * @param green green component of the color.
     * @param blue blue component of the color.
     *
     * @note If this value is not explicitly set, the font color should be used.
     */
    virtual void set_color(color_elem_t alpha, color_elem_t red, color_elem_t green, color_elem_t blue) = 0;

    /**
     * Commit the underline attributes in the current buffer.
     */
    virtual void commit() = 0;
};

}}}

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */