Merge branch 'master' into sam460ex
This commit is contained in:
François Revol
+106
-27
@@ -1,4 +1,4 @@
|
||||
# Doxyfile 1.7.3
|
||||
# Doxyfile 1.7.5.1
|
||||
|
||||
# This file describes the settings to be used by the documentation system
|
||||
# doxygen (www.doxygen.org) for a project.
|
||||
@@ -22,8 +22,9 @@
|
||||
|
||||
DOXYFILE_ENCODING = UTF-8
|
||||
|
||||
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
|
||||
# by quotes) that should identify the project.
|
||||
# The PROJECT_NAME tag is a single word (or sequence of words) that should
|
||||
# identify the project. Note that if you do not use Doxywizard you need
|
||||
# to put quotes around the project name if it contains spaces.
|
||||
|
||||
PROJECT_NAME = "The Haiku Book"
|
||||
|
||||
@@ -33,7 +34,9 @@ PROJECT_NAME = "The Haiku Book"
|
||||
|
||||
PROJECT_NUMBER = pre-R1
|
||||
|
||||
# Using the PROJECT_BRIEF tag one can provide an optional one line description for a project that appears at the top of each page and should give viewer a quick idea about the purpose of the project. Keep the description short.
|
||||
# Using the PROJECT_BRIEF tag one can provide an optional one line description
|
||||
# for a project that appears at the top of each page and should give viewer
|
||||
# a quick idea about the purpose of the project. Keep the description short.
|
||||
|
||||
PROJECT_BRIEF =
|
||||
|
||||
@@ -274,6 +277,22 @@ DISTRIBUTE_GROUP_DOC = NO
|
||||
|
||||
SUBGROUPING = YES
|
||||
|
||||
# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
|
||||
# unions are shown inside the group in which they are included (e.g. using
|
||||
# @ingroup) instead of on a separate page (for HTML and Man pages) or
|
||||
# section (for LaTeX and RTF).
|
||||
|
||||
INLINE_GROUPED_CLASSES = NO
|
||||
|
||||
# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
|
||||
# unions with only public data fields will be shown inline in the documentation
|
||||
# of the scope in which they are defined (i.e. file, namespace, or group
|
||||
# documentation), provided this scope is documented. If set to NO (the default),
|
||||
# structs, classes, and unions are shown on a separate page (for HTML and Man
|
||||
# pages) or section (for LaTeX and RTF).
|
||||
|
||||
INLINE_SIMPLE_STRUCTS = NO
|
||||
|
||||
# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
|
||||
# is documented as struct, union, or enum with the name of the typedef. So
|
||||
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
|
||||
@@ -449,8 +468,11 @@ SORT_GROUP_NAMES = NO
|
||||
|
||||
SORT_BY_SCOPE_NAME = NO
|
||||
|
||||
# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper type resolution of all parameters of a function it will reject a
|
||||
# match between the prototype and the implementation of a member function even if there is only one candidate or it is obvious which candidate to choose by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
|
||||
# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
|
||||
# do proper type resolution of all parameters of a function it will reject a
|
||||
# match between the prototype and the implementation of a member function even
|
||||
# if there is only one candidate or it is obvious which candidate to choose
|
||||
# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
|
||||
# will still accept a match between prototype and implementation in such cases.
|
||||
|
||||
STRICT_PROTO_MATCHING = NO
|
||||
@@ -538,6 +560,15 @@ FILE_VERSION_FILTER =
|
||||
|
||||
LAYOUT_FILE =
|
||||
|
||||
# The CITE_BIB_FILES tag can be used to specify one or more bib files
|
||||
# containing the references data. This must be a list of .bib files. The
|
||||
# .bib extension is automatically appended if omitted. Using this command
|
||||
# requires the bibtex tool to be installed. See also
|
||||
# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
|
||||
# of the bibliography can be controlled using LATEX_BIB_STYLE.
|
||||
|
||||
CITE_BIB_FILES =
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# configuration options related to warning and progress messages
|
||||
#---------------------------------------------------------------------------
|
||||
@@ -654,6 +685,7 @@ RECURSIVE = NO
|
||||
# The EXCLUDE tag can be used to specify files and/or directories that should
|
||||
# excluded from the INPUT source files. This way you can easily exclude a
|
||||
# subdirectory from a directory tree whose root is specified with the INPUT tag.
|
||||
# Note that relative paths are relative to directory from which doxygen is run.
|
||||
|
||||
EXCLUDE =
|
||||
|
||||
@@ -706,7 +738,8 @@ EXAMPLE_RECURSIVE = NO
|
||||
IMAGE_PATH = . \
|
||||
interface \
|
||||
keyboard \
|
||||
midi2
|
||||
midi2 \
|
||||
storage
|
||||
|
||||
# The INPUT_FILTER tag can be used to specify a program that doxygen should
|
||||
# invoke to filter for each input file. Doxygen will invoke the filter program
|
||||
@@ -846,7 +879,14 @@ HTML_FILE_EXTENSION = .html
|
||||
|
||||
# The HTML_HEADER tag can be used to specify a personal HTML header for
|
||||
# each generated HTML page. If it is left blank doxygen will generate a
|
||||
# standard header.
|
||||
# standard header. Note that when using a custom header you are responsible
|
||||
# for the proper inclusion of any scripts and style sheets that doxygen
|
||||
# needs, which is dependent on the configuration options used.
|
||||
# It is adviced to generate a default header using "doxygen -w html
|
||||
# header.html footer.html stylesheet.css YourConfigFile" and then modify
|
||||
# that header. Note that the header is subject to change so you typically
|
||||
# have to redo this when upgrading to a newer version of doxygen or when
|
||||
# changing the value of configuration settings such as GENERATE_TREEVIEW!
|
||||
|
||||
HTML_HEADER = header.html
|
||||
|
||||
@@ -865,6 +905,15 @@ HTML_FOOTER = footer.html
|
||||
|
||||
HTML_STYLESHEET = book.css
|
||||
|
||||
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
|
||||
# other source files which should be copied to the HTML output directory. Note
|
||||
# that these files will be copied to the base HTML output directory. Use the
|
||||
# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
|
||||
# files. In the HTML_STYLESHEET file, use the file name only. Also note that
|
||||
# the files will be copied as-is; there are no commands or markers available.
|
||||
|
||||
HTML_EXTRA_FILES =
|
||||
|
||||
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
|
||||
# Doxygen will adjust the colors in the stylesheet and background images
|
||||
# according to this color. Hue is specified as an angle on a colorwheel,
|
||||
@@ -1067,9 +1116,10 @@ ECLIPSE_DOC_ID = org.doxygen.Project
|
||||
|
||||
DISABLE_INDEX = NO
|
||||
|
||||
# This tag can be used to set the number of enum values (range [0,1..20])
|
||||
# that doxygen will group on one line in the generated HTML documentation.
|
||||
# Note that a value of 0 will completely suppress the enum values from appearing in the overview section.
|
||||
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
|
||||
# (range [0,1..20]) that doxygen will group on one line in the generated HTML
|
||||
# documentation. Note that a value of 0 will completely suppress the enum
|
||||
# values from appearing in the overview section.
|
||||
|
||||
ENUM_VALUES_PER_LINE = 1
|
||||
|
||||
@@ -1128,12 +1178,18 @@ USE_MATHJAX = NO
|
||||
# HTML output directory using the MATHJAX_RELPATH option. The destination
|
||||
# directory should contain the MathJax.js script. For instance, if the mathjax
|
||||
# directory is located at the same level as the HTML output directory, then
|
||||
# MATHJAX_RELPATH should be ../mathjax. The default value points to the mathjax.org site, so you can quickly see the result without installing
|
||||
# MATHJAX_RELPATH should be ../mathjax. The default value points to the
|
||||
# mathjax.org site, so you can quickly see the result without installing
|
||||
# MathJax, but it is strongly recommended to install a local copy of MathJax
|
||||
# before deployment.
|
||||
|
||||
MATHJAX_RELPATH = http://www.mathjax.org/mathjax
|
||||
|
||||
# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
|
||||
# names that should be enabled during MathJax rendering.
|
||||
|
||||
MATHJAX_EXTENSIONS =
|
||||
|
||||
# When the SEARCHENGINE tag is enabled doxygen will generate a search box
|
||||
# for the HTML output. The underlying search engine uses javascript
|
||||
# and DHTML and should work on any modern browser. Note that when using
|
||||
@@ -1207,6 +1263,13 @@ EXTRA_PACKAGES =
|
||||
|
||||
LATEX_HEADER =
|
||||
|
||||
# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
|
||||
# the generated latex document. The footer should contain everything after
|
||||
# the last chapter. If it is left blank doxygen will generate a
|
||||
# standard footer. Notice: only use this tag if you know what you are doing!
|
||||
|
||||
LATEX_FOOTER =
|
||||
|
||||
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
|
||||
# is prepared for conversion to pdf (using ps2pdf). The pdf file will
|
||||
# contain links (just like the HTML output) instead of page references
|
||||
@@ -1240,6 +1303,12 @@ LATEX_HIDE_INDICES = NO
|
||||
|
||||
LATEX_SOURCE_CODE = NO
|
||||
|
||||
# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
|
||||
# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
|
||||
# http://en.wikipedia.org/wiki/BibTeX for more info.
|
||||
|
||||
LATEX_BIB_STYLE = plain
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# configuration options related to the RTF output
|
||||
#---------------------------------------------------------------------------
|
||||
@@ -1416,7 +1485,7 @@ MACRO_EXPANSION = NO
|
||||
EXPAND_ONLY_PREDEF = NO
|
||||
|
||||
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
|
||||
# in the INCLUDE_PATH (see below) will be search if a #include is found.
|
||||
# pointed to by INCLUDE_PATH will be searched when a #include is found.
|
||||
|
||||
SEARCH_INCLUDES = YES
|
||||
|
||||
@@ -1447,7 +1516,8 @@ PREDEFINED = __cplusplus \
|
||||
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
|
||||
# this tag can be used to specify a list of macro names that should be expanded.
|
||||
# The macro definition that is found in the sources will be used.
|
||||
# Use the PREDEFINED tag if you want to use a different macro definition that overrules the definition found in the source code.
|
||||
# Use the PREDEFINED tag if you want to use a different macro definition that
|
||||
# overrules the definition found in the source code.
|
||||
|
||||
EXPAND_AS_DEFINED =
|
||||
|
||||
@@ -1545,13 +1615,12 @@ HAVE_DOT = NO
|
||||
|
||||
DOT_NUM_THREADS = 0
|
||||
|
||||
# By default doxygen will write a font called Helvetica to the output
|
||||
# directory and reference it in all dot files that doxygen generates.
|
||||
# When you want a differently looking font you can specify the font name
|
||||
# using DOT_FONTNAME. You need to make sure dot is able to find the font,
|
||||
# which can be done by putting it in a standard location or by setting the
|
||||
# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
|
||||
# containing the font.
|
||||
# By default doxygen will use the Helvetica font for all dot files that
|
||||
# doxygen generates. When you want a differently looking font you can specify
|
||||
# the font name using DOT_FONTNAME. You need to make sure dot is able to find
|
||||
# the font, which can be done by putting it in a standard location or by setting
|
||||
# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
|
||||
# directory containing the font.
|
||||
|
||||
DOT_FONTNAME = Helvetica
|
||||
|
||||
@@ -1560,10 +1629,9 @@ DOT_FONTNAME = Helvetica
|
||||
|
||||
DOT_FONTSIZE = 10
|
||||
|
||||
# By default doxygen will tell dot to use the output directory to look for the
|
||||
# FreeSans.ttf font (which doxygen will put there itself). If you specify a
|
||||
# different font using DOT_FONTNAME you can set the path where dot
|
||||
# can find it using this tag.
|
||||
# By default doxygen will tell dot to use the Helvetica font.
|
||||
# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
|
||||
# set the path where dot can find it.
|
||||
|
||||
DOT_FONTPATH =
|
||||
|
||||
@@ -1640,11 +1708,22 @@ GRAPHICAL_HIERARCHY = YES
|
||||
DIRECTORY_GRAPH = YES
|
||||
|
||||
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
|
||||
# generated by dot. Possible values are png, svg, gif or svg.
|
||||
# If left blank png will be used.
|
||||
# generated by dot. Possible values are svg, png, jpg, or gif.
|
||||
# If left blank png will be used. If you choose svg you need to set
|
||||
# HTML_FILE_EXTENSION to xhtml in order to make the SVG files
|
||||
# visible in IE 9+ (other browsers do not have this requirement).
|
||||
|
||||
DOT_IMAGE_FORMAT = png
|
||||
|
||||
# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
|
||||
# enable generation of interactive SVG images that allow zooming and panning.
|
||||
# Note that this requires a modern browser other than Internet Explorer.
|
||||
# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
|
||||
# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
|
||||
# visible. Older versions of IE do not have SVG support.
|
||||
|
||||
INTERACTIVE_SVG = NO
|
||||
|
||||
# The tag DOT_PATH can be used to specify the path where the dot tool can be
|
||||
# found. If left blank, it is assumed the dot tool can be found in the path.
|
||||
|
||||
|
||||
@@ -12,7 +12,7 @@
|
||||
|
||||
/*!
|
||||
\file GridLayout.h
|
||||
Provides the BGridLayout class.
|
||||
\brief Provides the BGridLayout class.
|
||||
*/
|
||||
|
||||
|
||||
|
||||
@@ -10,8 +10,9 @@
|
||||
*/
|
||||
|
||||
|
||||
/*! \file GroupLayout.h
|
||||
Describes the BGroupLayout class
|
||||
/*!
|
||||
\file GroupLayout.h
|
||||
\brief Describes the BGroupLayout class.
|
||||
*/
|
||||
|
||||
|
||||
|
||||
@@ -12,7 +12,7 @@
|
||||
|
||||
/*!
|
||||
\file LayoutItem.h
|
||||
Describes the BLayoutItem class
|
||||
\brief Describes the BLayoutItem class
|
||||
*/
|
||||
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
/*!
|
||||
\file Midi2Defs.h
|
||||
\brief Some definitions to define raw MIDI events.
|
||||
\ingroup midi2
|
||||
*/
|
||||
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 23 KiB |
@@ -14,7 +14,7 @@
|
||||
|
||||
/*!
|
||||
\file Entry.h
|
||||
Provides the BEntry class and entry_ref implementations.
|
||||
\brief Provides the BEntry class and entry_ref implementations.
|
||||
*/
|
||||
|
||||
|
||||
|
||||
@@ -15,7 +15,7 @@
|
||||
|
||||
/*!
|
||||
\file File.h
|
||||
Provides the BFile class.
|
||||
\brief Provides the BFile class.
|
||||
*/
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,356 @@
|
||||
/*
|
||||
* Copyright 2009-2012 Haiku, Inc. All rights reserved.
|
||||
* Distributed under the terms of the MIT License.
|
||||
*
|
||||
* Authors:
|
||||
* John Scipione, [email protected]
|
||||
*
|
||||
* Corresponds to:
|
||||
* headers/os/storage/FilePanel.h hrev45162
|
||||
* src/kits/tracker/FilePanel.cpp hrev45162
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\file FilePanel.h
|
||||
\brief Provides the BFilePanel and BRefFilter classes and support enums.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\enum file_panel_mode
|
||||
Whether the file panel is a save or open panel.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\var file_panel_mode B_OPEN_PANEL
|
||||
Open panel
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\var file_panel_mode B_SAVE_PANEL
|
||||
Save panel
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\enum file_panel_button
|
||||
List of buttons used by the file panel
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\var file_panel_button B_CANCEL_BUTTON
|
||||
Cancel button
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\var file_panel_button B_DEFAULT_BUTTON
|
||||
Default button
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\class BRefFilter
|
||||
\ingroup storage
|
||||
\ingroup libbe
|
||||
\brief Allows you to filter the items displayed in a file panel.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn virtual bool Filter(const entry_ref* ref, BNode* node,
|
||||
struct stat_beos* stat, const char* mimeType)
|
||||
\brief Hook method that's called on each file in the target directory
|
||||
displayed by a file panel.
|
||||
|
||||
\param ref The file currently under consideration.
|
||||
\param node The node currently under consideration.
|
||||
\param stat The stat information of the file.
|
||||
\param mimeType The MIME type of the file.
|
||||
|
||||
\returns Whether or not the entry is a valid candidate for an open/save
|
||||
dialog.
|
||||
|
||||
\see BFilePanel::SetRefFilter()
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\class BFilePanel
|
||||
\ingroup storage
|
||||
\ingroup libbe
|
||||
\brief Displays a standard Open/Save dialog.
|
||||
|
||||
A save panel looks like this:
|
||||
|
||||
\image html BFilePanel_example.png
|
||||
|
||||
An open dialog looks similar but doesn't have a text box for the file name.
|
||||
|
||||
Creating a basic open or save panel is easy:
|
||||
|
||||
\code
|
||||
BFilePanel* openPanel = new BFilePanel(B_OPEN_PANEL);
|
||||
BFilePanel* savePanel = new BFilePanel(B_SAVE_PANEL);
|
||||
\endcode
|
||||
|
||||
There are many options but they can generally be set after the object has
|
||||
been constructed.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn BFilePanel::BFilePanel(file_panel_mode mode, BMessenger* target,
|
||||
const entry_ref* ref, uint32 nodeFlavors, bool multipleSelection,
|
||||
BMessage* message, BRefFilter* filter, bool modal, bool hideWhenDone)
|
||||
\brief Creates and initializes a BFilePanel object.
|
||||
|
||||
The panel is not displayed until call the Show() method.
|
||||
|
||||
\param mode Either \c B_OPEN_PANEL or \c B_SAVE_PANEL.
|
||||
\param target The BMessenger object that sends messages to the BLooper
|
||||
or BHandler controlled by the file panel.
|
||||
\param ref The directory to display, by default the current working
|
||||
directory.
|
||||
\param nodeFlavors Option flags, this applies to open panels only.
|
||||
\param multipleSelection Determines whether or not the user is allowed
|
||||
to select more than one item.
|
||||
\param message Override the default message sent by the file panel.
|
||||
\param filter Filter Hook function to call.
|
||||
\param modal Whether or not the panel is modal, defaults to \c false.
|
||||
\param hideWhenDone Set to \c false to keep the panel even after the user
|
||||
confirms or cancels. The close button will hide the panel regardless.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn BFilePanel::~BFilePanel()
|
||||
\brief Destroys the file panel object.
|
||||
|
||||
If file panel is currently being displayed it is closed. The BRefFilter
|
||||
object references by this panel is not destroyed by this method.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn void BFilePanel::Show()
|
||||
\brief Displays the file panel on screen.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn void BFilePanel::Hide()
|
||||
\brief Hides the file panel.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn bool BFilePanel::IsShowing() const
|
||||
\brief Determines whether or not the file panel is shown.
|
||||
|
||||
\returns \c true if visible, \c false if hidden.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn void BFilePanel::SendMessage(const BMessenger* messenger,
|
||||
BMessage* message)
|
||||
\brief Sends the \a message to the target BHandler \a messenger.
|
||||
|
||||
\param messenger The target BHandler to send the message to.
|
||||
\param message The message to send.
|
||||
|
||||
\see BMessenger::SendMessage()
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn file_panel_mode BFilePanel::PanelMode() const
|
||||
\brief Gets the panel mode, either \c B_OPEN_PANEL or \c B_SAVE_PANEL.
|
||||
|
||||
\returns \c B_OPEN_PANEL if the panel is an open panel or \c B_SAVE_PANEL
|
||||
if the panel is a save panel.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn BMessenger BFilePanel::Messenger() const
|
||||
\brief Gets the panel's target messenger object.
|
||||
|
||||
\returns The BMessenger object that sends messages for this panel.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn void BFilePanel::SetTarget(BMessenger target)
|
||||
\brief Sets the target messenger.
|
||||
|
||||
\param target the target BMessenger object to set.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn void BFilePanel::SetMessage(BMessage* message)
|
||||
\brief Sets the target messenge.
|
||||
|
||||
\param message The BMessage object to send on confirm.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn void BFilePanel::Refresh()
|
||||
\brief Refresh the directory or the panel causing the entries to be re-run
|
||||
through the BRefFilter::Filter() method.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn BRefFilter* BFilePanel::RefFilter() const
|
||||
\brief Gets the BRefFilter object associated with the panel.
|
||||
|
||||
\returns The BRefFilter set to the panel.
|
||||
|
||||
\see BRefFilter::Filter()
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn void BFilePanel::SetRefFilter(BRefFilter* filter)
|
||||
\brief Sets the BRefFilter used by the panel to filter entries.
|
||||
|
||||
\param filter The BRefFilter object to set.
|
||||
|
||||
\see BRefFilter::Filter()
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn void BFilePanel::SetButtonLabel(file_panel_button button,
|
||||
const char* text)
|
||||
\brief Set the button label specified by \a button to \a text.
|
||||
|
||||
\param button The button to set the label of.
|
||||
\param text The text to set the button label to.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn void BFilePanel::GetPanelDirectory(entry_ref* ref) const
|
||||
\brief Gets the entry ref of the panel and sets \a ref to point to it.
|
||||
|
||||
\param ref The \c entry_ref pointer you want set.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn void BFilePanel::SetSaveText(const char* text)
|
||||
\brief Set some save text to display in the save dialog.
|
||||
|
||||
\param text The text to display.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn void BFilePanel::SetPanelDirectory(const entry_ref* ref)
|
||||
\brief Sets the entry ref of the panel to the directory contained
|
||||
by \a ref.
|
||||
|
||||
\param ref The entry contained by the desired panel directory.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn void BFilePanel::SetPanelDirectory(const char* path)
|
||||
\brief Sets the entry ref of the panel to the directory referenced
|
||||
by \a path.
|
||||
|
||||
\param path The path of the desired directory.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn void BFilePanel::SetPanelDirectory(const BEntry* entry)
|
||||
\brief Sets the entry ref of the panel to the directory referenced
|
||||
by \a entry.
|
||||
|
||||
\param entry The BEntry object pointing to the desired directory.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn void BFilePanel::SetPanelDirectory(const BDirectory* dir)
|
||||
\brief Sets the entry ref of the panel to the directory referenced
|
||||
by \a dir.
|
||||
|
||||
\param dir The BDirectory object pointing to the desired directory.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn BWindow* BFilePanel::Window() const
|
||||
\brief Gets a pointer to the BWindow object used by the file panel.
|
||||
|
||||
\returns A pointer to the BWindow object used by the file panel.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn void BFilePanel::Rewind()
|
||||
\brief Sets the entry ref back to the top of the list.
|
||||
|
||||
\see SelectionChanged()
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn status_t BFilePanel::GetNextSelectedRef(entry_ref* ref)
|
||||
\brief Sets the \a ref pointer to the next entry in the directory.
|
||||
|
||||
\returns a status message.
|
||||
\retval B_OK Everything went fine.
|
||||
\retval B_ERROR Couldn't attain a lock on the window.
|
||||
\retval B_ENTRY_NOT_FOUND End of the entry list.
|
||||
|
||||
\see SelectionChanged()
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn void BFilePanel::SetHideWhenDone(bool on)
|
||||
\brief Sets whether or not the panel should hide on confirm or cancel.
|
||||
|
||||
\param on \c true to hide, \c false to not hide when done.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn bool BFilePanel::HidesWhenDone(void) const
|
||||
\brief Gets whether or not the panel should hide on confirm or cancel.
|
||||
|
||||
Panel always hides if the user clicks the window's close button.
|
||||
|
||||
\returns \c true if panel will hide, \c false if panel will not hide.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn void BFilePanel::WasHidden()
|
||||
\brief Hook method that gets called when the file panel is hidden due to
|
||||
a user action.
|
||||
|
||||
WasHidden() is not called if you call Hide() manually.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn void BFilePanel::SelectionChanged()
|
||||
\brief Hook method that gets called when the entry ref references by the
|
||||
file panel changes.
|
||||
|
||||
\see GetNextSelectedRef()
|
||||
\see Rewind()
|
||||
*/
|
||||
Reference in New Issue
Block a user