Boost C++ Libraries Home Libraries People FAQ More

PrevUpHome

Class sheet

boost::sheet — This is the main class interface to be exposed to the library user.

Synopsis

// In header: <boost/document/sheet.hpp>


class sheet {
public:
  // construct/copy/destruct
  explicit sheet(const std::shared_ptr< sheet_interface >);
  ~sheet();

  // private member functions
  boost::cell cell_from_string(const char *, std::size_t);

  // public member functions
  std::string sheet_name() const;
  std::size_t sheet_index() const;
  void rename_sheet(const std::string &);
  std::size_t max_row() const;
  std::size_t max_column() const;
  boost::cell get_cell(std::size_t, std::size_t);
  boost::row get_row(std::size_t);
  boost::column get_column(std::size_t);
  boost::column operator[](std::size_t);
  boost::column operator[](int);
  boost::cell operator[](const std::string &);
  boost::cell operator[](const char *);
};

Description

sheet public construct/copy/destruct

  1. explicit sheet(const std::shared_ptr< sheet_interface > impl);
    The Constructor. Creates a new document object.
  2. ~sheet();
    Destructor Closes Unsaved Documents.

sheet private member functions

  1. boost::cell cell_from_string(const char * str, std::size_t length);

sheet public member functions

  1. std::string sheet_name() const;
    Gets the sheet name which is being accessed.
  2. std::size_t sheet_index() const;
    Gets the sheet index which is being accessed.
  3. void rename_sheet(const std::string & str);
    Renames the sheet to str which is being accessed.
  4. std::size_t max_row() const;

    Returns the maximum number of rows

  5. std::size_t max_column() const;

    Returns the maximum number of columns

  6. boost::cell get_cell(std::size_t row, std::size_t column);

    Gets the cell instance which can be manipulated.

  7. boost::row get_row(std::size_t i);

    Gets a row instance which can be iterated over

  8. boost::column get_column(std::size_t i);

    Gets a column instance which can be iterated over

  9. boost::column operator[](std::size_t i);

    Gets the column instance which can be manipulated. No Exception Handling.

  10. boost::column operator[](int i);

    Gets the column instance which can be manipulated. No Exception Handling.

  11. boost::cell operator[](const std::string & str);

    Gets the cell instance which can be manipulated. No Exception Handling.

  12. boost::cell operator[](const char * str);

    Gets the cell instance which can be manipulated. No Exception Handling.


PrevUpHome