File: structoscap__text.tex

package info (click to toggle)
openscap 0.5.12-3
  • links: PTS
  • area: main
  • in suites: squeeze
  • size: 27,052 kB
  • ctags: 21,075
  • sloc: xml: 82,351; ansic: 52,101; sh: 17,802; makefile: 748; perl: 442; cpp: 117; python: 110
file content (92 lines) | stat: -rw-r--r-- 5,696 bytes parent folder | download
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
\hypertarget{structoscap__text}{
\section{oscap\_\-text Struct Reference}
\label{structoscap__text}\index{oscap\_\-text@{oscap\_\-text}}
}


Representation of internationalizable character strings.  


{\ttfamily \#include $<$text.h$>$}\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
struct \hyperlink{structoscap__text}{oscap\_\-text} $\ast$ \hyperlink{group__STRINGS_gac6a9bf5401a4886e98f2904dcae24bad}{oscap\_\-text\_\-new} (void)
\begin{DoxyCompactList}\small\item\em Create an internationalized text field. \item\end{DoxyCompactList}\item 
struct \hyperlink{structoscap__text}{oscap\_\-text} $\ast$ \hyperlink{group__STRINGS_ga2225487bec55cb7bdec0fa84ac630168}{oscap\_\-text\_\-clone} (const struct \hyperlink{structoscap__text}{oscap\_\-text} $\ast$text)
\begin{DoxyCompactList}\small\item\em Clone an internationalized text field. \item\end{DoxyCompactList}\item 
struct \hyperlink{structoscap__text}{oscap\_\-text} $\ast$ \hyperlink{group__STRINGS_ga58c7ce80ba2c0831e18f1bbdeaafa118}{oscap\_\-text\_\-new\_\-html} (void)
\begin{DoxyCompactList}\small\item\em Create an internationalized text field with HTML content. \item\end{DoxyCompactList}\item 
\hypertarget{group__STRINGS_gaf5af70b1be049d2fe79e21e5d5310bb1}{
void \hyperlink{group__STRINGS_gaf5af70b1be049d2fe79e21e5d5310bb1}{oscap\_\-text\_\-free} (struct \hyperlink{structoscap__text}{oscap\_\-text} $\ast$)}
\label{group__STRINGS_gaf5af70b1be049d2fe79e21e5d5310bb1}

\begin{DoxyCompactList}\small\item\em Release an internationalized text field. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\begin{Indent}{\bf Getters}\par
{\em \label{_amgrpc9fd0bcb5385a65354c37f1bb504399d}
Return value is pointer to structure's member.

Do not free unless you null the pointer in the structure. Use remove function otherwise. }\begin{DoxyCompactItemize}
\item 
const char $\ast$ \hyperlink{group__STRINGS_gaca2bb3cb75e8858295dd08c800ec810e}{oscap\_\-text\_\-get\_\-text} (const struct \hyperlink{structoscap__text}{oscap\_\-text} $\ast$text)
\item 
const char $\ast$ \hyperlink{group__STRINGS_ga33302545c993d04c5640070f5ebcdf38}{oscap\_\-text\_\-get\_\-lang} (const struct \hyperlink{structoscap__text}{oscap\_\-text} $\ast$text)
\item 
\hypertarget{group__STRINGS_gac0759b0a3b3608446818b1ae3ded6410}{
bool \hyperlink{group__STRINGS_gac0759b0a3b3608446818b1ae3ded6410}{oscap\_\-text\_\-get\_\-is\_\-html} (const struct \hyperlink{structoscap__text}{oscap\_\-text} $\ast$text)}
\label{group__STRINGS_gac0759b0a3b3608446818b1ae3ded6410}

\begin{DoxyCompactList}\small\item\em Does this text posses a HTML content? \item\end{DoxyCompactList}\item 
\hypertarget{group__STRINGS_ga3f239371f339469e8cc1ffc2bd93d573}{
bool \hyperlink{group__STRINGS_ga3f239371f339469e8cc1ffc2bd93d573}{oscap\_\-text\_\-get\_\-can\_\-substitute} (const struct \hyperlink{structoscap__text}{oscap\_\-text} $\ast$text)}
\label{group__STRINGS_ga3f239371f339469e8cc1ffc2bd93d573}

\begin{DoxyCompactList}\small\item\em Can this text contain substitutions? \item\end{DoxyCompactList}\item 
\hypertarget{group__STRINGS_ga4b6bbeb0263f08c3428e23efd47822f1}{
bool \hyperlink{group__STRINGS_ga4b6bbeb0263f08c3428e23efd47822f1}{oscap\_\-text\_\-get\_\-can\_\-override} (const struct \hyperlink{structoscap__text}{oscap\_\-text} $\ast$text)}
\label{group__STRINGS_ga4b6bbeb0263f08c3428e23efd47822f1}

\begin{DoxyCompactList}\small\item\em Can this text override parent content? \item\end{DoxyCompactList}\item 
\hypertarget{group__STRINGS_ga17bc03b25bddb5ed732031744c54ba7a}{
bool \hyperlink{group__STRINGS_ga17bc03b25bddb5ed732031744c54ba7a}{oscap\_\-text\_\-get\_\-overrides} (const struct \hyperlink{structoscap__text}{oscap\_\-text} $\ast$text)}
\label{group__STRINGS_ga17bc03b25bddb5ed732031744c54ba7a}

\begin{DoxyCompactList}\small\item\em Does this text override parent content? \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}
\begin{Indent}{\bf Setters}\par
{\em \label{_amgrp6e47466b75bb957a603aa54c079ac8bf}
For lists use add functions.

Parameters of set functions are duplicated in memory and need to be freed by caller. }\begin{DoxyCompactItemize}
\item 
bool \hyperlink{group__STRINGS_ga22a6653f1f8237f3a7f6ad8cdb89a65e}{oscap\_\-text\_\-set\_\-text} (struct \hyperlink{structoscap__text}{oscap\_\-text} $\ast$text, const char $\ast$string)
\begin{DoxyCompactList}\small\item\em Set whether this text overrides parent content. \item\end{DoxyCompactList}\item 
bool \hyperlink{group__STRINGS_ga2b1c5275f76416de713f0234993c3475}{oscap\_\-text\_\-set\_\-lang} (struct \hyperlink{structoscap__text}{oscap\_\-text} $\ast$text, const char $\ast$string)
\end{DoxyCompactItemize}
\end{Indent}
\subsection*{Data Fields}
\begin{DoxyCompactItemize}
\item 
\hypertarget{structoscap__text_ac88de7b67317cfdaa14396ceb19ac93d}{
char $\ast$ {\bfseries lang}}
\label{structoscap__text_ac88de7b67317cfdaa14396ceb19ac93d}

\item 
\hypertarget{structoscap__text_a179ab1f0213b44e48c624102b6ebb0d4}{
char $\ast$ {\bfseries text}}
\label{structoscap__text_a179ab1f0213b44e48c624102b6ebb0d4}

\item 
\hypertarget{structoscap__text_aeeefbb311de50144c40aa192bf5bed9e}{
struct \hyperlink{structoscap__text__traits}{oscap\_\-text\_\-traits} {\bfseries traits}}
\label{structoscap__text_aeeefbb311de50144c40aa192bf5bed9e}

\end{DoxyCompactItemize}


\subsection{Detailed Description}
Representation of internationalizable character strings. 

The documentation for this struct was generated from the following files:\begin{DoxyCompactItemize}
\item 
/home/pvrabec/project/openscap/openscap-\/0.5.12/src/common/text\_\-priv.h\item 
/home/pvrabec/project/openscap/openscap-\/0.5.12/src/common/public/\hyperlink{text_8h}{text.h}\end{DoxyCompactItemize}