.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "Color::Library::Dictionary 3pm"
.TH Color::Library::Dictionary 3pm "2017-03-02" "perl v5.24.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Color::Library::Dictionary \- Color dictionary for Color::Library
.SH "METHODS"
.IX Header "METHODS"
.ie n .IP "@colors = $dictionary\->colors" 4
.el .IP "\f(CW@colors\fR = \f(CW$dictionary\fR\->colors" 4
.IX Item "@colors = $dictionary->colors"
Returns the list of Color::Library::Color objects contained by \f(CW$dictionary\fR
.Sp
Will return a list in list context, and a list reference in scalar context
.ie n .IP "@names = $dictionary\->names" 4
.el .IP "\f(CW@names\fR = \f(CW$dictionary\fR\->names" 4
.IX Item "@names = $dictionary->names"
.PD 0
.ie n .IP "@names = $dictionary\->color_names" 4
.el .IP "\f(CW@names\fR = \f(CW$dictionary\fR\->color_names" 4
.IX Item "@names = $dictionary->color_names"
.PD
Returns the list of color names contained by \f(CW$dictionary\fR
.Sp
Will return a list in list context, and a list reference in scalar context
.ie n .IP "$color = $dictionary\->color( <query> )" 4
.el .IP "\f(CW$color\fR = \f(CW$dictionary\fR\->color( <query> )" 4
.IX Item "$color = $dictionary->color( <query> )"
Returns a Color::Library::Color object of \f(CW$dictionary\fR found via <query>
.Sp
A query can be any of the following:
.RS 4
.IP "color name" 4
.IX Item "color name"
A color name is like \f(CW\*(C`blue\*(C'\fR or \f(CW\*(C`bleached\-almond\*(C'\fR
.IP "color title" 4
.IX Item "color title"
A color title is like \f(CW\*(C`Dark Green\-Teal\*(C'\fR
.IP "color id" 4
.IX Item "color id"
A color id is in the form of <dictionary_id>:<color_name>, for example: \f(CW\*(C`x11:azure1\*(C'\fR
.RE
.RS 4
.RE
.ie n .IP "$id = $dictionary\->id" 4
.el .IP "\f(CW$id\fR = \f(CW$dictionary\fR\->id" 4
.IX Item "$id = $dictionary->id"
.PD 0
.ie n .IP "$name = $dictionary\->name" 4
.el .IP "\f(CW$name\fR = \f(CW$dictionary\fR\->name" 4
.IX Item "$name = $dictionary->name"
.PD
Returns the id (name) of \f(CW$dictionary\fR, e.g.
.Sp
.Vb 4
\&    svg
\&    x11
\&    vaccc
\&    nbs\-iscc\-f
.Ve
.ie n .IP "$title = $dictionary\->title" 4
.el .IP "\f(CW$title\fR = \f(CW$dictionary\fR\->title" 4
.IX Item "$title = $dictionary->title"
Returns the title of \f(CW$dictionary\fR, e.g.
.Sp
.Vb 4
\&    SVG
\&    X11
\&    VACCC
\&    NBS/ISCC F
.Ve
.ie n .IP "$subtitle = $dictionary\->subtitle" 4
.el .IP "\f(CW$subtitle\fR = \f(CW$dictionary\fR\->subtitle" 4
.IX Item "$subtitle = $dictionary->subtitle"
Returns the subtitle of \f(CW$dictionary\fR, if any
.ie n .IP "$description = $dictionary\->description" 4
.el .IP "\f(CW$description\fR = \f(CW$dictionary\fR\->description" 4
.IX Item "$description = $dictionary->description"
Returns the description of \f(CW$dictionary\fR, if any